Invoice: Standard cXML payload – TradeCentric

The InvoiceDetailRequest payload sends an invoice request from your eCommerce platform to the TradeCentric platform so that we can deliver the invoice to the buyer's eProcurement system. For standard integrations that send cXML payloads, we accept the InvoiceDetailRequest in our standard cXML format.

This article describes the standard cXML format to use for this payload.

Important: This invoice request payload is for invoices associated with purchase orders (POs) only. The payload must include the PO identifier from the PO request payload that we sent.

Jump to:

Request payload (to TradeCentric)

Request element details

cXML root
Header
Request

Response payload (from TradeCentric)

Response element details

cXML root
Response

Request payload (to TradeCentric)

The code block below shows an example InvoiceDetailRequest payload in our standard cXML format:

cXML

HTTP POST

InvoiceDetailRequest

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cXML.org/schemas/cXML/1.2.014/InvoiceDetail.dtd">
<cXML payloadID="12345678" timestamp="2022-11-18T00:00:00Z" version="1.2.014">
  <Header>
    <From>
      <Credential domain="NetworkID">
        <Identity>SupplierSystem</Identity>
      </Credential>
    </From>
    <To>
      <Credential domain="NetworkID">
        <Identity>BuyerSystem</Identity>
      </Credential>
    </To>
    <Sender>
      <Credential domain="NetworkID">
        <Identity>SupplierSystem</Identity>
        <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
      </Credential>
      <UserAgent>eCommerceInvoice</UserAgent>
    </Sender>
  </Header>
  <Request deploymentMode="production">
    <InvoiceDetailRequest>
      <InvoiceDetailRequestHeader invoiceID="INV-789" purpose="standard" operation="new" invoiceDate="2022-11-18">
        <InvoiceDetailHeaderIndicator/>
        <InvoiceDetailLineIndicator isTaxInLine="yes"/>
        <InvoicePartner>
          <Contact role="billTo">
            <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
            <PostalAddress name="Default">
              <DeliverTo>Contact Name</DeliverTo>
              <Street>123 Test St.</Street>
              <City>Nashville</City>
              <State>TN</State>
              <PostalCode>37011</PostalCode>
              <Country isoCountryCode="US">United States</Country>
            </PostalAddress>
            <Email>contact@buyer.com</Email>
            <Phone>
              <TelephoneNumber>
                <CountryCode isoCountryCode="US"/>
                <AreaOrCityCode/>
                <Number>888-555-9876</Number>
              </TelephoneNumber>
            </Phone>
          </Contact>
        </InvoicePartner>
        <InvoicePartner>
          <Contact role="shipTo">
            <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
            <PostalAddress name="Default">
              <DeliverTo>Contact Name</DeliverTo>
              <Street>123 Test St.</Street>
              <City>Nashville</City>
              <State>TN</State>
              <PostalCode>37011</PostalCode>
              <Country isoCountryCode="US">United States</Country>
            </PostalAddress>
            <Email>contact@buyer.com</Email>
          </Contact>
        </InvoicePartner>
        <PaymentTerm payInNumberOfDays="30">
          <Discount>
            <DiscountPercent percent="3"/>
          </Discount>
        </PaymentTerm>
      </InvoiceDetailRequestHeader>
      <InvoiceDetailOrder>
        <InvoiceDetailOrderInfo>
          <OrderReference orderID="PO-123">
            <DocumentReference payloadID="985274930687.1374859706.109.7733@zimbuyer.com"/>
          </OrderReference>
        </InvoiceDetailOrderInfo>
        <InvoiceDetailItem invoiceLineNumber="101" quantity="2">
          <UnitOfMeasure>EA</UnitOfMeasure>
          <UnitPrice>
            <Money currency="USD">41.15</Money>
          </UnitPrice>
          <InvoiceDetailItemReference lineNumber="1">
            <ItemID>
              <SupplierPartID>45L017</SupplierPartID>
            </ItemID>
          </InvoiceDetailItemReference>
          <SubtotalAmount>
            <Money currency="USD">82.30</Money>
          </SubtotalAmount>
          <InvoiceDetailLineShipping>
            <InvoiceDetailShipping>
              <Contact role="billTo">
                <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
                <PostalAddress name="Default">
                  <DeliverTo>Contact Name</DeliverTo>
                  <Street>123 Test St.</Street>
                  <City>Nashville</City>
                  <State>TN</State>
                  <PostalCode>37011</PostalCode>
                  <Country isoCountryCode="US">United States</Country>
                </PostalAddress>
                <Email>contact@buyer.com</Email>
                <Phone>
                  <TelephoneNumber>
                    <CountryCode isoCountryCode="US"/>
                    <AreaOrCityCode/>
                    <Number>888-555-9876</Number>
                  </TelephoneNumber>
                </Phone>
              </Contact>
              <Contact role="shipTo">
                <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
                <PostalAddress name="Default">
                  <DeliverTo>Contact Name</DeliverTo>
                  <Street>123 Test St.</Street>
                  <City>Nashville</City>
                  <State>TN</State>
                  <PostalCode>37011</PostalCode>
                  <Country isoCountryCode="US">United States</Country>
                </PostalAddress>
                <Email>contact@buyer.com</Email>
              </Contact>
            </InvoiceDetailShipping>
            <Money currency="USD">2.25</Money>
          </InvoiceDetailLineShipping>
          <GrossAmount>
            <Money currency="USD">86.80</Money>
          </GrossAmount>
          <InvoiceDetailDiscount percentageRate="5">
            <Money currency="USD">4.12</Money>
          </InvoiceDetailDiscount>
        </InvoiceDetailItem>
      </InvoiceDetailOrder>
      <InvoiceDetailSummary>
        <SubtotalAmount>
          <Money currency="USD">86.80</Money>
        </SubtotalAmount>
        <Tax>
          <Money currency="USD">8.64</Money>
          <Description xml:lang="en"/>
        </Tax>
        <SpecialHandlingAmount>
          <Money currency="USD">9.99</Money>
        </SpecialHandlingAmount>
        <ShippingAmount>
          <Money currency="USD">10.09</Money>
        </ShippingAmount>
        <GrossAmount>
          <Money currency="USD">103.97</Money>
        </GrossAmount>
        <InvoiceDetailDiscount>
          <Money currency="USD">11.55</Money>
        </InvoiceDetailDiscount>
        <NetAmount>
          <Money currency="USD">92.42</Money>
        </NetAmount>
      </InvoiceDetailSummary>
    </InvoiceDetailRequest>
  </Request>
</cXML>

Request element details

A standard cXML InvoiceDetailRequest payload has a root element, a Header element, and a Request element. The subsections below explain each element and its fields.

cXML root

Required Max use: 1

Applies identifying information to the entire payload

Example

<cXML payloadID="12345678" timestamp="2022-11-18T00:00:00Z" version="1.2.014">
  ...
</cXML>

Root field breakdown

payloadID

Payload identifier

Optional Type: String

Provides a unique identifier for the payload

Example: payloadID="12345678"
timestamp

Payload timestamp

Optional Format: ISO 8601

Provides the date and time when the payload was created

Example: timestamp="2022-11-18T00:00:00Z"
version

cXML version

Optional Type: String

Specifies the cXML version used for the payload

Example: version="1.2.014"

Header

Required Max use: 1

Identifies the organizations involved in the transaction

Example

<Header>
  <From>
    <Credential domain="NetworkID">
      <Identity>SupplierSystem</Identity>
    </Credential>
  </From>
  <To>
    <Credential domain="NetworkID">
      <Identity>BuyerSystem</Identity>
    </Credential>
  </To>
  <Sender>
    <Credential domain="NetworkID">
      <Identity>SupplierSystem</Identity>
      <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
    </Credential>
    <UserAgent>eCommerceInvoice</UserAgent>
  </Sender>
</Header>

Header field breakdown

From
Supplier credential

Required

Identifies your organization
- domain Identifier type
  
  Required Type: String
  
  Specifies the type of identifier provided in the credential
  
  Example: domain="NetworkID" = Network identifier value from your eCommerce platform
- Identity Identifier
  
  Required Type: String
  
  Provides the identifier value for the credential
  
  Example: <Identity>SupplierSystem</Identity>
To
Buyer credential

Required

Identifies the buyer organization
- domain Identifier type
  
  Required Type: String
  
  Specifies the type of identifier provided in the credential
  
  Example: domain="NetworkID" = Network identifier value from the eProcurement system
- Identity Identifier
  
  Required Type: String
  
  Provides the identifier value for the credential
  
  Example: <Identity>BuyerSystem</Identity>
Sender
Sending system credential

Required

Identifies your eCommerce platform and provides its authentication information
- domain Identifier type
  
  Optional Type: String
  
  Specifies the type of identifier provided in the credential
  
  Example: domain="NetworkID" = Network identifier value from your eCommerce platform
- Identity Identifier
  
  Optional Type: String
  
  Provides the identifier value for the credential
  
  Example: <Identity>SupplierSystem</Identity>
- SharedSecret Shared secret
  
  Required Type: String
  
  Provides your shared secret, which is the password that your organization and TradeCentric agreed to use for authentication
  
  Example: <SharedSecret>ABCD1234efgh5678.IJKL9012mnopq</SharedSecret>
- UserAgent Additional system identifier
  
  Optional Type: String
  
  Provides an informational identifier, such as a name, for the sending system
  
  Example: <UserAgent>eCommerceInvoice</UserAgent>

Request

Provides the invoice details, which are described in the subsections below

Invoice identification

Required Max use: 1

Provides identifying information about the invoice

Example

<Request deploymentMode="production">
  <InvoiceDetailRequest>
    <InvoiceDetailRequestHeader invoiceID="INV-789" purpose="standard" operation="new" invoiceDate="2022-11-18">
      <InvoiceDetailHeaderIndicator/>
      <InvoiceDetailLineIndicator isTaxInLine="yes"/>

Invoice identification field breakdown

deploymentMode

Deployment mode

Optional Values: test, production

Specifies whether the request is for test or production

Example: deploymentMode="production"
InvoiceDetailRequestHeader
Invoice header

Optional

Provides identifying information about the invoice
- invoiceID Invoice identifier
  
  Optional Type: String
  
  Provides your invoice identifier, such as an invoice number
  
  Example: invoiceID="INV-789"
- purpose Invoice purpose
  
  Optional Type: String
  
  Specifies the purpose of the invoice
  
  Example: purpose="standard"
- operation Requested action
  
  Optional Type: String
  
  Specifies the invoice action
  
  Example: operation="new"
- invoiceDate Invoice date
  
  Optional Format: YYYY-MM-DD
  
  Provides the invoice's issue date
  
  Example: invoiceDate="2022-11-18"
- InvoiceDetailHeaderIndicator Header indicator
  
  Optional
  
  Indicates that the invoice includes a detail header
  
  Example: <InvoiceDetailHeaderIndicator/>
- InvoiceDetailLineIndicator Line indicator
  
  Optional
  
  Indicates that the invoice includes line details
  
  Example: <InvoiceDetailLineIndicator isTaxInLine="yes"/>
  - isTaxInLine Line tax indicator
    
    Optional Values: yes, no
    
    Specifies whether the payload specifies tax at the line level, meaning a tax value for each line item
    
    Example: isTaxInLine="yes"

Contacts and addresses

Required Max use: Many

Provides the invoice contact and address details

Note: Repeat the InvoicePartner element for each invoice address, such as a shipping or billing address.

Example

<InvoicePartner>
  <Contact role="billTo">
    <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
    <PostalAddress name="Default">
      <DeliverTo>Contact Name</DeliverTo>
      <Street>123 Test St.</Street>
      <City>Nashville</City>
      <State>TN</State>
      <PostalCode>37011</PostalCode>
      <Country isoCountryCode="US">United States</Country>
    </PostalAddress>
    <Email>contact@buyer.com</Email>
    <Phone>
      <TelephoneNumber>
        <CountryCode isoCountryCode="US"/>
        <AreaOrCityCode/>
        <Number>888-555-9876</Number>
      </TelephoneNumber>
    </Phone>
  </Contact>
</InvoicePartner>

Contacts and addresses field breakdown

Contact
Invoice contact

Optional

Provides the details about invoice contacts
- role Contact role
  
  Optional Type: String
  
  Specifies the type of contact provided
  
  Example: role="billTo", role="shipTo", role="remitTo", role="shipFrom"
- Name Address name
  
  Optional Type: String
  
  Provides the address name
  
  Example: <Name xml:lang="en">Test Corp. - Nashville Branch</Name>
  - xml:lang Language
    
    Optional Format: IETF BCP 47
    
    Specifies the language used for the name
    
    Example: xml:lang="en"
- PostalAddress Address details
  
  Optional
  
  Provides the address details
  - name Address type
    
    Optional Type: String
    
    Provides an informational identifier for the address
    
    Example: name="Default"
  - DeliverTo Deliver-to contact
    
    Optional Type: String
    
    Provides the contact name for the address
    
    Example: <DeliverTo>Contact Name</DeliverTo>
  - Street Street address
    
    Optional Type: String
    
    Provides the street address
    
    Example: <Street>123 Test St.</Street>
  - City City
    
    Optional Type: String
    
    Provides the city for the address
    
    Example: <City>Nashville</City>
  - State State or province
    
    Optional Type: String
    
    Provides the state or province for the address
    
    Example: <State>TN</State>
  - PostalCode Postal code
    
    Optional Type: String
    
    Provides the postal code for the address
    
    Example: <PostalCode>37011</PostalCode>
  - Country Country
    
    Optional Type: String
    
    Provides the country for the address
    
    Example: <Country isoCountryCode="US">United States</Country>
    
    isoCountryCode Country code
    
    Optional Format: ISO 3166
    
    Specifies the country for the address
    
    Example: isoCountryCode="US"
- Email Contact email address
  
  Optional Type: String
  
  Provides the contact's email address
  
  Example: <Email>contact@buyer.com</Email>
- Phone Contact phone number
  
  Optional
  
  Groups the contact's phone number details
  - TelephoneNumber Telephone number
    
    Optional
    
    Provides the phone number values
    
    CountryCode Country code
    
    Optional Type: String
    
    Provides the country code for the phone number
    
    Example: <CountryCode isoCountryCode="US"/>
    
    AreaOrCityCode Area or city code
    
    Optional Type: String
    
    Provides the area or city code for the phone number
    
    Example: blank in this payload
    
    Number Phone number
    
    Optional Type: String
    
    Provides the phone number
    
    Example: <Number>888-555-9876</Number>

Payment terms

Required Max use: 1

Provides the payment terms, including discount percentage, for the invoice

Example

<PaymentTerm payInNumberOfDays="30">
  <Discount>
    <DiscountPercent percent="3"/>
  </Discount>
</PaymentTerm>

Payment terms field breakdown

PaymentTerm
Payment terms

Optional

Provides the payment terms for the invoice
- payInNumberOfDays Payment term days
  
  Optional Type: Number
  
  Provides the expected payment timeframe as a number of days
  
  Example: payInNumberOfDays="30"
- Discount Payment discount details
  
  Optional
  
  Groups the payment discount details
  
  Example: <Discount>...</Discount>
  - DiscountPercent Discount percentage rate
    
    Optional Type: Number
    
    Provides the value for the percentage rate
    
    Example: <DiscountPercent percent="3"/>

Item details

Provides the PO reference and invoice line item details, which are described in the subsections below

PO reference

Required Max use: 1

Provides the PO details that this invoice applies to

Example

<InvoiceDetailOrder>
  <InvoiceDetailOrderInfo>
    <OrderReference orderID="PO-123">
      <DocumentReference payloadID="985274930687.1374859706.109.7733@zimbuyer.com"/>
    </OrderReference>
  </InvoiceDetailOrderInfo>

Order reference field breakdown

OrderReference
PO reference

Required

Provides identifying information about the PO being invoiced
- orderID Buyer PO identifier
  
  Required Accepted value: Same as PO request
  
  Provides the PO identifier from the PO request payload that we sent
  
  Example: orderID="PO-123"
- DocumentReference PO payload reference
  
  Optional
  
  Provides reference information for the PO payload
  
  Example: <DocumentReference payloadID="985274930687.1374859706.109.7733@zimbuyer.com"/>
  - payloadID Payload identifier
    
    Optional Accepted value: Same as PO request
    
    Provides the unique payload identifier from the PO request payload that we sent
    
    Example: payloadID="985274930687.1374859706.109.7733@zimbuyer.com"

Items

Required Max use: Many

Provides details about each of the line items in the invoice

Note: Repeat the InvoiceDetailItem element for each line item.

Example

<InvoiceDetailItem invoiceLineNumber="101" quantity="2">
  <UnitOfMeasure>EA</UnitOfMeasure>
  <UnitPrice>
    <Money currency="USD">41.15</Money>
  </UnitPrice>
  <InvoiceDetailItemReference lineNumber="1">
    <ItemID>
      <SupplierPartID>45L017</SupplierPartID>
    </ItemID>
  </InvoiceDetailItemReference>
  <SubtotalAmount>
    <Money currency="USD">82.30</Money>
  </SubtotalAmount>
  <InvoiceDetailLineShipping>
    <InvoiceDetailShipping>
      ...
    </InvoiceDetailShipping>
    <Money currency="USD">2.25</Money>
  </InvoiceDetailLineShipping>
  <GrossAmount>
    <Money currency="USD">86.80</Money>
  </GrossAmount>
  <InvoiceDetailDiscount percentageRate="5">
    <Money currency="USD">4.12</Money>
  </InvoiceDetailDiscount>
</InvoiceDetailItem>

Items field breakdown

invoiceLineNumber

Invoice line number

Optional Type: Number

Provides the invoice line number that your organization generated for the item

Example: invoiceLineNumber="101"
quantity

Quantity

Optional Type: Number

Provides the invoiced item quantity

Example: quantity="2"
UnitOfMeasure

Unit of measure

Optional Type: String

Provides the item unit of measure, which we'll map to the buyer's accepted format before sending the final payload

Example: <UnitOfMeasure>EA</UnitOfMeasure>
UnitPrice
Unit price

Optional

Provides the price of one unit of the item after applying any discounts or special pricing
- Money Unit price value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">41.15</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
InvoiceDetailItemReference
PO item reference

Optional

Provides the item reference information from the PO being invoiced
- lineNumber PO line number
  
  Optional Type: Number
  
  Provides the line number from the PO request payload that we sent
  
  Example: lineNumber="1"
- ItemID Item identifiers
  
  Optional
  
  Groups the supplier item identifiers
  - SupplierPartID Supplier part identifier
    
    Optional Type: String
    
    Provides the item identifier from the PO request payload that we sent
    
    Example: <SupplierPartID>45L017</SupplierPartID>
SubtotalAmount
Item subtotal

Optional

Provides the total charge for the line item before applying any discounts or tax, shipping, and handling charges
- Money Subtotal value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">82.30</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
InvoiceDetailLineShipping
Item shipping charge

Optional

Provides the shipping contact and the value of the item's shipping charge
- InvoiceDetailShipping Shipping contacts
  
  Optional
  
  Provides contacts for the item, such as a shipping or billing contact
- Money Shipping value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">2.25</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
GrossAmount
Item gross value

Optional

Provides the total charge for the line item after applying any discounts or tax, shipping, and handling charges
- Money Gross value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">86.80</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
InvoiceDetailDiscount
Item discount

Optional

Provides the value of the item's discount
- percentageRate Discount rate
  
  Optional Type: Number
  
  Provides the percentage rate of the item's discount
  
  Example: percentageRate="5"
- Money Discount value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">4.12</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"

Value summary

Required Max use: 1

Provides a value summary for the entire invoice

Example

<InvoiceDetailSummary>
  <SubtotalAmount>
    <Money currency="USD">86.80</Money>
  </SubtotalAmount>
  <Tax>
    <Money currency="USD">8.64</Money>
    <Description xml:lang="en"/>
  </Tax>
  <SpecialHandlingAmount>
    <Money currency="USD">9.99</Money>
  </SpecialHandlingAmount>
  <ShippingAmount>
    <Money currency="USD">10.09</Money>
  </ShippingAmount>
  <GrossAmount>
    <Money currency="USD">103.97</Money>
  </GrossAmount>
  <InvoiceDetailDiscount>
    <Money currency="USD">11.55</Money>
  </InvoiceDetailDiscount>
  <NetAmount>
    <Money currency="USD">92.42</Money>
  </NetAmount>
</InvoiceDetailSummary>

Invoice summary field breakdown

SubtotalAmount
Invoice subtotal

Optional

Provides the total charge of all line items before applying any discounts or tax, shipping, and handling charges
- Money Subtotal value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">86.80</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
Tax
Tax charge

Optional

Provides the total tax charge
- Money Tax value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">8.64</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
- Description Tax description
  
  Optional Type: String
  
  Provides a description or code to explain the tax charge
  
  Example: <Description xml:lang="en"/>
  - xml:lang Language
    
    Optional Format: IETF BCP 47
    
    Specifies the language used for the description
    
    Example: xml:lang="en"
SpecialHandlingAmount
Handling charge

Optional

Provides the total handling charge
- Money Handling value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">9.99</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
ShippingAmount
Shipping charge

Optional

Provides the total shipping charge
- Money Shipping value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">10.09</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
GrossAmount
Invoice total

Optional

Provides the total charge of the invoice after applying all discounts or tax, shipping, and handling charges
- Money Gross value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">103.97</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
InvoiceDetailDiscount
Discount value

Optional

Provides the discount value for the invoice
- Money Discount value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">11.55</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"
NetAmount
Invoice net value

Optional

Provides the total charge of the invoice after applying discounts but before applying charges
- Money Net value
  
  Optional Type: Number
  
  Provides the value
  
  Example: <Money currency="USD">92.42</Money>
  - currency Currency
    
    Optional Format: ISO 4217
    
    Specifies the currency for the value
    
    Example: currency="USD"

Response payload (from TradeCentric)

Once our platform processes the invoice payload, we’ll return a cXML response payload. This response will indicate whether we created a final invoice payload to transmit to the buyer.

The code block below shows an example response in our standard cXML format:

cXML

HTTP Response

Response

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE cXML SYSTEM "http://xml.cxml.org/schemas/cXML/1.2.0xx/cXML.dtd">
<cXML xml:lang="en-US" payloadID="12345678-response" timestamp="2022-11-18T00:00:01Z">
  <Response>
    <Status code="200" text="Successful">Successful</Status>
  </Response>
</cXML>

Response element details

A standard cXML response has a root element and a Response element. The subsections below explain each element and its fields.

cXML root

Applies identifying information to the entire response payload

Example

<cXML xml:lang="en-US" payloadID="12345678-response" timestamp="2022-11-18T00:00:01Z">
  ...
</cXML>

Root field breakdown

xml:lang

Language

Format: IETF BCP 47

Specifies the language used for the response

Example: xml:lang="en-US"
payloadID

Payload identifier

Type: String

Provides a unique identifier for the response

Example: payloadID="12345678-response"
timestamp

Response timestamp

Format: ISO 8601

Provides the date and time when the response was created

Example: timestamp="2022-11-18T00:00:01Z"

Response

Indicates that we either accepted or rejected the invoice

Note: The response only indicates the result of the initial validation. An error may happen later in the process, such as on the buyer side.

Example

<Response>
  <Status code="200" text="Successful">Successful</Status>
</Response>

Response field breakdown

Status
Response status

Specifies the success or error status and a corresponding message

Example: <Status code="200" text="Successful">Successful</Status>, <Status code="400" text="Error - Request document is invalid or not matched">Error - Request document is invalid or not matched</Status>
- code Status code
  
  Format: HTTP status code
  
  Provides the response status code
  
  Example: code="200" = success, code="400" = error
- text Status text
  
  Type: String
  
  Provides a brief description of the status
  
  Example: text="Successful", text="Error - Request document is invalid or not matched"

Request payload (to TradeCentric)

Request element details

cXML root

Payload identifier

Payload timestamp

cXML version

Header

Supplier credential

Buyer credential

Sending system credential

Request

Invoice identification

Deployment mode

Invoice header

Contacts and addresses

Invoice contact

Payment terms

Payment terms

Item details

PO reference

PO reference

Items

Invoice line number

Quantity

Unit of measure

Unit price

PO item reference

Item subtotal

Item shipping charge

Item gross value

Item discount

Value summary

Invoice subtotal

Tax charge

Handling charge

Shipping charge

Invoice total

Discount value

Invoice net value

Response payload (from TradeCentric)

Response element details

cXML root

Language

Payload identifier

Response timestamp

Response

Response status

Related articles