POST B2BInvoice
Accepts an invoice record for a given Supplier. Used by Invoice Capture Screens as part of B2B project.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userName |
Username for Account to be used for Authentication/Authorization |
string |
Required |
| password |
Password for Account to be used for Authentication/Authorization |
string |
Required |
| internalUser | boolean |
Default value is False |
Body Parameters
Invoice to Insert
InvoiceHeaderViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| HeaderVersion | string |
String length: inclusive between 0 and 50 |
|
| SenderEAN | string |
String length: inclusive between 0 and 15 |
|
| ReceiverEAN | string |
String length: inclusive between 0 and 15 |
|
| InvoiceRefNo | globally unique identifier |
None. |
|
| Standard | string |
String length: inclusive between 0 and 50 |
|
| TypeVersion | string |
String length: inclusive between 0 and 50 |
|
| InstanceIdentifier | string |
String length: inclusive between 0 and 50 |
|
| InvoiceType | string |
String length: inclusive between 0 and 50 |
|
| MultipleType | string |
String length: inclusive between 0 and 50 |
|
| DocumentCreationDatetime | date |
None. |
|
| MessageId | string |
String length: inclusive between 0 and 50 |
|
| ContentOwnerGLN | string |
String length: inclusive between 0 and 20 |
|
| CommandType | string |
String length: inclusive between 0 and 50 |
|
| CommandOwnerGLN | string |
String length: inclusive between 0 and 20 |
|
| DocumentStatus | string |
String length: inclusive between 0 and 50 |
|
| ContentVersion | string |
String length: inclusive between 0 and 10 |
|
| DocumentVersion | string |
String length: inclusive between 0 and 10 |
|
| DocumentNumber | string |
String length: inclusive between 0 and 50 |
|
| CurrencyISOCode | string |
String length: inclusive between 0 and 10 |
|
| Type | string |
String length: inclusive between 0 and 50 |
|
| CountryISOCode | string |
String length: inclusive between 0 and 10 |
|
| BuyerGLN | string |
String length: inclusive between 0 and 20 |
|
| SellerGLN | string |
String length: inclusive between 0 and 20 |
|
| ShipToGLN | string |
String length: inclusive between 0 and 20 |
|
| VATRegistrationNumber | string |
String length: inclusive between 0 and 20 |
|
| DocumentTotalExVAT | decimal number |
None. |
|
| DocumentTotalInclVAT | decimal number |
None. |
|
| DocumentTotalVAT | decimal number |
None. |
|
| OrderNumber | integer |
None. |
|
| PurchaseOrder | string |
String length: inclusive between 0 and 25 |
|
| InvoiceDate | date |
None. |
|
| InvoiceNumber | string |
String length: inclusive between 0 and 20 |
|
| InvoiceDetails | Collection of InvoiceDetailLineViewModel |
None. |
Request Formats
application/json, text/json
{
"HeaderVersion": "3.2.0",
"SenderEAN": "70564",
"ReceiverEAN": "6001001018104",
"InvoiceRefNo": "192030d0-64be-4f1e-9d37-5058151bdb29",
"Standard": "EDI 3.2.0",
"TypeVersion": "3.2.0",
"InstanceIdentifier": "-373959931",
"InvoiceType": "INVOICE",
"MultipleType": null,
"DocumentCreationDatetime": "2025-06-27T14:42:45.8373773+02:00",
"MessageId": "638866321658373773",
"ContentOwnerGLN": "Supplier GLN",
"CommandType": "ADD",
"CommandOwnerGLN": "Supplier GLN",
"DocumentStatus": "ORIGINAL",
"ContentVersion": "3.2.0",
"DocumentVersion": "1.0",
"DocumentNumber": "DocNum",
"CurrencyISOCode": "ZAR",
"Type": "Invoice",
"CountryISOCode": "ZA",
"BuyerGLN": "6001001018104",
"SellerGLN": "Supplier GLN",
"ShipToGLN": "6001001018104",
"VATRegistrationNumber": "VAT Reg No",
"DocumentTotalExVAT": 1908.36,
"DocumentTotalInclVAT": 1674.0,
"DocumentTotalVAT": 234.36,
"OrderNumber": 1176188805,
"PurchaseOrder": "1176188805",
"InvoiceDate": "2025-07-02T14:42:45.8373773+02:00",
"InvoiceNumber": "Invoice_Num",
"InvoiceDetails": [
{
"InvoiceDetailRefNo": "13e75241-d1be-486f-8d3a-fac9389c1b43",
"InvoiceRefNo": "192030d0-64be-4f1e-9d37-5058151bdb29",
"LineNumber": 1,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2025-06-27T00:00:00",
"CostPrice": 837.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 954.18,
"TaxFeeType": "VAT",
"TaxAmount": 117.18
},
{
"InvoiceDetailRefNo": "4d925ae8-542f-4988-b33f-4ceb0532daaf",
"InvoiceRefNo": "192030d0-64be-4f1e-9d37-5058151bdb29",
"LineNumber": 2,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2025-06-27T00:00:00",
"CostPrice": 837.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 954.18,
"TaxFeeType": "VAT",
"TaxAmount": 117.18
}
]
}
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
An invoice record with an HTTP 200, or null with the relevant HTTP error code.
InvoiceHeaderViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| HeaderVersion | string |
String length: inclusive between 0 and 50 |
|
| SenderEAN | string |
String length: inclusive between 0 and 15 |
|
| ReceiverEAN | string |
String length: inclusive between 0 and 15 |
|
| InvoiceRefNo | globally unique identifier |
None. |
|
| Standard | string |
String length: inclusive between 0 and 50 |
|
| TypeVersion | string |
String length: inclusive between 0 and 50 |
|
| InstanceIdentifier | string |
String length: inclusive between 0 and 50 |
|
| InvoiceType | string |
String length: inclusive between 0 and 50 |
|
| MultipleType | string |
String length: inclusive between 0 and 50 |
|
| DocumentCreationDatetime | date |
None. |
|
| MessageId | string |
String length: inclusive between 0 and 50 |
|
| ContentOwnerGLN | string |
String length: inclusive between 0 and 20 |
|
| CommandType | string |
String length: inclusive between 0 and 50 |
|
| CommandOwnerGLN | string |
String length: inclusive between 0 and 20 |
|
| DocumentStatus | string |
String length: inclusive between 0 and 50 |
|
| ContentVersion | string |
String length: inclusive between 0 and 10 |
|
| DocumentVersion | string |
String length: inclusive between 0 and 10 |
|
| DocumentNumber | string |
String length: inclusive between 0 and 50 |
|
| CurrencyISOCode | string |
String length: inclusive between 0 and 10 |
|
| Type | string |
String length: inclusive between 0 and 50 |
|
| CountryISOCode | string |
String length: inclusive between 0 and 10 |
|
| BuyerGLN | string |
String length: inclusive between 0 and 20 |
|
| SellerGLN | string |
String length: inclusive between 0 and 20 |
|
| ShipToGLN | string |
String length: inclusive between 0 and 20 |
|
| VATRegistrationNumber | string |
String length: inclusive between 0 and 20 |
|
| DocumentTotalExVAT | decimal number |
None. |
|
| DocumentTotalInclVAT | decimal number |
None. |
|
| DocumentTotalVAT | decimal number |
None. |
|
| OrderNumber | integer |
None. |
|
| PurchaseOrder | string |
String length: inclusive between 0 and 25 |
|
| InvoiceDate | date |
None. |
|
| InvoiceNumber | string |
String length: inclusive between 0 and 20 |
|
| InvoiceDetails | Collection of InvoiceDetailLineViewModel |
None. |
Response Formats
application/json, text/json
{
"HeaderVersion": "3.2.0",
"SenderEAN": "70564",
"ReceiverEAN": "6001001018104",
"InvoiceRefNo": "192030d0-64be-4f1e-9d37-5058151bdb29",
"Standard": "EDI 3.2.0",
"TypeVersion": "3.2.0",
"InstanceIdentifier": "-373959931",
"InvoiceType": "INVOICE",
"MultipleType": null,
"DocumentCreationDatetime": "2025-06-27T14:42:45.8373773+02:00",
"MessageId": "638866321658373773",
"ContentOwnerGLN": "Supplier GLN",
"CommandType": "ADD",
"CommandOwnerGLN": "Supplier GLN",
"DocumentStatus": "ORIGINAL",
"ContentVersion": "3.2.0",
"DocumentVersion": "1.0",
"DocumentNumber": "DocNum",
"CurrencyISOCode": "ZAR",
"Type": "Invoice",
"CountryISOCode": "ZA",
"BuyerGLN": "6001001018104",
"SellerGLN": "Supplier GLN",
"ShipToGLN": "6001001018104",
"VATRegistrationNumber": "VAT Reg No",
"DocumentTotalExVAT": 1908.36,
"DocumentTotalInclVAT": 1674.0,
"DocumentTotalVAT": 234.36,
"OrderNumber": 1176188805,
"PurchaseOrder": "1176188805",
"InvoiceDate": "2025-07-02T14:42:45.8373773+02:00",
"InvoiceNumber": "Invoice_Num",
"InvoiceDetails": [
{
"InvoiceDetailRefNo": "13e75241-d1be-486f-8d3a-fac9389c1b43",
"InvoiceRefNo": "192030d0-64be-4f1e-9d37-5058151bdb29",
"LineNumber": 1,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2025-06-27T00:00:00",
"CostPrice": 837.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 954.18,
"TaxFeeType": "VAT",
"TaxAmount": 117.18
},
{
"InvoiceDetailRefNo": "4d925ae8-542f-4988-b33f-4ceb0532daaf",
"InvoiceRefNo": "192030d0-64be-4f1e-9d37-5058151bdb29",
"LineNumber": 2,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2025-06-27T00:00:00",
"CostPrice": 837.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 954.18,
"TaxFeeType": "VAT",
"TaxAmount": 117.18
}
]
}