0% found this document useful (0 votes)
12 views

Subscription

billing

Uploaded by

Swarnali Basu
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
12 views

Subscription

billing

Uploaded by

Swarnali Basu
Copyright
© © All Rights Reserved
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 46

{

"openapi": "3.0.2",

"info": {

"title": "Supplier Invoices with Structured Data",

"description": "This inbound service provides functionality for importing


supplier invoices directly to SAP Ariba Central Invoice Management. It
enables you to send structured data to SAP Ariba Central Invoice
Management, which is used to create one or more supplier invoices and
trigger the inbound processing module.",

"version": "1.0.0"

},

"x-sap-shortText": "Create Supplier Invoices with Structured Data",

"security": [

"OAuth2": [

"cim.api.inbound.structured"

],

"servers": [

"url": "https://{subdomain}.eu10.cim.cloud.sap/",

"description": "Production URL",

"variables": {

"subdomain": {

"description": "Use your own tenant name as the subdomain",

"default": "subdomain"

}
],

"externalDocs": {

"url":
"https://help.sap.com/docs/CENTRAL_INVOICE_MANAGEMENT/da931cb8aa
e0453584e3a3765a6fbd4b",

"description": "More information is available on the SAP Help Portal."

},

"tags": [

"name": "Create Supplier Invoices with Structured Data"

],

"paths": {

"/api/cim-create-invoice-structured/v1/": {

"post": {

"summary": "Creates Supplier Invoices.",

"description": "Creates one or more supplier invoices using


structured data.",

"tags": [

"Create Supplier Invoices with Structured Data"

],

"requestBody": {

"description": "The invoice details in JSON format. The information


provided is based on the invoice model published in SAP Ariba Central
Invoice Management.",

"required": true,

"content": {

"multipart/form-data": {

"schema": {

"properties": {

"invoiceN": {
"type": "array",

"items": {

"oneOf": [

"$ref": "#/components/schemas/Invoices"

},

"$ref": "#/components/schemas/Binary-attachment"

},

"examples": {

"Single PO Invoice": {

"value": "--boundary1\r\nContent-Disposition: form-data;


name=\"invoice1\"\r\n\r\n{\r\n \"supplierInvoiceId\": \"12354432\",\r\
n \"origin\": \"04\",\r\n \"purpose\": \"I\",\r\n \"currency\": \"EUR\",\r\
n \"grossAmount\": \"614.80\",\r\n \"documentDate\": \"2023-02-15\",\r\n
\"invoiceReceiptDate\": \"2023-02-17\",\r\n \"documentHeaderText\": \"My
comment\",\r\n \"externalIds\": [\r\n {\r\n \"type\": \"otherId\",\r\n
\"id\": \"ID from another product\"\r\n }\r\n ],\r\n \"paymentInfos\": [\r\
n {\r\n \"netDueDate\": \"2023-05-15\",\r\
n \"paymentReference\": \"dbb5edbc04a4\"\r\n }\r\n ],\r\n \"taxes\":
[\r\n {\r\n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"120.50\"\r\n }\r\n ],\r\n \"attachments\": [\r\n {\r\n
\"documentType\": \"Invoice\",\r\n \"fileName\": \"invoice1.pdf\"\r\n }\
r\n ],\r\n \"poReferences\": [\r\n {\r\
n \"documentNumber\": \"4500024596\",\r\n \"itemNumber\": 10\r\n
}\r\n ]\r\n \"invoiceParties\": [\r\n {\r\n \"role\": \"soldTo\",\r\
n \"name\": \"SAP SE\",\r\n \"providerAddresses\": [\r\n {\r\n
\"postalAddresses\": [\r\n {\r\n \"streetLines\": \"Dietmar-
Hopp-Allee 22\",\r\n \"town\": \"Walldorf\",\r\
n \"region\": \"BW\",\r\n \"postalCode\": \"69190\",\r\n
\"country\": \"DE\",\r\n \"scriptCodeKey\": \"Latn\"\r\n }\r\n
]\r\n }\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DE123456789\"\r\
n }\r\n ]\r\n },\r\n {\r\n \"role\": \"from\",\r\
n \"name\": \"Central Finance DE\",\r\n \"providerAddresses\": [\r\n
{\r\n \"postalAddresses\": [\r\n {\r\
n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\"\r\n
}\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DE234567890\"\r\n
}\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n--boundary1\r\nContent-
Disposition: form-data; name=\"invoice1\"; filename=\"invoice1.pdf\"\r\n\
r\n<invoice1.pdf content>\r\n--boundary1--"

},

"Single PO Invoice with PO references at Line Item level": {

"value": "--boundary1\r\nContent-Disposition: form-data;


name=\"invoice1\"\r\n\r\n{\r\n \"origin\": \"04\",\r\
n \"supplierInvoiceId\": \"12354432\",\r\
n \"receiverSystemId\":\"0LEU10H\",\r\
n \"receicerCompanyCode\": \"1010\",\r\
n \"receiverSupplier\":\"S10300901\",\r\n \"purpose\": \"I\",\r\
n \"currency\": \"EUR\",\r\n \"grossAmount\": \"620.80\",\r\
n \"documentDate\": \"2023-02-15\",\r\n \"invoiceReceiptDate\": \"2023-
02-17\",\r\n \"documentHeaderText\": \"My comment\",\r\
n \"poReferences\": [\r\n {\r\
n \"documentNumber\": \"4600024597\",\r\n \"itemNumber\": 20\r\n
},\r\n {\r\n \"documentNumber\": \"4500024596\",\r\
n \"itemNumber\": 10\r\n }\r\n ]\r\n \"externalIds\": [\r\n {\r\n
\"type\": \"otherId\",\r\n \"id\": \"ID from another product\"\r\n }\r\n
],\r\n \"paymentInfos\": [\r\n {\r\n \"netDueDate\": \"2023-05-15\",\r\n
\"paymentReference\": \"dbb5edbc04a4\"\r\n }\r\n ],\r\n \"taxes\": [\r\n
{\r\n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"121.70\"\r\n }\r\n ],\r\n \"attachments\": [\r\n {\r\n
\"documentType\": \"Invoice\",\r\n \"fileName\": \"invoice1.pdf\"\r\n }\
r\n ],\r\n \"lineItems\": [\r\n {\r\n \"invoiceDocumentItem\": 1,\r\
n \"currency\": \"EUR\",\r\n \"amount\": \"820.80\",\r\
n \"unitPrice\": \"820.80\",\r\n \"description\": \"Drilling machine\",\r\
n \"quantity\": \"1\",\r\n \"externalUnitOfMeasure\": \"PC\",\r\
n \"taxRate\": \"19.6\",\r\n \"taxCountry\": \"DE\",\r\
n \"poReferences\": [\r\n {\r\
n \"documentNumber\": \"4500024596\",\r\n \"itemNumber\":
10\r\n }\r\n ]\r\n },\r\n {\r\n \"invoiceDocumentItem\": 2,\r\n
\"currency\": \"EUR\",\r\n \"amount\": \"-200.00\",\r\n \"unitPrice\": \"-
200.00\",\r\n \"description\": \"Circular saw\",\r\n \"quantity\": \"1\",\
r\n \"externalUnitOfMeasure\": \"PC\",\r\n \"taxRate\": \"19.6\",\r\n
\"taxCountry\": \"DE\",\r\n \"poReferences\": [\r\n {\r\
n \"documentNumber\": \"4600024597\",\r\n \"itemNumber\":
20\r\n }\r\n ]\r\n }\r\n ],\r\n \"invoiceParties\": [\r\n {\r\
n \"role\": \"soldTo\",\r\n \"name\": \"SAP SE\",\r\
n \"providerAddresses\": [\r\n {\r\n \"postalAddresses\": [\r\n
{\r\n \"streetLines\": \"Dietmar-Hopp-Allee 22\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\",\r\n
\"scriptCodeKey\": \"Latn\"\r\n }\r\n ]\r\n }\r\n ],\r\
n \"providerOtherInfos\": [\r\n {\r\n \"domain\": \"vatID\",\r\n
\"value\": \"DE123456789\"\r\n }\r\n ]\r\n },\r\n {\r\
n \"role\": \"from\",\r\n \"name\": \"Central Finance DE\",\r\
n \"providerAddresses\": [\r\n {\r\n \"postalAddresses\": [\r\n
{\r\n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\"\r\n
}\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DE123456789\"\r\n
}\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n--boundary1\r\nContent-
Disposition: form-data; name=\"invoice1\"; filename=\"invoice1.pdf\"\r\n\
r\n<invoice1.pdf content>\r\n--boundary1--"

},

"Single Non PO Invoice": {

"value": "--boundary1\r\nContent-Disposition: form-data;


name=\"invoice1\"\r\n\r\n{\r\n \"origin\": \"04\",\r\
n \"supplierInvoiceId\": \"12354432\",\r\
n \"receiverSystemId\":\"0LEU10H\",\r\
n \"receicerCompanyCode\": \"1010\",\r\
n \"receiverSupplier\":\"S10300901\",\r\n \"purpose\": \"I\",\r\
n \"currency\": \"EUR\",\r\n \"grossAmount\": \"620.80\",\r\
n \"documentDate\": \"2023-02-15\",\r\n \"invoiceReceiptDate\": \"2023-
02-17\",\r\n \"documentHeaderText\": \"My comment\",\r\
n \"externalIds\": [\r\n {\r\n \"type\": \"otherId\",\r\n \"id\": \"ID
from another product\"\r\n }\r\n ],\r\n \"paymentInfos\": [\r\n {\r\n
\"netDueDate\": \"2023-05-15\",\r\
n \"paymentReference\": \"dbb5edbc04a4\"\r\n }\r\n ],\r\n \"taxes\":
[\r\n {\r\n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"121.70\"\r\n }\r\n ],\r\n \"attachments\": [\r\n {\r\n
\"documentType\": \"Invoice\",\r\n \"fileName\": \"invoice1.pdf\"\r\n }\
r\n ],\r\n \"lineItems\": [\r\n {\r\n \"invoiceDocumentItem\": 1,\r\
n \"currency\": \"EUR\",\r\n \"amount\": \"820.80\",\r\
n \"unitPrice\": \"820.80\",\r\n \"description\": \"Drilling machine\",\r\
n \"quantity\": \"1\",\r\n \"externalUnitOfMeasure\": \"PC\",\r\
n \"taxRate\": \"19.6\",\r\n \"taxCountry\": \"DE\"\r\n },\r\n {\r\n
\"invoiceDocumentItem\": 2,\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"-200.00\",\r\n \"unitPrice\": \"-200.00\",\r\
n \"description\": \"Circular saw\",\r\n \"quantity\": \"1\",\r\
n \"externalUnitOfMeasure\": \"PC\",\r\n \"taxRate\": \"19.6\",\r\
n \"taxCountry\": \"DE\"\r\n }\r\n ],\r\n \"invoiceParties\": [\r\n {\r\n
\"role\": \"soldTo\",\r\n \"name\": \"SAP SE\",\r\
n \"providerAddresses\": [\r\n {\r\n \"postalAddresses\": [\r\n
{\r\n \"streetLines\": \"Dietmar-Hopp-Allee 22\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\",\r\n
\"scriptCodeKey\": \"Latn\"\r\n }\r\n ]\r\n }\r\n ],\r\
n \"providerOtherInfos\": [\r\n {\r\n \"domain\": \"vatID\",\r\n
\"value\": \"DE123456789\"\r\n }\r\n ]\r\n },\r\n {\r\
n \"role\": \"from\",\r\n \"name\": \"Central Finance DE\",\r\
n \"providerAddresses\": [\r\n {\r\n \"postalAddresses\": [\r\n
{\r\n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\"\r\n
}\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DE123456789\"\r\n
}\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n--boundary1\r\nContent-
Disposition: form-data; name=\"invoice1\"; filename=\"invoice1.pdf\"\r\n\
r\n<invoice1.pdf content>\r\n--boundary1--"

},

"Single Delivery Note Invoice": {

"value": "--boundary1\r\nContent-Disposition: form-data;


name=\"invoice1\"\r\n\r\n{\r\n \"origin\": \"04\",\r\
n \"supplierInvoiceId\": \"DEMO-FI9876\",\r\
n \"receiverSystemId\":\"0LEU10H\",\r\
n \"receicerCompanyCode\": \"1010\",\r\
n \"receiverSupplier\":\"S10300901\",\r\n \"purpose\": \"I\",\r\
n \"currency\": \"EUR\",\r\n \"grossAmount\": \"3473.98\",\r\
n \"documentDate\": \"2023-02-15\",\r\n \"documentHeaderText\": \"My
comment\",\r\n \"invoiceReceiptDate\": \"2023-02-17\",\r\
n \"externalIds\": [\r\n {\r\n \"type\": \"otherId\",\r\n \"id\": \"ID
from another product\"\r\n }\r\n ],\r\n \"taxes\": [\r\n {\r\
n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"120.50\"\r\n },\r\n {\r\n \"percentage\": \"19.6\",\
r\n \"currency\": \"EUR\",\r\n \"amount\": \"560.40\"\r\n }\r\n ],\r\n
\"paymentInfos\": [\r\n {\r\n \"netDueDate\": \"2023-05-15\",\r\
n \"paymentReference\": \"dbb5edbc04a4\"\r\n }\r\n ],\r\
n \"invoiceParties\": [\r\n {\r\n \"role\": \"soldTo\",\r\
n \"name\": \"SAP SE\",\r\n \"providerAddresses\": [\r\n {\r\n
\"postalAddresses\": [\r\n {\r\n \"streetLines\": \"Dietmar-
Hopp-Allee 22\",\r\n \"town\": \"Walldorf\",\r\
n \"region\": \"BW\",\r\n \"postalCode\": \"69190\",\r\n
\"country\": \"DE\",\r\n \"scriptCodeKey\": \"Latn\"\r\n }\r\n
]\r\n }\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DESAPPUSH01\"\r\
n }\r\n ]\r\n },\r\n {\r\n \"role\": \"from\",\r\
n \"name\": \"Central Finance DE\",\r\n \"providerAddresses\": [\r\n
{\r\n \"postalAddresses\": [\r\n {\r\
n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\",\r\n
\"scriptCodeKey\": \"Latn\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\
r\n ],\r\n \"deliveryNoteReferences\": [\r\n {\r\
n \"deliveryNoteNumber\": \"34354545\"\r\n },\r\n {\r\
n \"deliveryNoteNumber\": \"122324423\"\r\n }\r\n ],\r\
n \"attachments\": [\r\n {\r\n \"fileName\": \"invoice1.pdf\",\r\
n \"documentType\": \"Invoice\"\r\n },\r\n {\r\
n \"fileName\": \"Attachment_DE0000000087.pdf\",\r\
n \"documentType\": \"Others\"\r\n }\r\n ]\r\n}\r\n--boundary1\r\
nContent-Disposition: form-data; name=\"invoice1\";
filename=\"invoice1.pdf\"\r\n\r\n<invoice1.pdf content>\r\n--boundary1--"

},

"Single SES Invoice": {

"value": "--boundary1\r\nContent-Disposition: form-data;


name=\"invoice1\"\r\n\r\n{\r\n \"origin\": \"04\",\r\
n \"supplierInvoiceId\": \"DEMO-FI9876\",\r\
n \"receiverSystemId\":\"0LEU10H\",\r\
n \"receicerCompanyCode\": \"1010\",\r\
n \"receiverSupplier\":\"S10300901\",\r\n \"purpose\": \"I\",\r\
n \"currency\": \"EUR\",\r\n \"grossAmount\": \"3473.98\",\r\
n \"documentDate\": \"2023-02-15\",\r\n \"documentHeaderText\": \"My
comment\",\r\n \"invoiceReceiptDate\": \"2023-02-17\",\r\
n \"externalIds\": [\r\n {\r\n \"type\": \"otherId\",\r\n \"id\": \"ID
from another product\"\r\n }\r\n ],\r\n \"taxes\": [\r\n {\r\
n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"120.50\"\r\n },\r\n {\r\n \"percentage\": \"19.6\",\
r\n \"currency\": \"EUR\",\r\n \"amount\": \"560.40\"\r\n }\r\n ],\r\n
\"paymentInfos\": [\r\n {\r\n \"netDueDate\": \"2023-05-15\",\r\
n \"paymentReference\": \"dbb5edbc04a4\"\r\n }\r\n ],\r\
n \"invoiceParties\": [\r\n {\r\n \"role\": \"soldTo\",\r\
n \"name\": \"SAP SE\",\r\n \"providerAddresses\": [\r\n {\r\n
\"postalAddresses\": [\r\n {\r\n \"streetLines\": \"Dietmar-
Hopp-Allee 22\",\r\n \"town\": \"Walldorf\",\r\
n \"region\": \"BW\",\r\n \"postalCode\": \"69190\",\r\n
\"country\": \"DE\",\r\n \"scriptCodeKey\": \"Latn\"\r\n }\r\n
]\r\n }\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DESAPPUSH01\"\r\
n }\r\n ]\r\n },\r\n {\r\n \"role\": \"from\",\r\
n \"name\": \"Central Finance DE\",\r\n \"providerAddresses\": [\r\n
{\r\n \"postalAddresses\": [\r\n {\r\
n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\",\r\n
\"scriptCodeKey\": \"Latn\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\
r\n ],\r\n \"sesReferences\": [\r\n {\r\
n \"documentNumber\": \"45678\",\r\n \"itemNumber\": 1\r\n },\r\n
{\r\n \"documentNumber\": \"45678\",\r\n \"itemNumber\": 2\r\n }\
r\n ],\r\n \"attachments\": [\r\n {\r\n \"fileName\": \"invoice1.pdf\",\r\
n \"documentType\": \"Invoice\"\r\n }\r\n ]\r\n}\r\n--boundary1\r\
nContent-Disposition: form-data; name=\"invoice1\";
filename=\"invoice1.pdf\"\r\n\r\n<invoice1.pdf content>\r\n--boundary1--"

},

"Multiple Invoices": {

"value": "--boundary1\r\nContent-Disposition: form-data;


name=\"invoice1\"\r\n\r\n{\r\n \"supplierInvoiceId\": \"12354432\",\r\
n \"origin\": \"04\",\r\n \"purpose\": \"I\",\r\n \"currency\": \"EUR\",\r\
n \"grossAmount\": \"614.80\",\r\n \"documentDate\": \"2023-02-15\",\r\n
\"invoiceReceiptDate\": \"2023-02-17\",\r\n \"documentHeaderText\": \"My
comment\",\r\n \"externalIds\": [\r\n {\r\n \"type\": \"otherId\",\r\n
\"id\": \"ID from another product\"\r\n }\r\n ],\r\n \"paymentInfos\": [\r\
n {\r\n \"netDueDate\": \"2023-05-15\",\r\
n \"paymentReference\": \"dbb5edbc04a4\"\r\n }\r\n ],\r\n \"taxes\":
[\r\n {\r\n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"120.50\"\r\n }\r\n ],\r\n \"attachments\": [\r\n {\r\n
\"documentType\": \"Invoice\",\r\n \"fileName\": \"invoice1.pdf\"\r\n }\
r\n ],\r\n \"poReferences\": [\r\n {\r\
n \"documentNumber\": \"4500024596\",\r\n \"itemNumber\": 10\r\n
}\r\n ]\r\n \"invoiceParties\": [\r\n {\r\n \"role\": \"soldTo\",\r\
n \"name\": \"SAP SE\",\r\n \"providerAddresses\": [\r\n {\r\n
\"postalAddresses\": [\r\n {\r\n \"streetLines\": \"Dietmar-
Hopp-Allee 22\",\r\n \"town\": \"Walldorf\",\r\
n \"region\": \"BW\",\r\n \"postalCode\": \"69190\",\r\n
\"country\": \"DE\",\r\n \"scriptCodeKey\": \"Latn\"\r\n }\r\n
]\r\n }\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DE123456789\"\r\
n }\r\n ]\r\n },\r\n {\r\n \"role\": \"from\",\r\
n \"name\": \"Central Finance DE\",\r\n \"providerAddresses\": [\r\n
{\r\n \"postalAddresses\": [\r\n {\r\
n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\"\r\n
}\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DE123456790\"\r\n
}\r\n ]\r\n }\r\n ]\r\n }\r\n ]\r\n}\r\n\r\n--boundary1\r\
nContent-Disposition: form-data; name=\"invoice1\";
filename=\"invoice1.pdf\"\r\n\r\n<invoice1.pdf>\r\n--boundary1\r\
nContent-Disposition: form-data; name=\"invoice2\"\r\n\r\n{\r\n \"origin\":
\"04\",\r\n \"supplierInvoiceId\": \"DEMO-FI9876\",\r\
n \"receiverSystemId\":\"0LEU10H\",\r\
n \"receicerCompanyCode\": \"1010\",\r\
n \"receiverSupplier\":\"S10300901\",\r\n \"purpose\": \"I\",\r\
n \"currency\": \"EUR\",\r\n \"grossAmount\": \"3473.98\",\r\
n \"documentDate\": \"2023-02-15\",\r\n \"documentHeaderText\": \"My
comment\",\r\n \"invoiceReceiptDate\": \"2023-02-17\",\r\
n \"externalIds\": [\r\n {\r\n \"type\": \"otherId\",\r\n \"id\": \"ID
from another product\"\r\n }\r\n ],\r\n \"taxes\": [\r\n {\r\
n \"percentage\": \"19.6\",\r\n \"currency\": \"EUR\",\r\
n \"amount\": \"560.40\"\r\n },\r\n {\r\n \"percentage\": \"19.6\",\
r\n \"currency\": \"EUR\",\r\n \"amount\": \"120.50\"\r\n }\r\n ],\r\n
\"lineItems\": [\r\n {\r\n \"invoiceDocumentItem\": 1,\r\
n \"amount\": \"2859.18\",\r\n \"unitPrice\": \"2859.18\",\r\
n \"currency\": \"EUR\",\r\n \"description\": \"Drilling machine\",\r\n
\"quantity\": \"1\",\r\n \"externalUnitOfMeasure\": \"PC\",\r\
n \"taxRate\": \"19.6\",\r\n \"taxCountry\": \"DE\"\r\n },\r\n {\r\n
\"invoiceDocumentItem\": 2,\r\n \"amount\": \"614.80\",\r\
n \"unitPrice\": \"614.80\",\r\n \"currency\": \"EUR\",\r\
n \"description\": \"Circular saw\",\r\n \"quantity\": \"1\",\r\
n \"externalUnitOfMeasure\": \"PC\",\r\n \"taxRate\": \"19.6\",\r\
n \"taxCountry\": \"DE\"\r\n }\r\n ],\r\n \"paymentInfos\": [\r\n {\r\n
\"netDueDate\": \"2023-05-15\",\r\
n \"paymentReference\": \"dbb5edbc04a5\"\r\n }\r\n ],\r\
n \"invoiceParties\": [\r\n {\r\n \"role\": \"soldTo\",\r\
n \"name\": \"SAP SE\",\r\n \"providerAddresses\": [\r\n {\r\n
\"postalAddresses\": [\r\n {\r\n \"streetLines\": \"Dietmar-
Hopp-Allee 22\",\r\n \"town\": \"Walldorf\",\r\
n \"region\": \"BW\",\r\n \"postalCode\": \"69190\",\r\n
\"country\": \"DE\",\r\n \"scriptCodeKey\": \"Latn\"\r\n }\r\n
]\r\n }\r\n ],\r\n \"providerOtherInfos\": [\r\n {\r\
n \"domain\": \"vatID\",\r\n \"value\": \"DESAPPUSH01\"\r\
n }\r\n ]\r\n },\r\n {\r\n \"role\": \"from\",\r\
n \"name\": \"Central Finance DE\",\r\n \"providerAddresses\": [\r\n
{\r\n \"postalAddresses\": [\r\n {\r\
n \"streetLines\": \"Hauptstrasse 12\",\r\
n \"town\": \"Walldorf\",\r\n \"region\": \"BW\",\r\
n \"postalCode\": \"69190\",\r\n \"country\": \"DE\",\r\n
\"scriptCodeKey\": \"Latn\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\
r\n ],\r\n \"deliveryNoteReferences\": [\r\n {\r\
n \"deliveryNoteNumber\": \"34354545\"\r\n },\r\n {\r\
n \"deliveryNoteNumber\": \"122324423\"\r\n }\r\n ],\r\
n \"attachments\": [\r\n {\r\n \"documentType\": \"Invoice\",\r\
n \"fileName\": \"invoice2.pdf\"\r\n }\r\n ]\r\n}\r\n--boundary1\r\
nContent-Disposition: form-data; name=\"invoice2\";
filename=\"invoice2.pdf\"\r\n\r\n<invoice2.pdf content>\r\n--boundary1--"

},

"responses": {

"200": {

"description": "One or more supplier invoices were created.",

"content": {
"application/json": {

"schema": {

"$ref": "#/components/schemas/CreateInvoiceResponse"

},

"400": {

"description": "Data provided is invalid. For example, missing


mandatory attributes, providing invalid values, providing more than one
attachment with document type as invoice, etc.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/BadRequestError"

},

"401": {

"description": "Unauthorized. Missing authentication information.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/UnauthorizedError"

},

"403": {
"$ref": "#/components/responses/ForbiddenError"

},

"409": {

"description": "More than one supplier invoice has the same


external ID.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/ConflictError"

},

"413": {

"$ref": "#/components/responses/PayloadTooLargeError"

},

"415": {

"$ref": "#/components/responses/UnsupportedMediaTypeError"

},

"429": {

"description": "The staging area is full.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/TooManyRequestsError"

},
"500": {

"$ref": "#/components/responses/InternalServerError"

},

"components": {

"schemas": {

"BadRequestError": {

"type": "object",

"required": [

"error"

],

"additionalProperties": {

"$ref": "#/components/schemas/error"

},

"example": {

"error": {

"code": "ERR_INVALID_INVOICE",

"message": "The invoice is invalid.",

"target": "invoice1",

"details": [

"code": "ERR_INVALID_FORMAT_VALUE_FOR_INVOICE",

"message": "The value '2023-01' of the property documentDate


is invalid for the invoice."

},

{
"code": "ERR_MISSING_MANDATORY_PROPERTY_FOR_INVOICE",

"message": "The mandatory property purpose is missing for the


invoice."

},

"code": "ERR_NOT_SUPPORTED_PURPOSE",

"message": "Error: purpose undefined is not allowed."

},

"Binary-attachment": {

"type": "string",

"format": "binary",

"description": "A binary string representing a file.",

"title": "Binary Attachment"

},

"ConflictError": {

"type": "object",

"required": [

"error"

],

"additionalProperties": {

"$ref": "#/components/schemas/error"

},

"example": {

"error": {

"code": "ERR_ALREADY_IMPORTED_INVOICE",
"message": "In 'ExternalIds', there is already an invoice with 'type'
otherId and the 'id' externalidtest1"

},

"DeliveryNoteReferences": {

"title": "Delivery Note References",

"type": "object",

"properties": {

"deliveryNoteNumber": {

"type": "string",

"maxLength": 16,

"nullable": true,

"description": "Delivery note number",

"example": "122324423"

},

"required": [

"deliveryNoteNumber"

],

"description": "Delivery notes referenced by the invoice (at header or


item level)."

},

"error": {

"type": "object",

"required": [

"error"

],

"properties": {

"error": {
"type": "object",

"required": [

"code",

"message"

],

"properties": {

"code": {

"type": "string"

},

"message": {

"type": "string"

},

"target": {

"type": "string"

},

"details": {

"type": "array",

"items": {

"type": "object",

"required": [

"code",

"message"

],

"properties": {

"code": {

"type": "string"

},

"message": {

"type": "string"
},

"target": {

"type": "string"

},

"innererror": {

"type": "object",

"description": "The structure of this object is service-specific"

},

"title": "Error",

"description": "Error Response"

},

"ExternalIds": {

"title": "External IDs",

"type": "object",

"properties": {

"id": {

"type": "string",

"maxLength": 256,

"nullable": true,

"description": "The external invoice identifier associated with the


type"

},

"type": {
"type": "string",

"maxLength": 40,

"enum": [

"otherId"

],

"example": "otherId",

"description": "otherId is ID of the structured invoice"

},

"required": [

"id",

"type"

],

"description": "Contains all the gathered invoice identifiers used by


the other applications interacting with SAP Ariba Central Invoice
Management."

},

"Invoices": {

"title": "Invoice",

"type": "object",

"properties": {

"origin": {

"type": "string",

"maxLength": 30,

"nullable": true,

"$ref": "#/components/schemas/InvoiceOrigin"

},

"supplierInvoiceId": {

"type": "string",

"maxLength": 16,
"nullable": true,

"description": "Identifier of the invoice provided by the supplier",

"example": "12354432"

},

"purpose": {

"type": "string",

"maxLength": 1,

"nullable": true,

"enum": [

"I",

"C",

"3",

"4"

],

"description": "The transaction type, valid values are: I for Invoice,


C for Credit/Memo, 3 for Subsequent Debit and 4 for Subsequent Credit",

"example": "I"

},

"currency": {

"type": "string",

"maxLength": 3,

"nullable": true,

"description": "Currency of the invoice document (ISO 4217 code)",

"example": "EUR"

},

"grossAmount": {

"anyOf": [

"type": "number",
"format": "decimal",

"multipleOf": 0.000001

},

"type": "string"

],

"example": "110.20",

"x-sap-precision": 22,

"x-sap-scale": 6,

"nullable": true,

"description": "Gross Amount"

},

"documentDate": {

"type": "string",

"format": "date",

"example": "2017-04-13",

"nullable": true,

"description": "Date of the invoice"

},

"invoiceReceiptDate": {

"type": "string",

"format": "date",

"example": "2017-04-13",

"nullable": true,

"description": "Invoice Receipt Date (\"YYYY-MM-DD\")"

},

"documentHeaderText": {

"type": "string",
"maxLength": 25,

"nullable": true,

"description": "Description for the invoice",

"example": "Custom comments"

},

"taxFulfillmentDate": {

"type": "string",

"format": "date",

"example": "2017-04-13",

"nullable": true,

"description": "Tax fulfillment date"

},

"receiverSystemId": {

"type": "string",

"maxLength": 30,

"nullable": true,

"description": "Human-readable ID generated by SAP Ariba Central


Invoice Management",

"example": "0LEU10H"

},

"receiverCompanyCode": {

"type": "string",

"maxLength": 10,

"nullable": true,

"description": "Company code to which the invoice is addressed",

"example": "1010"

},

"receiverSupplier": {

"type": "string",
"maxLength": 10,

"nullable": true,

"description": "Identifier of the supplier on SAP S/4HANA Cloud


backend",

"example": "1003000083"

},

"externalIds": {

"type": "array",

"items": {

"$ref": "#/components/schemas/ExternalIds"

},

"paymentInfos": {

"type": "array",

"items": {

"$ref": "#/components/schemas/PaymentInfos"

},

"taxes": {

"type": "array",

"items": {

"$ref": "#/components/schemas/Taxes"

},

"poReferences": {

"type": "array",

"items": {

"$ref": "#/components/schemas/POReferences"

}
},

"lineItems": {

"type": "array",

"items": {

"$ref": "#/components/schemas/LineItems"

},

"invoiceParties": {

"type": "array",

"items": {

"$ref": "#/components/schemas/InvoiceParties"

},

"attachments": {

"type": "array",

"items": {

"$ref": "#/components/schemas/InvoiceAttachments"

},

"deliveryNoteReferences": {

"type": "array",

"items": {

"$ref": "#/components/schemas/DeliveryNoteReferences"

},

"sesReferences": {

"type": "array",

"items": {

"$ref": "#/components/schemas/SESReferences"
}

},

"required": [

"origin",

"supplierInvoiceId",

"purpose",

"currency",

"grossAmount",

"documentDate",

"invoiceReceiptDate",

"attachments"

},

"InvoiceAttachments": {

"title": "Invoice Attachments",

"type": "object",

"properties": {

"fileName": {

"type": "string",

"maxLength": 255,

"nullable": true,

"description": "Attached document file name",

"example": "Invoice_Attachment.pdf"

},

"documentType": {

"type": "string",

"maxLength": 255,

"nullable": true,
"enum": [

"Invoice",

"Legal",

"Others"

],

"example": "Invoice",

"description": "Must have only one of Invoice, Legal or Others."

},

"isDefault": {

"type": "boolean",

"nullable": true,

"default": false,

"example": true,

"description": "This attribute needs to be set to ‘true’ for the


default document to be displayed in the invoice preview pane of SAP Ariba
Central Invoice Management"

},

"required": [

"fileName",

"documentType"

],

"description": "Supported formats are: PDF, BMP, GIF, JPEG, PNG,


TIFF."

},

"InvoiceOrigin": {

"title": "Invoice Origin",

"type": "string",

"maxLength": 30,

"enum": [
"04"

],

"default": "04",

"description": "Inbound is 04."

},

"InvoiceParties": {

"title": "Invoice Parties",

"type": "object",

"properties": {

"role": {

"type": "string",

"maxLength": 30,

"nullable": true,

"enum": [

"from",

"soldTo"

],

"description": "Supplier is from, Buyer is soldTo.",

"example": "from"

},

"name": {

"type": "string",

"maxLength": 256,

"nullable": true,

"description": "Party name",

"example": "Central Finance DE"

},

"providerAddresses": {

"type": "array",
"items": {

"$ref": "#/components/schemas/PartyAddressData"

},

"providerOtherInfos": {

"type": "array",

"items": {

"$ref": "#/components/schemas/PartyAttributes"

},

"required": [

"role",

"name"

],

"description": "Parties involved in the invoice"

},

"CreateInvoiceResponse": {

"title": "Invoice Response",

"type": "object",

"additionalProperties": {

"$ref": "#/components/schemas/Invoices"

},

"example": {

"invoice1": {

"invoice": {

"receiverSystem": "ABC_123",

"receiverCompanyCode": "1010",

"id": "7874a373-32c5-4a6b-804a-c7c70371c56b",
"receiverCompanyCodeId": "ABC_123/1010",

"origin": "04",

"createdAt": "2022-08-30T08:43:42.322Z",

"modifiedAt": "2022-08-30T08:43:42.322Z",

"invoiceReceiptDate": "2022-08-18"

},

"attachments": [

"id": "cdffb29b-8dc6-4b3c-86fa-4cb5cc84d265",

"invoiceId": "7874a373-32c5-4a6b-804a-c7c70371c56b",

"fileName": "Park_Tax.pdf",

"contentType": "application/pdf",

"createdAt": "2022-08-30T08:43:42.341Z",

"modifiedAt": "2022-08-30T08:43:42.341Z",

"documentType": "Invoice",

"fileSize": 169217,

"contentHash":
"{sha256}feb5bc320a0a64cd332aa8258956f235a2c0d94277954bfb42f8a
c38a7471d5e"

},

"LineItems": {

"title": "Line Items",

"type": "object",

"properties": {

"invoiceDocumentItem": {

"type": "integer",
"format": "int32",

"nullable": true,

"description": "Line item number. If no number is provided for a


particular line item, all the line items will be re-numbered sequentially
according to the order in which they are sent in the payload.",

"example": "1"

},

"currency": {

"type": "string",

"maxLength": 3,

"nullable": true,

"description": "Currency used for the line item (ISO 4217 code)",

"example": "EUR"

},

"amount": {

"anyOf": [

"type": "number",

"format": "decimal",

"multipleOf": 0.000001

},

"type": "string"

],

"example": "500.80",

"x-sap-precision": 22,

"x-sap-scale": 6,

"nullable": true,

"description": "Amount of the line item"


},

"externalUnitOfMeasure": {

"type": "string",

"maxLength": 30,

"nullable": true,

"description": "The unit of measure of the line item",

"example": "KG"

},

"unitPrice": {

"anyOf": [

"type": "number",

"format": "decimal",

"multipleOf": 0.000001

},

"type": "string"

],

"example": "30.5",

"x-sap-precision": 22,

"x-sap-scale": 6,

"nullable": true,

"description": "The unit price of the line item"

},

"quantity": {

"anyOf": [

"type": "number",
"format": "decimal",

"multipleOf": 0.001,

"maximum": 9999999999.999,

"minimum": -9999999999.999

},

"type": "string"

],

"example": "5",

"x-sap-precision": 13,

"x-sap-scale": 3,

"nullable": true,

"description": "The quantity of the line item"

},

"description": {

"type": "string",

"maxLength": 5000,

"nullable": true,

"description": "Item description",

"example": "Drilling machine"

},

"taxRate": {

"anyOf": [

"type": "number",

"format": "decimal",

"multipleOf": 0.000001

},
{

"type": "string"

],

"example": "19.6",

"x-sap-precision": 22,

"x-sap-scale": 6,

"nullable": true,

"description": "Percentage of tax applied on the line item"

},

"taxCountry": {

"type": "string",

"maxLength": 2,

"nullable": true,

"description": "The ISO 3166 alpha-2 code of the country where


the tax is due",

"example": "DE"

},

"poReferences": {

"type": "array",

"items": {

"$ref": "#/components/schemas/POReferences"

},

"deliveryNoteReferences": {

"type": "array",

"items": {

"$ref": "#/components/schemas/DeliveryNoteReferences"

}
},

"sesReferences": {

"type": "array",

"items": {

"$ref": "#/components/schemas/SESReferences"

},

"required": [

"currency",

"amount",

"externalUnitOfMeasure",

"unitPrice",

"quantity",

"description"

],

"description": "Invoice line items"

},

"PartyAddressData": {

"title": "Party Address Data",

"type": "object",

"properties": {

"postalAddresses": {

"type": "array",

"items": {

"$ref": "#/components/schemas/ScriptedPostalAddresses"

},
"required": [

"id"

],

"description": "Party address data"

},

"PartyAttributes": {

"title": "Party Attributes",

"type": "object",

"properties": {

"domain": {

"type": "string",

"maxLength": 30,

"description": "Possible domains:\n\n* network: Legal e-Invoices


Network\n\n* participantID: Network Participant Identifier\n\n* vatID:
Value-added tax identification number",

"example": "vatID"

},

"value": {

"type": "string",

"maxLength": 5000,

"nullable": true,

"description": "Attribute value",

"example": "sap vat id"

},

"required": [

"domain",

"value"

],
"description": "Non-sensitive additional attributes of this invoice
party"

},

"PaymentInfos": {

"title": "Payment Infos",

"type": "object",

"properties": {

"netDueDate": {

"type": "string",

"format": "date",

"example": "2017-04-13",

"nullable": true,

"description": "Net due date"

},

"paymentReference": {

"type": "string",

"maxLength": 30,

"nullable": true,

"description": "Payment reference"

},

"required": [

"id"

],

"description": "Payment information split by supplier"

},

"POReferences": {

"title": "PO References",

"type": "object",
"properties": {

"documentNumber": {

"type": "string",

"maxLength": 10,

"nullable": true,

"description": "Identifier used on the actual purchase order


document",

"example": "34354545"

},

"itemNumber": {

"type": "integer",

"format": "int32",

"nullable": true,

"description": "Item number of the referenced PO",

"example": "1"

},

"required": [

"documentNumber"

],

"description": "Purchase orders referenced by this invoice (at header


or item level)."

},

"ScriptedPostalAddresses": {

"title": "Scripted Postal Addresses",

"type": "object",

"properties": {

"scriptCodeKey": {

"type": "string",

"maxLength": 4,
"nullable": true,

"description": "4 letter script code from ISO 15924",

"example": "Latn"

},

"streetLines": {

"type": "string",

"maxLength": 5000,

"nullable": true,

"description": "Street name, street number",

"example": "Dietmar-Hopp-Allee 22"

},

"town": {

"type": "string",

"maxLength": 5000,

"nullable": true,

"description": "Town",

"example": "Toronto"

},

"region": {

"type": "string",

"maxLength": 3,

"nullable": true,

"description": "Region (State, Province, County)",

"example": "ON"

},

"postalCode": {

"type": "string",

"maxLength": 10,

"nullable": true,
"description": "Postal code",

"example": "M3C-0H9"

},

"country": {

"type": "string",

"maxLength": 2,

"nullable": true,

"description": "The ISO 3166 alpha-2 code of the country",

"example": "CA"

},

"required": [

"scriptCodeKey",

"town",

"country"

],

"description": "Postal addresses of the invoicing party."

},

"SESReferences": {

"title": "SES References",

"type": "object",

"properties": {

"documentNumber": {

"type": "string",

"maxLength": 10,

"nullable": true,

"description": "Identifier used on the actual service entry sheet


document.",

"example": "45678"
},

"itemNumber": {

"type": "integer",

"format": "int32",

"nullable": true,

"description": "Item number of the referenced service entry


sheet.",

"example": "2"

},

"required": [

"documentNumber"

],

"description": "Service entry sheets referenced by this invoice (at


header or item level)."

},

"Taxes": {

"title": "Taxes",

"type": "object",

"properties": {

"percentage": {

"anyOf": [

"type": "number",

"format": "decimal",

"multipleOf": 0.000001

},

"type": "string"

}
],

"example": "19.6",

"x-sap-precision": 22,

"x-sap-scale": 6,

"nullable": true,

"description": "Tax percentage"

},

"currency": {

"type": "string",

"maxLength": 3,

"nullable": true,

"description": "Currency of the tax amount (ISO 4217 code)",

"example": "EUR"

},

"amount": {

"anyOf": [

"type": "number",

"format": "decimal",

"multipleOf": 0.000001

},

"type": "string"

],

"example": "57.20",

"x-sap-precision": 22,

"x-sap-scale": 6,

"nullable": true,
"description": "Tax amount"

},

"description": {

"type": "string",

"maxLength": 5000,

"nullable": true,

"description": "Description of the tax",

"example": "Value added tax"

},

"required": [

"id"

],

"description": "Invoice Taxes: percentage or (amount and currency) is


mandatory",

"example": {

"percentage": "19.6",

"currency": "EUR",

"amount": "120.50"

},

"TooManyRequestsError": {

"type": "object",

"required": [

"error"

],

"additionalProperties": {

"$ref": "#/components/schemas/error"

},
"example": {

"error": {

"message": "The system is processing multiple invoice creation


requests. Please wait a few minutes for attachments to be processed."

},

"UnauthorizedError": {

"type": "object",

"required": [

"error"

],

"additionalProperties": {

"$ref": "#/components/schemas/error"

},

"example": {

"error": {

"message": "Unauthorized."

},

"responses": {

"error": {

"description": "Error",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"
}

},

"BadRequestError": {

"description": "Bad request.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},

"UnauthorizedError": {

"description": "Unauthorized.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},

"ForbiddenError": {

"description": "Access denied. You do not have the required


permissions to access the resource.",

"content": {

"application/json": {
"schema": {

"$ref": "#/components/schemas/error"

},

"ConflictError": {

"description": "Conflict.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},

"PayloadTooLargeError": {

"description": "The request payload is too large.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},

"UnsupportedMediaTypeError": {

"description": "(Unsupported media type) - multipart/form-data


required.",
"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},

"TooManyRequestsError": {

"description": "The staging area is full.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},

"InternalServerError": {

"description": "Internal server error.",

"content": {

"application/json": {

"schema": {

"$ref": "#/components/schemas/error"

},
"securitySchemes": {

"OAuth2": {

"type": "oauth2",

"flows": {

"clientCredentials": {

"tokenUrl":
"https://{subdomain}.authentication.eu10.hana.ondemand.com/oauth/tok
en",

"scopes": {

"cim.api.inbound.structured": "Access to inbound API with


structured data from Inbound or Email"

},

"x-sap-api-type": "REST"

You might also like