DX STF Client API

GetInvoice

Invoice Requests

The following routes are available for this service:
GET	/api/invoice	Get un-acknowledged invoice, oldest first

**ResultItem<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Token	form	Guid	No
Item	form	ClaimMessage	Yes

**ClaimMessage** Parameters:
Name	Parameter	Data Type	Required	Description
Header	form	Header	Yes
ClaimNotification	form	ClaimNotification	Yes

**Header** Parameters:
Name	Parameter	Data Type	Required
DocumentIdentification	form	DocumentIdentification	Yes
Sender	form	Partner	Yes
Receiver	form	Partner	Yes

**DocumentIdentification** Parameters:
Name	Parameter	Data Type	Required
Identifier	form	string	Yes
Type	form	string	Yes
CreationDateAndTime	form	DateTime	No

**Partner** Parameters:
Name	Parameter	Data Type	Required	Description
Identifier	form	Identifier	Yes
ContactInformation	form	List<ContactInformation>	Yes

**Identifier** Parameters:
Name	Parameter	Data Type	Required	Description
Authority	form	string	Yes
Text	form	string	Yes

**ClaimNotification** Parameters:
Name	Parameter	Data Type	Required
ClaimsNotificationTypeCode	form	string	Yes
IsManualProcessNeededForClaimsResolution	form	bool	No
IsSupplementalMessageBeingSent	form	bool	No
SupplementalMessageDescription	form	string	Yes
ClaimsNotificationIdentification	form	string	Yes
Buyer	form	TransactionalParty	Yes
RemitTo	form	TransactionalParty	Yes
Seller	form	TransactionalParty	Yes
BillOfLading	form	BillOfLading	Yes
ClaimsNotification	form	DocumentReference	Yes
DispatchAdvice	form	DocumentReference	Yes
PurchaseOrder	form	DocumentReference	Yes
Invoice	form	DocumentReference	Yes
ClaimsNotificationDiscrepancyInformation	form	List<ClaimsNotificationDiscrepancyInformation>	Yes
Extension	form	ClaimExtension	Yes

**BaseDocument** Parameters:
Name	Parameter	Data Type	Required
CurrencyCode	form	string	Yes
CreationDateTime	form	DateTime	No
DocumentActionCode	form	DocumentAction	No
DocumentStatusCode	form	DocumentStatus	No
DocumentStructureVersion	form	string	Yes
LastUpdateDateTime	form	DateTime?	No
RevisionNumber	form	long?	No
AvpList	form	List<AvpList>	Yes

**AvpList** Parameters:
Name	Parameter	Data Type	Required	Description
Code	form	string	Yes
Value	form	string	Yes

**TransactionalParty** Parameters:
Name	Parameter	Data Type	Required
Contact	form	List<Contact>	Yes
Address	form	Address	Yes
CommunicationChannel	form	List<AvpList>	Yes
FinancialInstitutionInformation	form	FinancialInstitutionInformation	Yes
DutyFeeTaxRegistration	form	string	Yes
EntityIdentification	form	string	Yes

**Ecom_PartyIdentificationType** Parameters:
Name	Parameter	Data Type	Required
Gln	form	string	Yes
Name	form	string	Yes
AdditionalPartyIdentification	form	List<AvpList>	Yes

**Contact** Parameters:
Name	Parameter	Data Type	Required
ContactTypeCode	form	string	Yes
PersonName	form	string	Yes
DepartmentName	form	string	Yes
JobTitle	form	string	Yes
Responsibility	form	string	Yes
CommunicationChannel	form	List<CommunicationChannel>	Yes

**CommunicationChannel** Parameters:
Name	Parameter	Data Type	Required
CommunicationChannelCode	form	string	Yes
CommunicationChannelName	form	string	Yes
CommunicationValue	form	string	Yes

**Address** Parameters:
Name	Parameter	Data Type	Required
StreetAddressOne	form	string	Yes
StreetAddressTwo	form	string	Yes
StreetAddressThree	form	string	Yes
City	form	string	Yes
PostalCode	form	string	Yes
ProvinceCode	form	string	Yes
CountryCode	form	string	Yes

**FinancialInstitutionInformation** Parameters:
Name	Parameter	Data Type	Required
FinancialInstitutionBranchName	form	string	Yes
FinancialInstitutionName	form	string	Yes
FinancialRoutingNumber	form	FinancialRoutingNumber	Yes
FinancialAccount	form	FinancialAccount	Yes
SwiftCode	form	string	Yes
ExportersCode	form	string	Yes

**FinancialRoutingNumber** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	Yes
NumberTypeCode	form	string	Yes

**FinancialAccount** Parameters:
Name	Parameter	Data Type	Required
Number	form	string	Yes
NumberTypeCode	form	string	Yes
Name	form	string	Yes

**BillOfLading** Parameters:
Name	Parameter	Data Type	Required
CreationDate	form	DateTimeOffset	No
RevisionNumber	form	long	No
EntityIdentification	form	string	Yes
TagNumbers	form	List<string>	Yes
TotalBags	form	long	No

**DocumentReference** Parameters:
Name	Parameter	Data Type	Required
CreationDateTime	form	DateTime?	No
RevisionNumber	form	long?	No
LineItemNumber	form	long?	No
EntityIdentification	form	string	Yes

**ClaimsNotificationDiscrepancyInformation** Parameters:
Name	Parameter	Data Type	Required
ClaimAmount	form	decimal	No
ClaimReasonCode	form	string	Yes
DiscrepancyDescription	form	string	Yes
ActualReceived	form	ClaimsNotificationItemDiscrepancy	Yes
ExpectedToReceive	form	ClaimsNotificationItemDiscrepancy	Yes
AvpList	form	List<AvpList>	Yes

**ClaimsNotificationItemDiscrepancy** Parameters:
Name	Parameter	Data Type	Required
Price	form	decimal	No
Quantity	form	Quantity	Yes
TransactionalTradeItem	form	TransactionalTradeItem	Yes

**Quantity** Parameters:
Name	Parameter	Data Type	Required
Value	form	decimal?	No
MeasurementUnitCode	form	string	Yes
CodeListVersion	form	string	Yes

**TransactionalTradeItem** Parameters:
Name	Parameter	Data Type	Required
Gtin	form	string	Yes
AdditionalTradeItemIdentification	form	List<AvpList>	Yes
TradeItemQuantity	form	decimal?	No
TradeItemDescription	form	string	Yes
ProductVariantIdentifier	form	string	Yes
ItemTypeCode	form	string	Yes
TradeItemDataOwner	form	string	Yes
ButterFatReference	form	string	Yes
TransactionalItemData	form	List<TransactionalItemData>	Yes
Colour	form	List<Colour>	Yes
Size	form	Size	Yes
TradeItemClassification	form	TradeItemClassification	Yes
AvpList	form	List<AvpList>	Yes

**TransactionalItemData** Parameters:
Name	Parameter	Data Type	Required
AvailableForSaleDate	form	DateTime?	No
BatchNumber	form	string	Yes
BestBeforeDate	form	DateTime?	No
CountryOfOrigin	form	string	Yes
ItemExpirationDate	form	DateTime?	No
LotNumber	form	string	Yes
PackagingDate	form	DateTime?	No
ProductionDate	form	DateTime?	No
ProductQualityIndication	form	string	Yes
SellByDate	form	DateTime?	No
SerialNumber	form	List<string>	Yes
ShelfLife	form	string	Yes
TradeItemQuantity	form	long?	No
ItemInContactWithFoodProduct	form	bool?	No
TransactionalItemWeight	form	List<TransactionalItem>	Yes
TransactionalItemVolume	form	List<TransactionalItem>	Yes
SerialNumberRange	form	List<SerialNumberRange>	Yes
TransactionalItemDimensions	form	List<TransactionalItemDimension>	Yes
TransactionalItemLogisticUnitInformation	form	TransactionalItemLogisticUnitInformation	Yes
TransactionalItemDataCarrierAndIdentification	form	TransactionalItemDataCarrierAndIdentification	Yes
TradeItemWaste	form	List<TradeItemWaste>	Yes
TransactionalItemOrganicInformation	form	TransactionalItemOrganicInformation	Yes
AvpList	form	List<AvpList>	Yes

**TransactionalItem** Parameters:
Name	Parameter	Data Type	Required
MeasurementUnitCode	form	string	Yes
MeasurementType	form	string	Yes
MeasurementValue	form	string	Yes

**SerialNumberRange** Parameters:
Name	Parameter	Data Type	Required	Description
MaximumValue	form	string	Yes
MinimumValue	form	string	Yes

**TransactionalItemDimension** Parameters:
Name	Parameter	Data Type	Required
MeasurementUnitCode	form	string	Yes
Depth	form	string	Yes
Height	form	string	Yes
Width	form	string	Yes

**TransactionalItemLogisticUnitInformation** Parameters:
Name	Parameter	Data Type	Required
NumberOfLayers	form	long?	No
NumberOfUnitsPerLayer	form	long?	No
NumberOfUnitsPerPallet	form	long?	No
PackagingTerms	form	string	Yes
PackageTypeCode	form	string	Yes
MaximumStackingFactor	form	long?	No
ReturnablePackageTransportCostPayment	form	string	Yes
DimensionsOfLogisticUnit	form	List<TransactionalItemDimension>	Yes

**TransactionalItemDataCarrierAndIdentification** Parameters:
Name	Parameter	Data Type	Required	Description
Gs1TransactionalItemIdentificationKey	form	string	Yes
DataCarrier	form	string	Yes

**TradeItemWaste** Parameters:
Name	Parameter	Data Type	Required	Description
WasteIdentification	form	string	Yes
TypeOfWaste	form	List<AvpList>	Yes

**TransactionalItemOrganicInformation** Parameters:
Name	Parameter	Data Type	Required	Description
IsTradeItemOrganic	form	bool?	No
OrganicCertification	form	string	Yes

**Colour** Parameters:
Name	Parameter	Data Type	Required	Description
ColourCode	form	string	Yes
ColourDescription	form	string	Yes

**Size** Parameters:
Name	Parameter	Data Type	Required	Description
DescriptiveSize	form	string	Yes
SizeCode	form	string	Yes

**TradeItemClassification** Parameters:
Name	Parameter	Data Type	Required
GpcCategoryCode	form	string	Yes
AdditionalTradeItemClassificationCode	form	List<AvpList>	Yes
GpcCategoryName	form	string	Yes
GpcAttribute	form	List<AvpList>	Yes

**ClaimExtension** Parameters:
Name	Parameter	Data Type	Required
ClaimTotals	form	ClaimTotals	Yes
ShipFrom	form	TransactionalParty	Yes
ShipTo	form	TransactionalParty	Yes

**ClaimTotals** Parameters:
Name	Parameter	Data Type	Required
BaseAmount	form	decimal?	No
TotalTaxAmount	form	decimal?	No
TotalClaimAmount	form	decimal?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/invoice HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsonl