AP Invoice API

Release version: Yokohama

Updated January 30, 2025

33 minutes to read

Allows external systems, such as those used by vendors, to securely submit invoices directly into an accounts payable system in a structured and automated manner.

This API requires the Accounts Payable Invoice Processing (com.sn_ap_apm) store application, which is provided within the sn_spend_intg namespace. For information, see Accounts Payable Invoice Processing.

Refer to AP Invoice API Developer Guide for help with the following tasks:

Define a custom field for invoices, invoice lines, and invoice tax lines.
Map the custom field between source and target tables.
Map the custom field to a payload entry in a specific format, such as JSON, cXML, or XML.
Setting credentials for authentication when using cXML as the payload.

Note:

The maximum default payload size is 100 records. This value is configurable in the sn_spend_intg.ap.invoice.create.api.record_limit system property.

AP Invoice – POST sn_spend_intg/ap_invoice/cxml

Processes an automated invoice in commerce XML (cXML) format.

Use the Invoice integration field mappings [sn_spend_intg_invoice_intg_field_mapping] table to determine how the fields are mapped to cXML tags.

For additional cXML resources, refer to the cXML Reference Guide at https://xml.cxml.org.

Credentials for this API are included in the payload. You can set up credentials in the Source system credential [sn_spend_intg_source_system_credential] table. For instructions, see Setting credentials for authentication in the cXML payload.

You can define custom invoice fields for the request body. Use the following flow to add custom fields, map them to target tables, and format them for availability in the payload:

URL format

Versioned URL: /api/sn_spend_intg/v1/ap_invoice/cxml

Default URL: /api/sn_spend_intg/ap_invoice/cxml

Supported request parameters

Table 1. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String

Table 2. Query parameters
Name	Description
None

Table 3. Request body elements (cXML)
Path	Description
/cXML/Header/From /Credential[@domain='VendorID']/Identity	Identifier for the reseller or supplier that the customer can place orders with. Target field: u_supplier Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader[@invoiceDate]	Date on which the customer was invoiced. Target field: u_invoice_date Related table: Invoice Import [sn_spend_intg_imp_invoice] Format: YYYY-MM-DD
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader[@invoiceID]	Invoice number generated from a third-party application. Target field: u_external_invoice_number Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader[@invoiceOrigin]	External source system from where the invoice is received. For example, supplier. Target field: u_inbound_source Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/City	The city to which the invoice is sent. Target field: u_bill_to_city Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/Country	The country to which the invoice is sent in ISO 3166 format. For example, `US`. Target field: u_bill_to_country Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/State	The state or province to which the invoice is sent. Target field: u_bill_to_state_or_province Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/Street	The street address to which the invoice is sent. Target field: u_bill_to_street Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/InvoicePartner /Contact[@role='billTo']/PostalAddress/PostalCode	The zip or postal code to which the invoice is sent. Target field: u_bill_to_zip_or_postal_code
Contact[@role="remitTo"]/PostalAddress /Street	The street address to which the payment is made. Target field: u_remit_address
Contact[@role="remitTo"]/PostalAddress /City	The city to which the payment is made. Target field: u_remit_to_city
Contact[@role="remitTo"]/PostalAddress /State	The state or province to which the payment is made. Target field: u_remit_to_state_or_province
Contact[@role="remitTo"]/PostalAddress /PostalCode	The zip or postal code to which the payment is made. Target field: u_remit_to_zip_or_postal_code
Contact[@role="remitTo"]/PostalAddress /Country	The country to which the payment is made in ISO 3166 format. For example, `US`. Target field: u_remit_to_country
/cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /Street	Street from which the items on the purchase order are shipped. Target field: u_ship_from_street Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /City	City from which the items on the purchase order are shipped. Target field: u_ship_from_city Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /State	State from which the items on the purchase order are shipped. Target field: u_ship_from_state_or_province Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /PostalCode	Zip code from which the items on the purchase order are shipped. Target field: u_ship_from_zip_or_postal_code Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoiceDetailShipping/Contact[@role="shipFrom"]/PostalAddress /Country	Country from which the items on the purchase order are shipped. Target field: u_ship_from_country Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailRequestHeader /InvoicePartner/Contact[@role="billTo"] [@addressID]	Name of the legal entity of the supplier. Located in the Legal Entity [sn_fin_legal_entity] table. Target field: u_legal_entity Related table: Invoice Import [sn_spend_intg_imp_invoice]
Contact[@role="shipTo"]/Name	Name of the contact to which the items on the purchase order should be shipped. Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
Contact[@role="shipTo"]/PostalAddress /Street	Street to which the items on the purchase order are shipped. Target field: u_ship_to_street Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
Contact[@role="shipTo"]/PostalAddress /City	City to which the items on the purchase order are shipped. Target field: u_ship_to_city Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
Contact[@role="shipTo"]/PostalAddress /State	State or province to which the items on the purchase order are shipped. Target field: u_ship_to_state_or_province
Contact[@role="shipTo"]/PostalAddress /PostalCode	Zip code to which the items on the purchase order are shipped. Target field: u_ship_to_zip_or_postal_code Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
Contact[@role="shipTo"]/PostalAddress /Country	Country to which the items on the purchase order are shipped. Target field: u_ship_from_country Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest /InvoiceDetailRequestHeader/PaymentTerm	The agreed upon time and conditions under which a payment to a supplier is made. For example, `Net 30`. Target field: u_payment_terms Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem[@description]/	Description of the invoice line. Target field: u_line_description
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem[@quantity]/	Quantity of goods or services that a customer is being invoiced for. Target field: u_line_quantity
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Distribution/Accounting /AccountingSegment[1]/Name	Account number of the cost center for which the invoice is generated. Listed in the Cost Center [cmn_cost_center] table. Target field: u_cost_center
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Distribution/Accounting /AccountingSegment[2]/Name	Account number of the general ledger (GL) used to generate the invoice. Target field: u_gl_account See also: ERP source Ledger account
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/SubtotalAmount/Money	Total amount of money to be paid to the supplier excluding tax and shipping charges. Target field: u_subtotal Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/NetAmount/Money	Total cost, excluding taxes and shipping, that a customer is being invoiced for a given purchase order line. Target field: u_line_amount_invoiced Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailOrderInfo/OrderReference	Purchase order number that is provided by the customer for this order. Listed in the Purchase Order [sn_shop_purchase_order] table. Target field: u_purchase_order Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/UnitPrice/UnitOfMeasure	Base unit of measure (UOM) used to count the item in the invoice. Target field: u_uom Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/UnitPrice/Money	Unit price of the line item in the invoice. Target field: u_line_unit_price Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/UnitPrice/Money[@currency]	Currency for the line item. For example, `USD`. Target field: u_currency Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem /InvoiceDetailItemReference[@lineNumber]	Purchase order line ID for the referenced supplier. Listed in the Purchase Order Line [sn_shop_purchase_order_line] table. Target field: u_purchase_order_line Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/InvoiceDetailItemReference /ItemID/SupplierPartID	Part number that is generated by a supplier for this invoice line. Target field: u_supplier_part_number Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/InvoiceDetailItemReference /Description	Description of the purchase order line for the invoice. Target field: u_po_line_description Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Tax/Money	Total amount of taxes that are billed for the purchase. Target field: u_tax_amount Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
cXML/Request/InvoiceDetailRequest/InvoiceDetailOrder /InvoiceDetailItem/Tax/Description	Unique tax code generated from the ERP source. Target field: u_tax_code Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/cXML/Request/InvoiceDetailRequest/ InvoiceDetailSummary /SubtotalAmount/Money	Total amount of money to be paid to the supplier excluding tax and shipping charges. Target field: u_subtotal Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /Tax/Money	Total amount of taxes that are billed for the purchase. Target field: u_tax_amount Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /Tax/TaxDetail[@category]	Type of tax applicable on the invoice. Listed in the Tax Type [sn_fin_tax_type] table. Target field: u_tax_type Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /Tax/TaxDetail[@percentageRate]	The tax rate charged by the supplier. Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line] Target field: u_supplier_tax_rate Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /SpecialHandlingAmount/Money	Other additional charges associated with the invoice. This is an editable field. Target field: u_other_charges Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /ShippingAmount/Money	Total shipping cost for the entire purchase. Target field: u_shipping_amount Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /GrossAmount/Money	Required. Currency for subtotal, tax, and shipping. The subtotal, tax, and shipping should be in the same currency. Target field: u_currency Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /InvoiceDetailDiscount/Money	Discounts that are applied toward the invoice. Target field: u_discounts Related table: Invoice Import [sn_spend_intg_imp_invoice]
/cXML/Request/InvoiceDetailRequest/InvoiceDetailSummary /NetAmount/Money	Total amount of money to be paid to the supplier including tax and shipping charges. Target field: u_amount_invoiced Related table: Invoice Import [sn_spend_intg_imp_invoice]

Headers

The following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see Supported REST API headers.

Table 4. Request headers
Header	Description
Content-Type	Data format of the request body. Only supports application/xml.
Source-System	Specifies the source system from which the request is coming from. Available systems are listed in the Source systems credentials [sn_spend_intg_source_system_credential] table. This setting helps to determine if the request provided follows the structure in the Invoice integration field mapping [sn_spend_intg_invoice_intg_field_mapping] table. This setting is also used to fetch credentials from the Source system credentials [sn_spend_intg_source_system_credential] table.

Table 5. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 6. Status codes
Status code	Description
202	Request Accepted. The request is successful and invoice processing is in progress.
400	Bad Request. A bad request type or malformed request was detected.
429	Too Many Requests. The request rate has exceeded the maximum of 10 requests per hour.

Response body parameters


Name	Description
batch_id	Unique identifier for the batch request. This ID can be used to track the status of the request. This record is stored in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Data type: String
error	Contains error message and details when the request fails. `{ "detail": String, "message": String }` Data type: Object
error.detail	Additional details about the request error. Possible results: Failed API level ACL Validation - User does not have read/write access to the resource. Rate limit of 13 requests per hour for AP Invoice exceeded – The number of records in the batch is more than the batch size set. Required to provide Auth information - Either the password is wrong or user name is wrong. Data type: String
error.message	Error message containing the reason the request failed Possible errors: Invalid payload - Invalid content type. Invalid payload - Error: Invalid payload structure. Invalid payload - Error: Payload exceeds allowed invoices limit in a batch. The number of records in the batch is more than the batch size set. The maximum default payload size is 100 records. This value is configurable in the sn_spend_intg.ap.invoice.create.api.record_limit system property. Invalid payload - Error: Empty invoices. No data to process. The number of records in the batch is zero. Rate limit of 500 requests per hour for APO Invoice Ingestion exceeded. User Not Authenticated. Either the password is wrong or user name is wrong. Failed API level ACL Validation - User does not have read/write access to the resource. Data type: String
message	Success message, for example, `Your request has been successfully received and is being processed`. You can view the status of the request in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Data type: String
status	Indicates the result of the request. Possible values: Success Fail Data type: String

cURL request

The following example shows how to process an invoice provided as a request in cXML format.

curl -X POST https://instance.servicenow.com/api/sn_spend_intg/v1/ap_invoice/cxml \
-H "Source-System: Ariba" \
-H "Content-Type: application/json" \
-d '{
    "content": "------=_Part_1367_1859161670.1709186492411\r\nContent-Type: text/xml; charset=UTF-8\r\n
Content-ID: 1709186492411.10815535@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com\r\n<?xml version=\"1.0\" 
encoding=\"UTF-8\"?>\r\n<!DOCTYPE cXML SYSTEM \"https://protect-us.mimecast.com/s/fgKrCERVqQU35PNzBuw39pz?domain=xml.cxml.org\">
\r\n<cXML timestamp=\"2024-02-28T22:01:32-08:00\" payloadID=\"1709186492411-3401013259654180284@10.209.37.74\">
\r\n    <Response>\r\n        <Status code=\"200\" text=\"OK\" />\r\n        <DataResponse>\r\n            <Attachment>
\r\n                <URL>186492411.10815535@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com.110</URL>\r\n            </Attachment>
\r\n            <Attachment>\r\n                <URL>1709186492403.306612238@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com.108</URL>
\r\n            </Attachment>\r\n        </DataResponse>\r\n    </Response>\r\n</cXML>\r\n------=_Part_1367_1859161670.1709186492411
\r\nContent-Type: text/xml; charset=UTF-8\r\nContent-ID: 1709186492403.306612238@produs-c4-an-s2-z3-1.us2.gcpint.ariba.com.108
\r\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n
<!DOCTYPE cXML SYSTEM \"https://protect-us.mimecast.com/s/7QpfCG6VRKf15gQPwFpUTKe?domain=xml.cxml.org\">\r\n
<cXML payloadID=\"1705930173863-1790846563502652473@10.209.37.98\" timestamp=\"2024-01-22T05:29:33-08:00\" version=\"1.2.060\">\r\n
    <Header>\r\n        <From>\r\n            <Credential domain=\"NetworkID\">\r\n                <Identity>AN01532216648-T</Identity>\r\n
            </Credential>\r\n            <Credential domain=\"VendorID\">\r\n                <Identity>3245545</Identity>\r\n
            </Credential>\r\n            <Credential domain=\"PrivateID\">\r\n                <Identity>0000099123</Identity>\r\n
            </Credential>\r\n        </From>\r\n        <To>\r\n            <Credential domain=\"NetworkID\">\r\n
                <Identity>AN01404744424-T</Identity>\r\n            </Credential>\r\n            <Credential domain=\"SystemID\">\r\n
                <Identity>ERP1</Identity>\r\n            </Credential>\r\n            <Credential domain=\"EndPointID\">\r\n
                <Identity>CIG</Identity>\r\n            </Credential>\r\n        </To>\r\n        <Sender>\r\n
            <Credential domain=\"NetworkID\">\r\n                <Identity>AN01000000001</Identity>\r\n
                <SharedSecret>Ariba@123</SharedSecret>\r\n            </Credential>\r\n            <UserAgent>Supplier</UserAgent>\r\n
        </Sender>\r\n    </Header>\r\n    <Request deploymentMode=\"test\">\r\n        <InvoiceDetailRequest>\r\n
            <InvoiceDetailRequestHeader invoiceDate=\"2024-01-22\" invoiceID=\"\" invoiceOrigin=\"supplier\" operation=\"new\ purpose=\"PO Invoice\">\r\n
                <InvoiceDetailHeaderIndicator></InvoiceDetailHeaderIndicator>\r\n
                <InvoiceDetailLineIndicator></InvoiceDetailLineIndicator>\r\n                <InvoicePartner>\r\n
                    <Contact addressID=\"Test123\" role=\"remitTo\">\r\n
                        <Name xml:lang=\"en-US\">Oil and Natural Gas Corporation Limited</Name>\r\n
                        <PostalAddress>\r\n                            <Street>Xyz street</Street>\r\n                            <City>USA</City>\r\n
                            <State isoStateCode=\"US-NY\">NY</State>\r\n                            <PostalCode>10001</PostalCode>\r\n
                            <Country isoCountryCode=\"US\">United States</Country>\r\n                        </PostalAddress>\r\n
                    </Contact>\r\n                </InvoicePartner>\r\n                <InvoicePartner>\r\n
                    <Contact addressID=\"9009\" role=\"billTo\">\r\n                        <Name xml:lang=\"EN\">Bristlecone Inc</Name>\r\n
                        <PostalAddress>\r\n                            <Street>10 Boulvard-10</Street>\r\n
                            <City>San Jose</City>\r\n                            <State>CA</State>\r\n
                            <PostalCode>94077</PostalCode>\r\n                            <Country isoCountryCode=\"US\"></Country>\r\n
                        </PostalAddress>\r\n                        <Phone>\r\n                            <TelephoneNumber>\r\n
                                <CountryCode isoCountryCode=\"US\">1</CountryCode>\r\n                                <Number>7687687799</Number>\r\n
                            </TelephoneNumber>\r\n                        </Phone>\r\n                        <Fax>\r\n
                            <TelephoneNumber>\r\n                                <CountryCode isoCountryCode=\"US\">1</CountryCode>\r\n
                                <Number>768-FAX-NUMBER</Number>\r\n                            </TelephoneNumber>\r\n                        </Fax>\r\n
                    </Contact>\r\n                </InvoicePartner>\r\n                <InvoicePartner>\r\n                    <Contact role=\"from\">\r\n
                        <Name xml:lang=\"en-US\">Oil and Natural Gas Corporation Limited</Name>\r\n                        <PostalAddress>\r\n
                            <Street>123 , street no 5</Street>\r\n                            <City>Dallas</City>\r\n
                            <State isoStateCode=\"US-AL\">AL</State>\r\n                            <PostalCode>36615</PostalCode>\r\n
                            <Country isoCountryCode=\"US\">United States</Country>\r\n                        </PostalAddress>\r\n
                    </Contact>\r\n                </InvoicePartner>\r\n                <InvoiceDetailShipping>\r\n
                    <Contact role=\"shipFrom\">\r\n                        <Name xml:lang=\"en-US\">Oil and Natural Gas Corporation Limited</Name>\r\n
                        <PostalAddress>\r\n                            <Street>Deendayal Urja Bhawan</Street>\r\n
                            <City>New Delhi</City>\r\n                            <State isoStateCode=\"IN-MH\">Maharashtra</State>\r\n
                            <PostalCode>110070</PostalCode>\r\n                            <Country isoCountryCode=\"IN\">India</Country>\r\n
                        </PostalAddress>\r\n                    </Contact>\r\n                    <Contact addressID=\"9999\" role=\"shipTo\">\r\n
                        <Name xml:lang=\"EN\">Buyer Plant Bristlecone</Name>\r\n                        <PostalAddress name=\"default\">\r\n
                            <Street>18 Hanoi Road</Street>\r\n                            <City>San Jose</City>\r\n
                            <State>CA</State>\r\n                            <PostalCode>77077</PostalCode>\r\n
                            <Country isoCountryCode=\"US\"></Country>\r\n                        </PostalAddress>\r\n
                        <Email name=\"default\" preferredLang=\"en\">test@test.com</Email>\r\n                    </Contact>\r\n
                </InvoiceDetailShipping>\r\n            </InvoiceDetailRequestHeader>\r\n            <InvoiceDetailOrder>\r\n
                <InvoiceDetailOrderInfo>\r\n                    <OrderReference orderID=\"\">\r\n
                        <DocumentReference payloadID=\"0AAF8EA1FA5F1EDE9FDC97460BCB03E1\"></DocumentReference>\r\n
                    </OrderReference>\r\n                </InvoiceDetailOrderInfo>\r\n
                <InvoiceDetailItem invoiceLineNumber=\"2\" quantity=\"25\" description=\"Indian Oil\">\r\n
                    <UnitOfMeasure>EA</UnitOfMeasure>\r\n                    <UnitPrice>\r\n                        <Money currency=\"USD\">50</Money>\r\n
                    </UnitPrice>\r\n                    <SubtotalAmount>\r\n                        <Money currency=\"USD\">1250.00</Money>\r\n
                    </SubtotalAmount>\r\n                </InvoiceDetailItem>\r\n            </InvoiceDetailOrder>\r\n        </InvoiceDetailRequest>\r\n
    </Request>\r\n</cXML>\r\n------=_Part_1367_1859161670.1709186492411--"
}'

The following result shows that the request is successful and the invoice data is processing. You can view the status of the request in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Use the batch ID listed in the Batch ID column to find the invoice.

{
    "batchId": "APIINV1729711710733280",
    "status": "Success",
    "message": "Your request has been successfully received and is being processed."
}

AP Invoice – POST sn_spend_intg/ap_invoice/json

Processes an automated invoice in JSON format.

Role required: sn_spend_intg.procurement_integrator

Use the Invoice integration field mappings [sn_spend_intg_invoice_intg_field_mapping] table to determine how the fields are mapped to JSON properties.

You can define custom invoice fields for the request body. Use the following flow to add custom fields, map them to target tables, and format them for availability in the payload:

URL format

Versioned URL: /api/sn_spend_intg/v1/ap_invoice/json

Default URL: /api/sn_spend_intg/ap_invoice/json

Supported request parameters

Table 7. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String

Table 8. Query parameters
Name	Description
None

Table 9. Request body parameters
Name	Description
invoices	List containing each invoice to be processed. Data type: Object of nested invoice objects. "invoices": { { "amount_invoiced": "String", "bill_to_city": "String", "bill_to_country": "String", "bill_to_state_or_province": "String", "bill_to_street": "String", "bill_to_zip_or_postal_code": "String", "business_owner": "String", "currency": "String", "discounts": "String", "erp_number": "String", "external_invoice_number": "String", "invoice_date": "String", "invoice_line_count": "String", "invoice_lines": [Array], "invoice_type": "String", "legal_entity": "String", "original_invoice": "String", "other_charges": "String", "payment_terms": "String", "purchase_order": "String", "remit_address": "String", "remit_to_city": "String", "remit_to_country": "String", "remit_to_state_or_province": "String", "remit_to_zip_or_postal_code": "String", "ship_from_city": "String", "ship_from_country": "String", "ship_from_state_or_province": "String", "ship_from_street": "String", "ship_from_zip_or_postal_code": "String", "ship_to_city": "String", "ship_to_country": "String", "ship_to_state_or_province": "String", "ship_to_street": "String", "ship_to_zip_or_postal_code": "String", "shipping_amount": "String", "subtotal": "String", "supplier": "String", "supplier_invoice_number": "String", "supplier_tax_id": "String" } }
invoices.amount_invoiced	Total amount of money to be paid to the supplier including tax and shipping charges. Target field: u_amount_invoiced Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
bill_to_city	The city to which the invoice is sent. Target field: u_bill_to_city Related table: Invoice Import [sn_spend_intg_imp_invoice]
bill_to_country	The country to which the invoice is sent in ISO 3166 format. For example, `US`. Target field: u_bill_to_country Related table: Invoice Import [sn_spend_intg_imp_invoice]
bill_to_state_or_province	The state or province to which the invoice is sent. Target field: u_bill_to_state_or_province Related table: Invoice Import [sn_spend_intg_imp_invoice]
bill_to_street	The street address to which the invoice is sent. Target field: u_bill_to_street Related table: Invoice Import [sn_spend_intg_imp_invoice]
bill_to_zip_or_postal_code	The zip or postal code to which the invoice is sent. Target field: u_bill_to_zip_or_postal_code
invoices.business_owner	Name of the owner who owns the application from the business side. Target field: u_business_owner Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.currency	Required. Currency for subtotal, tax, and shipping. The subtotal, tax, and shipping should be in the same currency. Target field: u_currency Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.discounts	Discounts that are applied toward the invoice. Target field: u_discounts Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.erp_number	Unique number generated within the ERP (Enterprise Resource Planning) system for the purchase order. For information, see Purchase order integration. Target field: u_erp_number Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices. external_invoice_number	Required. Invoice number generated from a third-party application. Target field: u_external_invoice_number Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.invoice_date	Required. Date on which the customer was invoiced. Target field: u_invoice_date Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40 Format: YYYY-MM-DD
invoices.invoice_line_count	Number of lines in the invoice. Target field: u_invoice_line_count Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.invoice_lines	List of objects that define the lines that are being invoiced for purchases within this order. Invoice lines are staged in the Invoice line import inbound [sn_spend_intg_imp_invoice_line] table. Data type: Array "invoice_lines": [ { "cost_center": "String", "currency": "String", "external_invoice_number": "String", "gl_account": "String", "line_amount_invoiced": "String", "line_description": "String", "line_quantity": "String", "line_unit_price": "String", "po_line_description": "String", "purchase_order_line": "String", "ship_to_city": "String", "ship_to_country": "String", "ship_to_state_or_province": "String", "ship_to_street": "String", "ship_to_zip_or_postal_code": "String", "subtotal": "String", "supplier_part_number": "String", "tax_code": "String", "tax_details": [Array], "uom": "String" } ]
invoices.invoice_lines. cost_center	Account number of the cost center for which the invoice is generated. Listed in the Cost Center [cmn_cost_center] table. Target field: u_cost_center Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. currency	Currency for the line item. For example, `USD`. Target field: u_currency Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. external_invoice_number	Required. Invoice number generated from a third-party application. Target field: u_external_invoice_number Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.invoice_lines. gl_account	Account number of the general ledger (GL) used to generate the invoice. Target field: u_gl_account Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40 See also: ERP source Ledger account
invoices.invoice_lines. line_amount_invoiced	Required. Total cost, excluding taxes and shipping, that a customer is being invoiced for a given purchase order line. Target field: u_line_amount_invoiced Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. line_description	Required. Description of the invoice line. Target field: u_line_description Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. line_quantity	Required. Quantity of goods or services that a customer is being invoiced for. Target field: u_line_quantity Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. line_unit_price	Unit price of the line item in the invoice. Target field: u_line_unit_price Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. po_line_description	Description of the purchase order line for the invoice. Target field: u_po_line_description Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 100
invoices.invoice_lines. purchase_order_line	Required. Purchase order line ID for the referenced supplier. Listed in the Purchase Order Line [sn_shop_purchase_order_line] table. Target field: u_purchase_order_line Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 40
invoices.invoice_lines. ship_to_city	City to which the items on the purchase order are shipped. Target field: u_ship_to_city Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 100
invoices.invoice_lines. ship_to_country	Country to which the items on the purchase order are shipped. Target field: u_ship_to_country Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 100
invoices.invoice_lines. ship_to_state_or_province	State or province to which the items on the purchase order are shipped. Target field: u_ship_to_state_or_province Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 100
invoices.invoice_lines. ship_to_street	Street to which the items on the purchase order are shipped. Target field: u_ship_to_street Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 100
invoices.invoice_lines. ship_to_zip_or_postal_code	Zip code to which the items on the purchase order are shipped. Target field: u_ship_to_zip_or_postal_code Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line] Data type: String Maximum length: 100
invoices.invoice_lines. subtotal	Required. Total amount of money to be paid to the supplier excluding tax and shipping charges. Target field: u_subtotal Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.invoice_lines. supplier_part_number	Required. Part number that is generated by a supplier for this invoice line. Target field: u_supplier_part_number Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.invoice_lines. tax_code	Unique tax code generated from the ERP source. Target field: u_tax_code Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.invoice_lines. tax_details	List of tax lines for purchases associated with the invoice line. Data type: Array of Objects `"tax_details": [ { "tax_amount": "String", "tax_rate": "String", "tax_type": "String" } ]`
invoices.invoice_lines. tax_details.tax_amount	Required. Total amount of taxes that are billed for the purchase. Target field: u_tax_amount Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line] Data type: String Maximum length: 40
invoices.invoice_lines. tax_details.tax_rate	The tax rate charged by the supplier. Target field: u_supplier_tax_rate Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line] Data type: String Maximum length: 100
invoices.invoice_lines. tax_details.tax_type	Type of tax applicable on the invoice. Listed in the Tax Type [sn_fin_tax_type] table. Target field: u_tax_type Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line] Data type: String Maximum length: 100
invoices.invoice_lines.uom	Base unit of measure (UOM) used to count the item in the invoice. Target field: u_uom Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.invoice_type	Type of invoice for processing. Target field: u_invoice_type Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.legal_entity	Name of the legal entity of the supplier. Located in the Legal Entity [sn_fin_legal_entity] table. Target field: u_legal_entity Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.original_invoice	Unique invoice number created by the supplier. Related table: Invoice Import [sn_spend_intg_imp_invoice] Target field: u_original_invoice Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.other_charges	Other additional charges associated with the invoice. This is an editable field. Target field: u_other_charges Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.payment_terms	The agreed upon time and conditions under which a payment to a supplier is made. For example, `Net 30`. Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.purchase_order	Required. Purchase order number that is provided by the customer for this order. Listed in the Purchase Order [sn_shop_purchase_order] table. Target field: u_purchase_order Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.remit_address	Required. The street address to which the payment is made. Target field: u_remit_address Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.remit_to_city	Required. The city to which the payment is made. Target field: u_remit_to_city Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.remit_to_country	Required. The country to which the payment is made in ISO 3166 format. For example, `US`. Target field: u_remit_to_country Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices. remit_to_state_or_province	Required. The state or province to which the payment is made. Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices. remit_to_zip_or_postal_code	Required. The zip or postal code to which the payment is made. Target field: u_remit_to_state_or_province Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.ship_from_city	City from which the items on the purchase order are shipped. Target field: u_ship_from_city Data type: String Maximum length: 100
invoices.ship_from_country	Country from which the items on the purchase order are shipped. Target field: u_ship_from_country Data type: String Maximum length: 100
invoices. ship_from_state_or_province	State from which the items on the purchase order are shipped. Target field: u_ship_from_state_or_province Data type: String Maximum length: 100
invoices.ship_from_street	Street from which the items on the purchase order are shipped. Target field: u_ship_from_street Data type: String Maximum length: 100
invoices. ship_from_zip_or_postal_code	Zip code from which the items on the purchase order are shipped. Target field: u_ship_from_zip_or_postal_code Data type: String Maximum length: 100
invoices.ship_to_city	City to which the items on the purchase order are shipped. Target field: u_ship_to_city Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.ship_to_country	Country to which the items on the purchase order are shipped. Target field: u_ship_to_country Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices. ship_to_state_or_province	State to which the items on the purchase order are shipped. Target field: u_ship_to_state_or_province Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.ship_to_street	Street to which the items on the purchase order are shipped. Target field: u_ship_to_street Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices. ship_to_zip_or_postal_code	Zip code to which the items on the purchase order are shipped. Target field: u_ship_to_zip_or_postal_code Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.shipping_amount	Required. Total shipping cost for the entire purchase. Target field: u_shipping_amount Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.subtotal	Required. Total amount of money to be paid to the supplier excluding tax and shipping charges. Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 40
invoices.supplier	Required. Identifier for the reseller or supplier that the customer can place orders with. Target field: u_supplier Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices. supplier_invoice_number	Required. Identification number that is generated by a supplier for this invoice. Target field: u_supplier_invoice_number Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.supplier_tax_id	Tax identifier that is associated with the third party reseller. This is an editable field. Target field: u_supplier_tax_id Related table: Invoice Import [sn_spend_intg_imp_invoice] Data type: String Maximum length: 100
invoices.target_erp	ERP record in which the invoice is posted. Located in the ERP Source [sn_fin_erp_source] table. See ERP source. Data type: String

Headers

Table 10. Request headers
Header	Description
Content-Type	Data format of the request body. Only supports application/json.
Source-System	Specifies the source system from which the request is coming from. This setting helps to determine if the request provided follows the structure in the Invoice integration field mapping [sn_spend_intg_invoice_intg_field_mapping] table.

Table 11. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 12. Status codes
Status code	Description
202	Request Accepted. The request is successful and invoice processing is in progress.
400	Bad Request. A bad request type or malformed request was detected.
429	Too Many Requests. The request rate has exceeded the maximum of 10 requests per hour.

Response body parameters


Name	Description
batch_id	Unique identifier for the batch request. This ID can be used to track the status of the request. This record is stored in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Data type: String
error	Contains error message and details when the request fails. `{ "detail": String, "message": String }` Data type: Object
error.detail	Additional details about the request error. Possible results: Failed API level ACL Validation - User does not have read/write access to the resource. Rate limit of 13 requests per hour for AP Invoice exceeded – The number of records in the batch is more than the batch size set. Required to provide Auth information - Either the password is wrong or user name is wrong. Data type: String
error.message	Error message containing the reason the request failed Possible errors: Invalid payload - Invalid content type. Invalid payload - Error: Invalid payload structure. Invalid payload - Error: Payload exceeds allowed invoices limit in a batch. The number of records in the batch is more than the batch size set. The maximum default payload size is 100 records. This value is configurable in the sn_spend_intg.ap.invoice.create.api.record_limit system property. Invalid payload - Error: Empty invoices. No data to process. The number of records in the batch is zero. Rate limit of 500 requests per hour for APO Invoice Ingestion exceeded. User Not Authenticated. Either the password is wrong or user name is wrong. Failed API level ACL Validation - User does not have read/write access to the resource. Data type: String
message	Success message, for example, `Your request has been successfully received and is being processed`. You can view the status of the request in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Data type: String
status	Indicates the result of the request. Possible values: Success Fail Data type: String

cURL request

The following example shows how to process an invoice provided as a request in JSON format.

curl "https://instance.servicenow.com/api/sn_spend_intg/v1/ap_invoice/json" \
--request \
 POST \
--header \
 "Source-System: Coupa" \
--header \
 "Content-Type: application/json" \
--user 'username' \
:'password' \
--data \
 '{
    "invoices": [
        {
            "invoice_type": "non_po_invoice",
            "supplier_invoice_number": "SPOTLIGHT98",
            "external_invoice_number": "SPOTLIGHT98",
            "erp_number": "RTest12345",
            "purchase_order": "R0030R16537",
            "business_owner": "paula.smith@example.com",
            "supplier": "3245545",
            "original_invoice": "SIN188191",
            "invoice_date": "2023-08-15",
            "payment_terms": "Net 30",
            "legal_entity": "1000",
            "subtotal": "100.00",
            "shipping_amount": "50.00",
            "other_charges": "20.00",
            "discounts": "100.00",
            "amount_invoiced": "150.00",
            "currency": "USD",
            "invoice_line_count": "2",
            "ship_to_city": "",
            "ship_to_country": "USA",
            "ship_to_state_or_province": "NY",
            "ship_to_street": "123 Main St",
            "ship_to_zip_or_postal_code": "10001",
            "ship_from_city": "Los Angeles",
            "ship_from_country": "USA",
            "ship_from_state_or_province": "CA",
            "ship_from_street": "456 Oak Ave",
            "ship_from_zip_or_postal_code": "90001",
            "remit_address": "789 Elm St, Suite 200",
            "remit_to_city": "Chicago",
            "remit_to_country": "USA",
            "remit_to_state_or_province": "IL",
            "remit_to_zip_or_postal_code": "60601",
            "bill_to_city": "San Diego",
            "bill_to_country": "USA",
            "bill_to_state_or_province": "CA",
            "bill_to_street": "4810 Eastgate Mall",
            "bill_to_zip_or_postal_code": "92121",
            "supplier_tax_id": "123456789",
            "tax_details": [
                {
                    "tax_type": "Central Goods and Services Tax",
                    "tax_amount": "25",
                    "tax_rate": ""
                },
                {
                    "tax_type": "Sales tax",
                    "tax_amount": "10",
                    "tax_rate": "10"
                },
                {
                    "tax_type": "IGST",
                    "tax_amount": "",
                    "tax_rate": "15"
                },
                {
                    "tax_type": "State Goods and Service Tax",
                    "tax_amount": "20",
                    "tax_rate": "10"
                }
            ],
            "invoice_lines": [
                {
                    "external_invoice_number": "SPOTLIGHT98",
                    "line_description": "Laptop",
                    "line_quantity": "5",
                    "line_unit_price": "20.00",
                    "subtotal": "100.00",
                    "line_amount_invoiced": "100.00",
                    "purchase_order_line": "232432",
                    "po_line_description": "Mac laptop",
                    "currency": "USD",
                    "cost_center": "41605600",
                    "gl_account": "141101",
                    "tax_code": "A0 - Sales tax, standard rate",
                    "ship_to_city": "New York",
                    "ship_to_country": "USA",
                    "ship_to_state_or_province": "NY",
                    "ship_to_street": "123 Main St",
                    "ship_to_zip_or_postal_code": "10001",
                    "supplier_part_number": "SPN-001",
                    "uom": "Hours",
                    "tax_details": [
                        {
                            "tax_type": "Central Goods and Services Tax",
                            "tax_amount": "25",
                            "tax_rate": ""
                        },
                        {
                            "tax_type": "Sales tax",
                            "tax_amount": "",
                            "tax_rate": "10"
                        }
                    ]
                },
                {
                    "external_invoice_number": "SPOTLIGHT98",
                    "line_description": "Charger",
                    "line_quantity": "5",
                    "line_unit_price": "40.00",
                    "subtotal": "200.00",
                    "line_amount_invoiced": "200.00",
                    "purchase_order_line": "232432",
                    "po_line_description": "Mac laptop",
                    "currency": "USD",
                    "cost_center": "41605600",
                    "gl_account": "141101",
                    "tax_code": "A0 - Sales tax, standard rate",
                    "ship_to_city": "New York",
                    "ship_to_country": "USA",
                    "ship_to_state_or_province": "NY",
                    "ship_to_street": "123 Main St",
                    "ship_to_zip_or_postal_code": "10001",
                    "supplier_part_number": "SPN-001",
                    "uom": "Hours",
                    "tax_details": [
                        {
                            "tax_type": "Central Goods and Services Tax",
                            "tax_amount": "25",
                            "tax_rate": ""
                        },
                        {
                            "tax_type": "Sales tax",
                            "tax_amount": "",
                            "tax_rate": "10"
                        }
                    ]
                }
            ]
        }
    ],
    "target_erp": ""
}'

{
    "batchId": "APIINV1729711710733280",
    "status": "Success",
    "message": "Your request has been successfully received and is being processed."
}

AP Invoice – POST sn_spend_intg/ap_invoice/xml

Processes an automated invoice in XML format.

Use the Invoice integration field mappings [sn_spend_intg_invoice_intg_field_mapping] table to determine how the fields are mapped to XML tags.

You can define custom invoice fields for the request body. Use the following flow to add custom fields, map them to target tables, and format them for availability in the payload:

URL format

Versioned URL: /api/sn_spend_intg/v1/ap_invoice/xml

Default URL: /api/sn_spend_intg/ap_invoice/xml

Supported request parameters

Table 13. Path parameters
Name	Description
api_version	Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String

Table 14. Query parameters
Name	Description
None

Table 15. Request body elements (XML)
Path	Description
/Invoice/AmountInvoiced	Total amount of money to be paid to the supplier including tax and shipping charges. Target field: u_amount_invoiced Related table: Invoice Import [sn_spend_intg_imp_invoice]
Invoice/BillToCity	The city to which the invoice is sent. Target field: u_bill_to_city Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/BillToCountry	The country to which the invoice is sent in ISO 3166 format. For example, `US`. Target field: u_bill_to_country Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/BillToStateOrProvince	The state or province to which the invoice is sent. Target field: u_bill_to_state_or_province Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/BillToStreet	The street address to which the invoice is sent. Target field: u_bill_to_street Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/BillToZipOrPostalCode	The zip or postal code to which the invoice is sent. Target field: u_bill_to_zip_or_postal_code
/Invoice/Currency	Required. Currency for subtotal, tax, and shipping. The subtotal, tax, and shipping should be in the same currency. Target field: u_currency Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/DateFormat	Sets the invoice date format from the default YYYY-MM-DD to another supported date format. The date value is set in the InvoiceDate element. Supported date formats: DD MMM YYYY DD MMM, YY DD MMM, YYYY DD MMMM YYYY DD MMMM, YY DD MMMM, YYYY DD-MM-YY DD-MM-YYYY DD-MMM-YY DD-MMM-YYYY DD.MM.YY DD.MM.YYYY DD/MM/YY DD/MM/YYYY dd/mmm/yyyy MM-DD-YY MM-DD-YYYY MM.DD.YY MM.DD.YYYY MM/DD/YY MM/DD/YYYY MMM DD YYYY MMM DD, YY MMM DD, YYYY MMMM DD YYYY MMMM DD, YY MMMM DD, YYYY YY-MM-DD YY.MM.DD YY/MM/DD YYYY-MM-DD (default) YYYY.MM.DD YYYY/MM/DD Note: The MMM format entry represents a month in its first three letters, for example, Aug. The MMMM format entry represents the full month name, for example, August. Target field: u_date_format Related table: Invoice Import [sn_spend_intg_imp_invoice] Default format: YYYY-MM-DD
/Invoice/Discounts	Discounts that are applied toward the invoice. Target field: u_discounts Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/ExternalInvoiceNumber	Invoice number generated from a third-party application. Target field: u_external_invoice_number Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/InvoiceDate	Date on which the customer was invoiced. Use the DateFormat element to add the date in a supported non-default format. Target field: u_invoice_date Related table: Invoice Import [sn_spend_intg_imp_invoice] Default format: YYYY-MM-DD
/Invoice/LegalEntity	Name of the legal entity of the supplier. Located in the Legal Entity [sn_fin_legal_entity] table. Target field: u_legal_entity Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/OtherCharges	Other additional charges associated with the invoice. This is an editable field. Target field: u_other_charges Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/PaymentTerms	The agreed upon time and conditions under which a payment to a supplier is made. For example, `Net 30`. Target field: u_payment_terms Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/RemitAddress	The street address to which the payment is made. Target field: u_remit_address
Invoice/RemitToCity	The city to which the payment is made. Target field: u_remit_to_city
/Invoice/RemitToCountry	The country to which the payment is made in ISO 3166 format. For example, `US`. Target field: u_remit_to_country
/Invoice/RemitToStateOrProvince	The state or province to which the payment is made. Target field: u_remit_to_state_or_province
/Invoice/RemitToZipOrPostalCode	The zip or postal code to which the payment is made. Target field: u_remit_to_zip_or_postal_code
/Invoice/ShipFromCity	City from which the items on the purchase order are shipped. Target field: u_ship_from_city Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/ShipFromCountry	Country from which the items on the purchase order are shipped. Target field: u_ship_from_country Related table: Invoice Line [sn_spend_intg_imp_invoice]
/Invoice/ShipFromStateOrProvince	State from which the items on the purchase order are shipped. Target field: u_ship_from_state_or_province Related table: Invoice Line [sn_spend_intg_imp_invoice]
/Invoice/ShipFromStreet	Street from which the items on the purchase order are shipped. Target field: u_ship_from_street Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/ShipFromZipOrPostalCode	Zip code from which the items on the purchase order are shipped. Target field: u_ship_from_zip_or_postal_code Related table: Invoice Line [sn_spend_intg_imp_invoice]
/Invoice/ShippingAmount	Total shipping cost for the entire purchase. Target field: u_shipping_amount Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/Subtotal	Total amount of money to be paid to the supplier excluding tax and shipping charges. Target field: u_subtotal Related table: Invoice Import [sn_spend_intg_imp_invoice]
/Invoice/Supplier	Identifier for the reseller or supplier that the customer can place orders with. Target field: u_supplier Related table: Invoice Import [sn_spend_intg_imp_invoice]
/InvoiceLine/CostCenter	Account number of the cost center for which the invoice is generated. Listed in the Cost Center [cmn_cost_center] table. Target field: u_cost_center
/InvoiceLine/Currency	Currency for the line item. For example, `USD`. Target field: u_currency Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/GLAccount	Account number of the general ledger (GL) used to generate the invoice. Target field: u_gl_account See also: ERP source Ledger account
/InvoiceLine/LineAmountInvoiced	Total cost, excluding taxes and shipping, that a customer is being invoiced for a given purchase order line. Target field: u_line_amount_invoiced Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/LineDescription	Description of the invoice line. Target field: u_line_description
/InvoiceLine/LineQuantity	Quantity of goods or services that a customer is being invoiced for. Target field: u_line_quantity
/InvoiceLine/LineUnitPrice	Unit price of the line item in the invoice. Target field: u_line_unit_price Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/POLineDescription	Description of the purchase order line for the invoice. Target field: u_po_line_description Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/PurchaseOrderLine	Purchase order number that is provided by the customer for this order. Listed in the Purchase Order [sn_shop_purchase_order] table. Target field: u_purchase_order Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/ShipToCity	City to which the items on the purchase order are shipped. Target field: u_ship_to_city Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/ShipToCountry	Country to which the items on the purchase order are shipped. Target field: u_ship_to_country Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/ShipToStateOrProvince	State or province to which the items on the purchase order are shipped. Target field: u_ship_to_state_or_province
/InvoiceLine/ShipToStreet	Street to which the items on the purchase order are shipped. Target field: u_ship_to_street Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/ShipToZipOrPostalCode	Zip code to which the items on the purchase order are shipped. Target field: u_ship_to_zip_or_postal_code Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/Subtotal	Total amount of money to be paid to the supplier excluding tax and shipping charges. Target field: u_subtotal Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/SupplierPartNumber	Part number that is generated by a supplier for this invoice line. Target field: u_supplier_part_number Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/TaxCode	Unique tax code generated from the ERP source. Target field: u_tax_code Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/InvoiceLine/UOM	Base unit of measure (UOM) used to count the item in the invoice. Target field: u_uom Related table: Invoice Line Import [sn_spend_intg_imp_invoice_line]
/TaxDetail/TaxType	Type of tax applicable on the invoice. Listed in the Tax Type [sn_fin_tax_type] table. Target field: u_tax_type Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line]
/TaxDetail/TaxRate	The tax rate charged by the supplier. Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line] Target field: u_supplier_tax_rate Related table: Invoice Tax Line Import [sn_spend_intg_imp_invoice_tax_line]

Headers

Table 16. Request headers
Header	Description
Content-Type	Data format of the request body. Only supports application/xml.
Source-System	Specifies the source system from which the request is coming from. Available systems are listed in the Source systems credentials [sn_spend_intg_source_system_credential] table. This setting helps to determine if the request provided follows the structure in the Invoice integration field mapping [sn_spend_intg_invoice_intg_field_mapping] table. This setting is also used to fetch credentials from the Source system credentials [sn_spend_intg_source_system_credential] table.

Table 17. Response headers
Header	Description
None

Status codes

The following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see REST API HTTP response codes.

Table 18. Status codes
Status code	Description
202	Request Accepted. The request is successful and invoice processing is in progress.
400	Bad Request. A bad request type or malformed request was detected.
429	Too Many Requests. The request rate has exceeded the maximum of 10 requests per hour.

Response body parameters


Name	Description
batch_id	Unique identifier for the batch request. This ID can be used to track the status of the request. This record is stored in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Data type: String
error	Contains error message and details when the request fails. `{ "detail": String, "message": String }` Data type: Object
error.detail	Additional details about the request error. Possible results: Failed API level ACL Validation - User does not have read/write access to the resource. Rate limit of 13 requests per hour for AP Invoice exceeded – The number of records in the batch is more than the batch size set. Required to provide Auth information - Either the password is wrong or user name is wrong. Data type: String
error.message	Error message containing the reason the request failed Possible errors: Invalid payload - Invalid content type. Invalid payload - Error: Invalid payload structure. Invalid payload - Error: Payload exceeds allowed invoices limit in a batch. The number of records in the batch is more than the batch size set. The maximum default payload size is 100 records. This value is configurable in the sn_spend_intg.ap.invoice.create.api.record_limit system property. Invalid payload - Error: Empty invoices. No data to process. The number of records in the batch is zero. Rate limit of 500 requests per hour for APO Invoice Ingestion exceeded. User Not Authenticated. Either the password is wrong or user name is wrong. Failed API level ACL Validation - User does not have read/write access to the resource. Data type: String
message	Success message, for example, `Your request has been successfully received and is being processed`. You can view the status of the request in the Invoice integration log [sn_spend_intg_invoice_integration_log] table. Data type: String
status	Indicates the result of the request. Possible values: Success Fail Data type: String

cURL request

The following example shows how to process an invoice provided as a request in XML format.

curl -X POST https://instance.servicenow.com/api/sn_spend_intg/v1/ap_invoice/xml \
-H "Source-System: Ariba" \
-H "Content-Type: application/json" \
-d '<Invoices>
    <Invoice>
        <InvoiceType>invoice</InvoiceType>
        <SupplierInvoiceNumber>S-432432425</SupplierInvoiceNumber>
        <ExternalInvoiceNumber>EXT-INV-003</ExternalInvoiceNumber>
        <Supplier>3245545</Supplier>
        <PurchaseOrder>0004511198</PurchaseOrder>
        <BusinessOwner>Paula Smith</BusinessOwner>
        <InvoiceDate>2023-09-02</InvoiceDate>
        <PaymentTerms>Net 60</PaymentTerms>
        <OriginalInvoice></OriginalInvoice>
        <LegalEntity></LegalEntity>
        <Subtotal>23985.00</Subtotal>
        <ShippingAmount>750.00</ShippingAmount>
        <OtherCharges></OtherCharges>
        <Discounts></Discounts>
        <AmountInvoiced>27073.54</AmountInvoiced>
        <Currency>USD</Currency>
        <InvoiceLineCount>2</InvoiceLineCount>
        <ShipToCity>Los Angeles</ShipToCity>
        <ShipToCountry>USA</ShipToCountry>
        <ShipToStateOrProvince>CA</ShipToStateOrProvince>
        <ShipToStreet>456 Oak Ave</ShipToStreet>
        <ShipToZipOrPostalCode>90001</ShipToZipOrPostalCode>
        <ShipFromCity>Addison</ShipFromCity>
        <ShipFromCountry>USA</ShipFromCountry>
        <ShipFromStateOrProvince>TX</ShipFromStateOrProvince>
        <ShipFromStreet>15725 Dallas P</ShipFromStreet>
        <ShipFromZipOrPostalCode>55555</ShipFromZipOrPostalCode>
        <RemitAddress>47 W 11th St</RemitAddress>
        <RemitToCity>New York</RemitToCity>
        <RemitToCountry>USA</RemitToCountry>
        <RemitToStateOrProvince>NY</RemitToStateOrProvince>
        <RemitToZipOrPostalCode>99999</RemitToZipOrPostalCode>
        <BillToStreet>4810 Eastgate Mall</BillToStreet>
        <BillToCity>San Diego</BillToCity>
        <BillToCountry>USA</BillToCountry>
        <BillToStateOrProvince>CA</BillToStateOrProvince>
        <BillToZipOrPostalCode>92121</BillToZipOrPostalCode>
        <SupplierTaxID>7894328742</SupplierTaxID>
        <TaxDetails>
            <TaxDetail>
                <TaxType>CGST</TaxType>
                <TaxAmount></TaxAmount>
                <TaxRate>15</TaxRate>
            </TaxDetail>
            <TaxDetail>
                <TaxType>SGST</TaxType>
                <TaxAmount>100</TaxAmount>
                <TaxRate></TaxRate>
            </TaxDetail>
        </TaxDetails>
        <InvoiceLines>
            <InvoiceLine>
                <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                <LineDescription>NowX Laptop</LineDescription>
                <PurchaseOrderLine></PurchaseOrderLine>
                <LineQuantity>15</LineQuantity>
                <LineUnitPrice>1500.00</LineUnitPrice>
                <Subtotal>22500.00</Subtotal>
                <LineAmountInvoiced>24693.75</LineAmountInvoiced>
                <Currency>USD</Currency>
                <CostCenter></CostCenter>
                <GLAccount></GLAccount>
                <TaxCode></TaxCode>
                <ShipToCity></ShipToCity>
                <ShipToCountry></ShipToCountry>
                <ShipToStateOrProvince></ShipToStateOrProvince>
                <ShipToStreet></ShipToStreet>
                <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                <SupplierPartNumber></SupplierPartNumber>
                <UOM>Individual Unit</UOM>
                <TaxDetails>
                    <TaxDetail>
                        <TaxType>WHTTax</TaxType>
                        <TaxAmount>2193.75</TaxAmount>
                        <TaxRate>9.75</TaxRate>
                    </TaxDetail>
                </TaxDetails>
            </InvoiceLine>
            <InvoiceLine>
                <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                <LineDescription>NowX Charger</LineDescription>
                <PurchaseOrderLine>PO-6789-001</PurchaseOrderLine>
                <LineQuantity>15</LineQuantity>
                <LineUnitPrice>99.00</LineUnitPrice>
                <Subtotal>1485.00</Subtotal>
                <LineAmountInvoiced>1629.79</LineAmountInvoiced>
                <Currency>USD</Currency>
                <CostCenter></CostCenter>
                <GLAccount></GLAccount>
                <TaxCode></TaxCode>
                <ShipToCity></ShipToCity>
                <ShipToCountry></ShipToCountry>
                <ShipToStateOrProvince></ShipToStateOrProvince>
                <ShipToStreet></ShipToStreet>
                <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                <SupplierPartNumber></SupplierPartNumber>
                <UOM>Individual Unit</UOM>
                <TaxDetails>
                    <TaxDetail>
                        <TaxType>GSTTax</TaxType>
                        <TaxAmount>144.79</TaxAmount>
                        <TaxRate>9.75</TaxRate>
                    </TaxDetail>
                    <TaxDetail>
                        <TaxType>CGST</TaxType>
                        <TaxAmount>1000</TaxAmount>
                        <TaxRate>12</TaxRate>
                    </TaxDetail>
                </TaxDetails>
            </InvoiceLine>
        </InvoiceLines>
    </Invoice>
    <Invoice>
        <InvoiceType>invoice</InvoiceType>
        <SupplierInvoiceNumber>S-432432426</SupplierInvoiceNumber>
        <ExternalInvoiceNumber>EXT-INV-006</ExternalInvoiceNumber>
        <Supplier>3245545</Supplier>
        <PurchaseOrder>0004511198</PurchaseOrder>
        <BusinessOwner>Paula Smith</BusinessOwner>
        <InvoiceDate>2023-09-02</InvoiceDate>
        <PaymentTerms>Net 60</PaymentTerms>
        <OriginalInvoice></OriginalInvoice>
        <LegalEntity></LegalEntity>
        <Subtotal>23985.00</Subtotal>
        <ShippingAmount>750.00</ShippingAmount>
        <OtherCharges></OtherCharges>
        <Discounts></Discounts>
        <AmountInvoiced>27073.54</AmountInvoiced>
        <Currency>USD</Currency>
        <InvoiceLineCount>2</InvoiceLineCount>
        <ShipToCity>Los Angeles</ShipToCity>
        <ShipToCountry>USA</ShipToCountry>
        <ShipToStateOrProvince>CA</ShipToStateOrProvince>
        <ShipToStreet>456 Oak Ave</ShipToStreet>
        <ShipToZipOrPostalCode>90001</ShipToZipOrPostalCode>
        <ShipFromCity>Addison</ShipFromCity>
        <ShipFromCountry>USA</ShipFromCountry>
        <ShipFromStateOrProvince>TX</ShipFromStateOrProvince>
        <ShipFromStreet>15725 Dallas P</ShipFromStreet>
        <ShipFromZipOrPostalCode>55555</ShipFromZipOrPostalCode>
        <RemitAddress>47 W 11th St</RemitAddress>
        <RemitToCity>New York</RemitToCity>
        <RemitToCountry>USA</RemitToCountry>
        <RemitToStateOrProvince>NY</RemitToStateOrProvince>
        <RemitToZipOrPostalCode>99999</RemitToZipOrPostalCode>
        <BillToStreet>4810 Eastgate Mall</BillToStreet>
        <BillToCity>San Diego</BillToCity>
        <BillToCountry>USA</BillToCountry>
        <BillToStateOrProvince>CA</BillToStateOrProvince>
        <BillToZipOrPostalCode>92121</BillToZipOrPostalCode>
        <SupplierTaxID>7894328742</SupplierTaxID>
        <TaxDetails>
            <TaxDetail>
                <TaxType>VATTax</TaxType>
                <TaxAmount>2338.54</TaxAmount>
                <TaxRate></TaxRate>
            </TaxDetail>
        </TaxDetails>
        <InvoiceLines>
            <InvoiceLine>
                <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                <LineDescription>NowX Laptop</LineDescription>
                <PurchaseOrderLine></PurchaseOrderLine>
                <LineQuantity>15</LineQuantity>
                <LineUnitPrice>1500.00</LineUnitPrice>
                <Subtotal>22500.00</Subtotal>
                <LineAmountInvoiced>24693.75</LineAmountInvoiced>
                <Currency>USD</Currency>
                <CostCenter></CostCenter>
                <GLAccount></GLAccount>
                <TaxCode></TaxCode>
                <ShipToCity></ShipToCity>
                <ShipToCountry></ShipToCountry>
                <ShipToStateOrProvince></ShipToStateOrProvince>
                <ShipToStreet></ShipToStreet>
                <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                <SupplierPartNumber></SupplierPartNumber>
                <UOM>Individual Unit</UOM>
                <TaxDetails>
                </TaxDetails>
            </InvoiceLine>
            <InvoiceLine>
                <ExternalInvoiceNumber>EXT-INV-002</ExternalInvoiceNumber>
                <LineDescription>NowX Charger</LineDescription>
                <PurchaseOrderLine>PO-6789-001</PurchaseOrderLine>
                <LineQuantity>15</LineQuantity>
                <LineUnitPrice>99.00</LineUnitPrice>
                <Subtotal>1485.00</Subtotal>
                <LineAmountInvoiced>1629.79</LineAmountInvoiced>
                <Currency>USD</Currency>
                <CostCenter></CostCenter>
                <GLAccount></GLAccount>
                <TaxCode></TaxCode>
                <ShipToCity></ShipToCity>
                <ShipToCountry></ShipToCountry>
                <ShipToStateOrProvince></ShipToStateOrProvince>
                <ShipToStreet></ShipToStreet>
                <ShipToZipOrPostalCode></ShipToZipOrPostalCode>
                <SupplierPartNumber></SupplierPartNumber>
                <UOM>Individual Unit</UOM>
                <TaxDetails>
                </TaxDetails>
            </InvoiceLine>
        </InvoiceLines>
    </Invoice>
    <TargetERP>ERP1</TargetERP>
</Invoices>'

{
    "batchId": "APIINV1736249646168148",
    "status": "Success",
    "message": "Your request has been successfully received and is being processed."
}