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": "79d6263b-fabd-45c9-b522-461b626f82f0",
"Standard": "EDI 3.2.0",
"TypeVersion": "3.2.0",
"InstanceIdentifier": "1121313560",
"InvoiceType": "INVOICE",
"MultipleType": null,
"DocumentCreationDatetime": "2024-04-29T13:00:04.8710484+02:00",
"MessageId": "638499924048710484",
"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": 1985.88,
"DocumentTotalInclVAT": 1742.0,
"DocumentTotalVAT": 243.88,
"OrderNumber": 1148769499,
"PurchaseOrder": "1148769499",
"InvoiceDate": "2024-05-04T13:00:04.8710484+02:00",
"InvoiceNumber": "Invoice_Num",
"InvoiceDetails": [
{
"InvoiceDetailRefNo": "afd3f4f3-faf0-4997-97f6-8f42e68ca18d",
"InvoiceRefNo": "79d6263b-fabd-45c9-b522-461b626f82f0",
"LineNumber": 1,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2024-04-29T00:00:00",
"CostPrice": 871.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 992.94,
"TaxFeeType": "VAT",
"TaxAmount": 121.94
},
{
"InvoiceDetailRefNo": "58d29ee7-357f-4c84-bcc9-22ea2a1d3bee",
"InvoiceRefNo": "79d6263b-fabd-45c9-b522-461b626f82f0",
"LineNumber": 2,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2024-04-29T00:00:00",
"CostPrice": 871.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 992.94,
"TaxFeeType": "VAT",
"TaxAmount": 121.94
}
]
}
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": "79d6263b-fabd-45c9-b522-461b626f82f0",
"Standard": "EDI 3.2.0",
"TypeVersion": "3.2.0",
"InstanceIdentifier": "1121313560",
"InvoiceType": "INVOICE",
"MultipleType": null,
"DocumentCreationDatetime": "2024-04-29T13:00:04.8710484+02:00",
"MessageId": "638499924048710484",
"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": 1985.88,
"DocumentTotalInclVAT": 1742.0,
"DocumentTotalVAT": 243.88,
"OrderNumber": 1148769499,
"PurchaseOrder": "1148769499",
"InvoiceDate": "2024-05-04T13:00:04.8710484+02:00",
"InvoiceNumber": "Invoice_Num",
"InvoiceDetails": [
{
"InvoiceDetailRefNo": "afd3f4f3-faf0-4997-97f6-8f42e68ca18d",
"InvoiceRefNo": "79d6263b-fabd-45c9-b522-461b626f82f0",
"LineNumber": 1,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2024-04-29T00:00:00",
"CostPrice": 871.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 992.94,
"TaxFeeType": "VAT",
"TaxAmount": 121.94
},
{
"InvoiceDetailRefNo": "58d29ee7-357f-4c84-bcc9-22ea2a1d3bee",
"InvoiceRefNo": "79d6263b-fabd-45c9-b522-461b626f82f0",
"LineNumber": 2,
"EANNumber": "EANNumber.........20",
"SupplierCode": 863222,
"Quantity": 50.0,
"PackSize": 12.0,
"TaxPercentage": 14.0,
"TaxFeeCategory": "STANDARD",
"UnitOfMeasure": "UnitOfMeasure.....20",
"TransferOfOwnershipDate": "2024-04-29T00:00:00",
"CostPrice": 871.0,
"LanguageISOCode": "LangISO.10",
"Description": "Description...........50",
"NettPrice": 992.94,
"TaxFeeType": "VAT",
"TaxAmount": 121.94
}
]
}