JSON Schema
OpenAPI Spec (POST)
OpenAPI Spec (GET)
Sample Payload
{
"invoice": {
"typeCode": "380",
"invoiceHeader": {
"identifier": "123456",
"documentIdentifierSet": {
"identifier": [
{
"content": "2130948342",
"typeCode": "UUID"
}
]
},
"documentDateTime": "2020-08-10T15:00:00-04:00",
"note": "We need this paid ASAP.",
"documentReference": [
{
"identifier": {
"content": "2130948342",
"typeCode": "string"
},
"typeCode": "dispatch advice",
"documentDateTime": "2020-03-20T12:50:45.456+00:00"
}
],
"status": {
"code": "New",
"reasonCode": "NA",
"reason": "NA",
"effectiveTimePeriod": {
"startDateTime": "2021-03-18T00:24:29.981Z",
"endDateTime": "2021-03-18T00:24:29.981Z"
}
},
"totalAmount": {
"content": 0,
"currencyCode": "AED"
},
"supplierParty": {
"identifier": {
"content": "string",
"schemeIdentifier": "string",
"typeCode": "string"
},
"taxIdentifier": [
{
"content": "string",
"typeCode": "Federal"
}
],
"name": [
{
"content": "SmallSupplierA",
"typeCode": "string"
}
],
"location": {
"postalAddress": {
"addressLine": [
"string"
],
"cityName": "string",
"countrySubDivisionCode": "string",
"countryCode": "string",
"postalCode": "string"
}
},
"contact": [
{
"personName": [
{
"formattedName": "string"
}
],
"roleCode": "string",
"jobTitle": "string",
"responsibility": "string",
"organizationUnitIdentifier": "string",
"telephoneCommunication": [
{
"identifier": [
{
"content": "string",
"typeCode": "string"
}
]
}
],
"emailAddressCommunication": [
{
"identifier": "string"
}
],
"internetAddressCommunication": {
"useCode": "string",
"webAddressUri": "http://www.supplierName.com"
}
}
]
},
"customerParty": {
"identifier": {
"content": "58885",
"schemeIdentifier": "string",
"typeCode": "string"
},
"dunsid": "3434343",
"accountIdentifier": [
"58885"
],
"name": {
"content": "string",
"typeCode": "string"
},
"location": [
{
"postalAddress": [
{
"addressLine": [
"string"
],
"cityName": "string",
"countrySubDivisionCode": [
"string"
],
"countryCode": "string",
"postalCode": "string"
}
]
}
],
"contact": [
{
"personName": [
{
"formattedName": "string"
}
],
"telephoneCommunication": [
{
"identifier": [
"string"
]
}
],
"emailAddressCommunication": [
{
"identifier": [
"string"
]
}
]
}
],
"buyerContact": {
"identifier": "string",
"personName": [
{
"formattedName": "string"
}
],
"jobTitle": "string",
"organizationUnitIdentifier": "string",
"telephoneCommunication": [
{
"identifier": [
"string"
]
}
],
"emailAddressCommunication": [
{
"identifier": [
"string"
]
}
],
"preference": {
"note": [
"string"
]
}
}
},
"remitToParty": {
"identifier": [
{
"content": "string",
"schemeIdentifier": "string",
"typeCode": "string"
}
],
"name": [
"string"
],
"location": [
{
"postalAddress": [
{
"addressLine": [
"string"
],
"cityName": "string",
"countrySubDivisionCode": "string",
"countryCode": "string",
"postalCode": "string"
}
]
}
],
"contact": [
{
"personName": [
{
"formattedName": "string"
}
],
"telephoneCommunication": [
{
"identifier": [
"string"
]
}
],
"emailAddressCommunication": [
{
"identifier": [
"string"
]
}
]
}
]
},
"shipToParty": [
{
"identifier": [
"58885"
],
"name": [
"Happy Dairy Farm"
],
"location": [
{
"identifier": [
{
"content": "Location1232321",
"schemeIdentifier": "string"
}
],
"coordinate": [
{}
],
"postalAddress": [
{
"addressLine": [
"string"
],
"cityName": "string",
"countrySubDivisionCode": [
"string"
],
"countryCode": "string",
"postalCode": "string"
}
],
"physicalAddress": [
{
"addressLine": [
"12345 Co Hwy 8"
],
"countrySubDivisionCode": [
{
"typeCode": "State"
}
]
}
],
"glnid": "123456789"
}
],
"contact": [
{
"typeCode": "Owner",
"personName": [
{}
],
"telephoneCommunication": [
{
"typeCode": "Mobile",
"identifier": [
null,
"01.507.555.1234"
]
}
],
"emailAddressCommunication": [
{
"identifier": [
null,
"mabel.e.farmer@emailaddress.com"
]
}
]
}
]
}
],
"billToParty": {
"identifier": {
"content": "125484",
"schemeIdentifier": "string",
"typeCode": "string"
},
"accountIdentifier": [
"1232323"
],
"name": [
{
"content": "Mary's Accounting Services",
"typeCode": "string"
}
],
"location": [
{
"postalAddress": [
{
"addressLine": [
"string"
],
"cityName": "string",
"countrySubDivisionCode": [
"string"
],
"countryCode": "string",
"postalCode": "string"
}
]
}
],
"contact": [
{
"personName": [
{
"formattedName": "string"
}
],
"telephoneCommunication": [
{
"identifier": [
"string"
]
}
],
"emailAddressCommunication": [
{
"identifier": [
"string"
]
}
]
}
],
"buyerContact": {
"identifier": [
"string"
]
}
},
"purchaseOrderReference": {
"identifier": {
"content": "123232",
"typeCode": "string"
},
"documentIdentifierSet": {
"identifier": [
{
"content": "5yt643095485454",
"typeCode": "Supplier Order Number"
}
]
},
"typeCode": "DirectShip",
"documentDateTime": "2021-02-22T14:57:01-05:00",
"note": [
"Urgent Need for 1800 lbs"
],
"status": [
{
"typeCode": "Open"
}
]
},
"contractReference": {
"identifier": "contract123232",
"status": [
{
"effectiveTimePeriod": {
"startDateTime": "2021-03-18T00:24:29.982Z",
"endDateTime": "2021-03-18T00:24:29.982Z"
}
}
]
},
"payment": {
"identifier": [
{
"content": "string",
"schemeIdentifier": "string"
}
],
"note": [
"string"
],
"paymentTerm": {
"description": "string",
"dueDateTime": "2021-03-18T00:24:29.982Z"
},
"extension": [
{}
]
},
"tax": [
{
"typeCode": "Sales",
"taxJurisdicationCodes": {
"code": "string"
},
"basisAmount": 0,
"calculation": {
"rateNumber": 0
},
"exemption": {
"typeCode": "string",
"description": [
"string"
]
},
"amount": {
"content": 549.3551,
"currencyCode": "USD"
}
}
],
"distribution": [
{
"amount": {
"content": 0,
"currencyCode": "string"
},
"enterpriseUnit": {
"costCenterIdentifier": "string"
},
"projectReference": {
"identifier": [
"string"
]
}
}
],
"charge": [
{
"basisAmount": 0,
"amount": 0,
"calculation": {
"rateNumber": 0
},
"reasonCode": [
{
"content": "string",
"typeCode": "string"
}
]
}
],
"allowance": [
{
"basisAmount": 0,
"amount": 0,
"calculation": {
"rateNumber": 0
},
"reasonCode": [
{
"content": "string",
"typeCode": "string"
}
]
}
],
"transportationTerm": {
"freightTermCode": "DLV"
},
"extension": [
{
"dateTime": [
{
"content": "2021-03-04T08:00:00-05:00",
"typeCode": "Requested Delivery Date"
}
],
"text": [
{
"content": "string",
"typeCode": "string"
}
],
"currencyCode": [
{
"content": "CAD",
"listIdentifier": "Tax"
}
],
"paymentMethod": [
{
"typeCode": "string",
"identifier": [
"string"
],
"creditCard": {},
"debitCard": {},
"electronicFundsTransfer": {
"typeCode": "string",
"identifier": [
{
"content": "string",
"typeCode": "string"
}
],
"nameOnAccount": "string",
"routingNumberIdentifier": "string"
}
}
]
}
]
},
"invoiceLine": [
{
"lineNumberIdentifier": "1",
"note": [
"string"
],
"documentReference": [
{
"identifier": {
"content": "string",
"typeCode": "string"
}
}
],
"status": [
{
"effectiveTimePeriod": {
"startDateTime": "2021-03-18T00:24:29.982Z",
"endDateTime": "2021-03-18T00:24:29.982Z"
}
}
],
"item": {
"identifier": {
"content": "string",
"schemeIdentifier": "string"
},
"customerItemIdentification": {
"identifier": "091818"
},
"manufacturerItemIdentification": {
"identifier": {
"content": "1213579",
"typeCode": "SKU"
}
},
"supplierItemIdentification": {
"identifier": {
"content": "1213579",
"typeCode": "SKU"
}
},
"upcid": "NA",
"epcid": "NA",
"description": [
"Custom Feed Blend - Derived from Milk Max Plus Basic"
],
"classification": [
{
"codes": {
"code": [
{
"content": "string",
"listIdentifier": "string",
"listVersionIdentifier": "string"
}
]
}
}
],
"countryOfOriginCode": "string"
},
"itemInstance": [
{
"serialNumberIdentifier": [
"string"
],
"lot": [
{
"identifier": [
"string"
]
}
]
}
],
"quantity": [
{
"content": 2000,
"unitCode": "LB",
"typeCode": "string"
}
],
"unitPrice": {
"basisQuantity": {
"content": 1,
"unitCode": "LB"
},
"unitAmount": {
"content": 3.6502,
"currencyCode": "USD"
}
},
"purchaseOrderReference": [
{
"lineNumberIdentifier": "string"
}
],
"buyerParty": {
"accountIdentifier": [
"string"
]
},
"extendedAmount": {
"content": 7300.4,
"currencyCode": "USD"
},
"totalAmount": {
"content": 7849.7551,
"currencyCode": "USD"
},
"tax": [
{
"taxJurisdicationCodes": {},
"calculation": {},
"amount": {
"content": 549.3551,
"currencyCode": "USD"
},
"currencyExchangeRate": {}
}
],
"distributeTax": [
{
"identifier": {
"content": "string",
"schemeIdentifier": "string"
},
"taxJurisdicationCodes": {
"code": [
{
"content": "string",
"typeCode": "string"
}
]
},
"amount": 0
}
],
"invoiceCharge": [
{
"basisAmount": 0,
"amount": 0,
"calculation": {
"rateNumber": 0
},
"reasonCode": [
{
"content": "string",
"typeCode": "string"
}
]
}
],
"invoiceAllowance": [
{
"basisAmount": 0,
"amount": 0,
"calculation": {
"rateNumber": 0
},
"reasonCode": [
{
"content": "string",
"typeCode": "string"
}
]
}
]
}
]
}
}