Invoice Integration - InvoiceDetailSummary

  • Updated

This article details the structure and calculation logic for the <InvoiceDetailSummary> element, which contains the validated totals for the invoice. Unimarket validates the invoice by checking that the line item totals match the summary totals; any differences will cause the invoice to fail validation.

 

Prerequisites

  • Audience: Supplier (Technical/Integration)

  • Intent: Understand and correctly calculate summary totals for the cXML invoice.

  • Data: The sum of all line item subtotals and line item tax amounts.

 

Key Ideas

The <InvoiceDetailSummary> element contains three core calculated elements: <SubtotalAmount>, <Tax>, and <GrossAmount>.

Example InvoiceDetailSummary:

<InvoiceDetailSummary>
    <SubtotalAmount>
        <Money currency="NZD">40.53</Money>
    </SubtotalAmount>
    <Tax>
        <Money currency="NZD">6.0795</Money>
        <Description lang="en">GST</Description>
    </Tax>
    <GrossAmount>
        <Money currency="NZD">46.6095</Money>
    </GrossAmount>
</InvoiceDetailSummary>

 

1. Subtotal Amount (<SubtotalAmount>)

This element represents the total cost of all goods before tax and other charges.

  • The <Money> element holds the total sum of the <SubtotalAmount> from each line item.

    • Calculation: Sum of all <InvoiceDetailItem>/<SubtotalAmount> values.

 
<SubtotalAmount>
    <Money currency="NZD">40.53</Money>
</SubtotalAmount>

 

Example Calculation: $17.05 + 13.08 + 10.40 = 40.53.

<InvoiceDetailItem invoiceLineNumber="1" quantity="1.00">
    <SubtotalAmount>
        <Money currency="NZD">17.05</Money>
    </SubtotalAmount>
</InvoiceDetailItem>
<InvoiceDetailItem invoiceLineNumber="2" quantity="12.00">
    <SubtotalAmount>
        <Money currency="NZD">13.08</Money>
    </SubtotalAmount>
</InvoiceDetailItem>
<InvoiceDetailItem invoiceLineNumber="3" quantity="10.00">
    <SubtotalAmount>
        <Money currency="NZD">10.40</Money>
    </SubtotalAmount>
</InvoiceDetailItem>

 

2. Total Tax (<Tax>)

This element represents the total tax across all line items in the invoice.

  • The <Money> element holds the total sum of the tax amount from each line item.

  • The <Description> element contains the name of the tax type (e.g., GST).

    • Calculation: Sum of all <InvoiceDetailItem>/<Tax>/<Money> values.

 
<Tax>
    <Money currency="NZD">6.0795</Money>
    <Description lang="en">GST</Description>
</Tax>

 

Example Calculation: $2.5575 + 1.962 + 1.56 = 6.0795.

<InvoiceDetailItem invoiceLineNumber="1" quantity="1.00">
    <Tax>
        <Money currency="NZD">2.5575</Money>
        <Description lang="en">GST</Description>
    </Tax>
</InvoiceDetailItem>
<InvoiceDetailItem invoiceLineNumber="2" quantity="12.00">
    <Tax>
        <Money currency="NZD">1.962</Money>
        <Description lang="en">GST</Description>
    </Tax>
</InvoiceDetailItem>
<InvoiceDetailItem invoiceLineNumber="3" quantity="10.00">
    <Tax>
        <Money currency="NZD">1.56</Money>
        <Description lang="en">GST</Description>
    </Tax>
</InvoiceDetailItem>

 

3. Gross Amount (<GrossAmount>)

This element represents the final total amount for the invoice.

  • The <Money> element holds the currency and the calculated Gross Amount.

    • Calculation Formula: Subtotal + Tax = GrossAmount.

 
<GrossAmount>
    <Money currency="NZD">46.6095</Money>
</GrossAmount>

 

Complete Basic Invoice Example

<cXML payloadID="[A Unique Value]" timestamp="2020-10-08T23:59:45-07:00" version="1.2.021">
    <Header>
        <From>
            <Credential domain="unimarket-id">
                <Identity>82d1aa66-095a-45a8-b8f1-20778aac4ed8</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="unimarket-code">
                <Identity>miketest</Identity>
            </Credential>
        </To>
        <Sender>
            <Credential domain="unimarket-user">
                <Identity>fd36b3b9-ad5a-4fa6-aedd-a826b7b3d87b</Identity>
                <SharedSecret>Super Secret Password</SharedSecret>
            </Credential>
            <UserAgent>Suppliers Software System</UserAgent>
        </Sender>
    </Header>
    <Request deploymentMode="test">
        <InvoiceDetailRequest>
            <InvoiceDetailRequestHeader invoiceDate="2020-10-08" invoiceID="TestInvoice10018" operation="new" purpose="standard">
                <InvoiceDetailLineIndicator isTaxInLine="yes"/>
                <InvoicePartner>
                    <Contact role="billTo">
                        <Name lang="en">Bill To Address</Name>
                        <PostalAddress>
                            <Street>123 Something Street</Street>
                            <City>Auckland</City>
                            <PostalCode>1010</PostalCode>
                            <Country isoCountryCode="NZ">New Zealand</Country>
                        </PostalAddress>
                    </Contact>
                </InvoicePartner>
            </InvoiceDetailRequestHeader>
            <InvoiceDetailOrder>
                <InvoiceDetailOrderInfo>
                    <OrderReference orderID="[Purchase Order Number]"/>
                </InvoiceDetailOrderInfo>
                <InvoiceDetailItem invoiceLineNumber="1" quantity="1.00">
                    <InvoiceDetailItemReference lineNumber="1">
                        <ItemID>
                            <SupplierPartID>1497243</SupplierPartID>
                        </ItemID>
                        <Description lang="en">LAMINATING POUCH A4 80MU GLOSSY FINISH PK/100</Description>
                    </InvoiceDetailItemReference>
                    <UnitOfMeasure>PACK</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="NZD">17.05</Money>
                    </UnitPrice>
                    <SubtotalAmount>
                        <Money currency="NZD">17.05</Money>
                    </SubtotalAmount>
                    <Tax>
                        <Money currency="NZD">2.5575</Money>
                        <Description lang="en">GST</Description>
                    </Tax>
                </InvoiceDetailItem>
                <InvoiceDetailItem invoiceLineNumber="2" quantity="12.00">
                    <InvoiceDetailItemReference lineNumber="2">
                        <ItemID>
                            <SupplierPartID>2223414</SupplierPartID>
                        </ItemID>
                        <Description lang="en">TISSUE FACIAL TORK 2311408 PREMIUM 2 PLY PK/100</Description>
                    </InvoiceDetailItemReference>
                    <UnitOfMeasure>PACK</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="NZD">1.09</Money>
                    </UnitPrice>
                    <SubtotalAmount>
                        <Money currency="NZD">13.08</Money>
                    </SubtotalAmount>
                    <Tax>
                        <Money currency="NZD">1.962</Money>
                        <Description lang="en">GST</Description>
                    </Tax>
                </InvoiceDetailItem>
                <InvoiceDetailItem invoiceLineNumber="3" quantity="10.00">
                    <InvoiceDetailItemReference lineNumber="3">
                        <ItemID>
                            <SupplierPartID>1046543</SupplierPartID>
                        </ItemID>
                        <Description lang="en">FINGER CONE NO 0 </Description>
                    </InvoiceDetailItemReference>
                    <UnitOfMeasure>EACH</UnitOfMeasure>
                    <UnitPrice>
                        <Money currency="NZD">1.04</Money>
                    </UnitPrice>
                    <SubtotalAmount>
                        <Money currency="NZD">10.40</Money>
                    </SubtotalAmount>
                    <Tax>
                        <Money currency="NZD">1.56</Money>
                        <Description lang="en">GST</Description>
                    </Tax>
                </InvoiceDetailItem>
            </InvoiceDetailOrder>
            <InvoiceDetailSummary>
                <SubtotalAmount>
                    <Money currency="NZD">40.53</Money>
                </SubtotalAmount>
                <Tax>
                    <Money currency="NZD">6.0795</Money>
                    <Description lang="en">GST</Description>
                </Tax>
                <GrossAmount>
                    <Money currency="NZD">46.6095</Money>
                </GrossAmount>
            </InvoiceDetailSummary>
        </InvoiceDetailRequest>
    </Request>
</cXML>