DX STF Client API

<back to all web services

GetCreditNoteById

Credit Note Requests

Credit Note

Requires Authentication
The following routes are available for this service:
GET/api/creditNote/{Id}Get specific credit note by credit note Id

// @DataContract
export class DocumentIdentification
{
    // @DataMember(Name="identifier")
    public identifier: string;

    // @DataMember(Name="type")
    public type: string;

    // @DataMember(Name="creationDateAndTime")
    public creationDateAndTime: string;

    public constructor(init?: Partial<DocumentIdentification>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Identifier
{
    // @DataMember(Name="authority")
    public authority: string;

    // @DataMember(Name="text")
    public text: string;

    public constructor(init?: Partial<Identifier>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ContactInformation
{

    public constructor(init?: Partial<ContactInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Partner
{
    // @DataMember(Name="identifier")
    public identifier: Identifier;

    // @DataMember(Name="contactInformation")
    public contactInformation: ContactInformation[] = [];

    public constructor(init?: Partial<Partner>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Header
{
    // @DataMember(Name="documentIdentification")
    public documentIdentification: DocumentIdentification;

    // @DataMember(Name="sender")
    public sender: Partner;

    // @DataMember(Name="receiver")
    public receiver: Partner;

    public constructor(init?: Partial<Header>) { (Object as any).assign(this, init); }
}

export enum DocumentAction
{
    ADD = 'ADD',
    CHANGE_BY_REFRESH = 'CHANGE_BY_REFRESH',
    DELETE = 'DELETE',
    REJECTED = 'REJECTED',
}

export enum DocumentStatus
{
    ADDITIONAL_TRANSMISSION = 'ADDITIONAL_TRANSMISSION',
    COPY = 'COPY',
    ORIGINAL = 'ORIGINAL',
}

export class AvpList
{
    public code: string;
    public value: string;

    public constructor(init?: Partial<AvpList>) { (Object as any).assign(this, init); }
}

export class BaseDocument
{
    public currencyCode: string;
    public creationDateTime: string;
    public documentActionCode: DocumentAction;
    public documentStatusCode: DocumentStatus;
    public documentStructureVersion: string;
    public lastUpdateDateTime?: string;
    public revisionNumber?: number;
    public avpList: AvpList[] = [];

    public constructor(init?: Partial<BaseDocument>) { (Object as any).assign(this, init); }
}

export class Ecom_PartyIdentificationType
{
    public gln: string;
    public name: string;
    public additionalPartyIdentification: AvpList[] = [];

    public constructor(init?: Partial<Ecom_PartyIdentificationType>) { (Object as any).assign(this, init); }
}

export class CommunicationChannel
{
    public communicationChannelCode: string;
    public communicationChannelName: string;
    public communicationValue: string;

    public constructor(init?: Partial<CommunicationChannel>) { (Object as any).assign(this, init); }
}

export class Contact
{
    public contactTypeCode: string;
    public personName: string;
    public departmentName: string;
    public jobTitle: string;
    public responsibility: string;
    public communicationChannel: CommunicationChannel[] = [];

    public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}

export class Address
{
    public streetAddressOne: string;
    public streetAddressTwo: string;
    public streetAddressThree: string;
    public city: string;
    public postalCode: string;
    public provinceCode: string;
    public countryCode: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

export class FinancialRoutingNumber
{
    public number: string;
    public numberTypeCode: string;

    public constructor(init?: Partial<FinancialRoutingNumber>) { (Object as any).assign(this, init); }
}

export class FinancialAccount
{
    public number: string;
    public numberTypeCode: string;
    public name: string;

    public constructor(init?: Partial<FinancialAccount>) { (Object as any).assign(this, init); }
}

export class FinancialInstitutionInformation
{
    public financialInstitutionBranchName: string;
    public financialInstitutionName: string;
    public financialRoutingNumber: FinancialRoutingNumber;
    public financialAccount: FinancialAccount;
    public swiftCode: string;
    public exportersCode: string;

    public constructor(init?: Partial<FinancialInstitutionInformation>) { (Object as any).assign(this, init); }
}

export class TransactionalParty extends Ecom_PartyIdentificationType
{
    public contact: Contact[] = [];
    public address: Address;
    public communicationChannel: AvpList[] = [];
    public financialInstitutionInformation: FinancialInstitutionInformation;
    public dutyFeeTaxRegistration: string;
    public entityIdentification: string;

    public constructor(init?: Partial<TransactionalParty>) { super(init); (Object as any).assign(this, init); }
}

export class Invoice
{
    public creationDate?: string;
    public revisionNumber?: number;
    public entityIdentification: string;

    public constructor(init?: Partial<Invoice>) { (Object as any).assign(this, init); }
}

export class DocumentReference
{
    public creationDateTime?: string;
    public revisionNumber?: number;
    public lineItemNumber?: number;
    public entityIdentification: string;

    public constructor(init?: Partial<DocumentReference>) { (Object as any).assign(this, init); }
}

export class ShipmentTransportationInformation
{
    public carrier: TransactionalParty;
    public freightForwarder: TransactionalParty;

    public constructor(init?: Partial<ShipmentTransportationInformation>) { (Object as any).assign(this, init); }
}

export class Quantity
{
    public value?: number;
    public measurementUnitCode: string;
    public codeListVersion: string;

    public constructor(init?: Partial<Quantity>) { (Object as any).assign(this, init); }
}

export class TransactionalItem
{
    public measurementUnitCode: string;
    public measurementType: string;
    public measurementValue: string;

    public constructor(init?: Partial<TransactionalItem>) { (Object as any).assign(this, init); }
}

export class SerialNumberRange
{
    public maximumValue: string;
    public minimumValue: string;

    public constructor(init?: Partial<SerialNumberRange>) { (Object as any).assign(this, init); }
}

export class TransactionalItemDimension
{
    public measurementUnitCode: string;
    public depth: string;
    public height: string;
    public width: string;

    public constructor(init?: Partial<TransactionalItemDimension>) { (Object as any).assign(this, init); }
}

export class TransactionalItemLogisticUnitInformation
{
    public numberOfLayers?: number;
    public numberOfUnitsPerLayer?: number;
    public numberOfUnitsPerPallet?: number;
    public packagingTerms: string;
    public packageTypeCode: string;
    public maximumStackingFactor?: number;
    public returnablePackageTransportCostPayment: string;
    public dimensionsOfLogisticUnit: TransactionalItemDimension[] = [];

    public constructor(init?: Partial<TransactionalItemLogisticUnitInformation>) { (Object as any).assign(this, init); }
}

export class TransactionalItemDataCarrierAndIdentification
{
    public gs1TransactionalItemIdentificationKey: string;
    public dataCarrier: string;

    public constructor(init?: Partial<TransactionalItemDataCarrierAndIdentification>) { (Object as any).assign(this, init); }
}

export class TradeItemWaste
{
    public wasteIdentification: string;
    public typeOfWaste: AvpList[] = [];

    public constructor(init?: Partial<TradeItemWaste>) { (Object as any).assign(this, init); }
}

export class TransactionalItemOrganicInformation
{
    public isTradeItemOrganic?: boolean;
    public organicCertification: string;

    public constructor(init?: Partial<TransactionalItemOrganicInformation>) { (Object as any).assign(this, init); }
}

export class TransactionalItemData
{
    public availableForSaleDate?: string;
    public batchNumber: string;
    public bestBeforeDate?: string;
    public countryOfOrigin: string;
    public itemExpirationDate?: string;
    public lotNumber: string;
    public packagingDate?: string;
    public productionDate?: string;
    public productQualityIndication: string;
    public sellByDate?: string;
    public serialNumber: string[] = [];
    public shelfLife: string;
    public tradeItemQuantity?: number;
    public itemInContactWithFoodProduct?: boolean;
    public transactionalItemWeight: TransactionalItem[] = [];
    public transactionalItemVolume: TransactionalItem[] = [];
    public serialNumberRange: SerialNumberRange[] = [];
    public transactionalItemDimensions: TransactionalItemDimension[] = [];
    public transactionalItemLogisticUnitInformation: TransactionalItemLogisticUnitInformation;
    public transactionalItemDataCarrierAndIdentification: TransactionalItemDataCarrierAndIdentification;
    public tradeItemWaste: TradeItemWaste[] = [];
    public transactionalItemOrganicInformation: TransactionalItemOrganicInformation;
    public avpList: AvpList[] = [];

    public constructor(init?: Partial<TransactionalItemData>) { (Object as any).assign(this, init); }
}

export class Colour
{
    public colourCode: string;
    public colourDescription: string;

    public constructor(init?: Partial<Colour>) { (Object as any).assign(this, init); }
}

export class Size
{
    public descriptiveSize: string;
    public sizeCode: string;

    public constructor(init?: Partial<Size>) { (Object as any).assign(this, init); }
}

export class TradeItemClassification
{
    public gpcCategoryCode: string;
    public additionalTradeItemClassificationCode: AvpList[] = [];
    public gpcCategoryName: string;
    public gpcAttribute: AvpList[] = [];

    public constructor(init?: Partial<TradeItemClassification>) { (Object as any).assign(this, init); }
}

export class TransactionalTradeItem
{
    public gtin: string;
    public additionalTradeItemIdentification: AvpList[] = [];
    public tradeItemQuantity?: number;
    public tradeItemDescription: string;
    public productVariantIdentifier: string;
    public itemTypeCode: string;
    public tradeItemDataOwner: string;
    public butterFatReference: string;
    public transactionalItemData: TransactionalItemData[] = [];
    public colour: Colour[] = [];
    public size: Size;
    public tradeItemClassification: TradeItemClassification;
    public avpList: AvpList[] = [];

    public constructor(init?: Partial<TransactionalTradeItem>) { (Object as any).assign(this, init); }
}

export class TaxInformation
{
    public taxPercentage?: number;
    public taxAmount?: number;

    public constructor(init?: Partial<TaxInformation>) { (Object as any).assign(this, init); }
}

export class AllowanceCharge
{
    public allowanceChargeAmount?: number;
    public allowanceChargePercentage?: number;
    public allowanceChargeType: string;
    public allowanceOrChargeType: string;
    public amountPerUnit?: number;
    public baseAmount?: number;
    public baseNumberOfUnits: string;
    public bracketIdentifier: string;
    public effectiveDateType?: string;
    public sequenceNumber: string;
    public settlementType: string;
    public specialServiceType: string;
    public allowanceChargeDescription: string;

    public constructor(init?: Partial<AllowanceCharge>) { (Object as any).assign(this, init); }
}

export class InvoiceAllowanceCharge
{
    public allowanceCharge: AllowanceCharge;
    public leviedDutyFeeTax: TaxInformation;

    public constructor(init?: Partial<InvoiceAllowanceCharge>) { (Object as any).assign(this, init); }
}

export class Extension
{

    public constructor(init?: Partial<Extension>) { (Object as any).assign(this, init); }
}

export class InvoiceLineItem
{
    public lineNumber?: number;
    public parentLineItemNumber: string;
    public invoicedQuantity: Quantity;
    public transactionalTradeItem: TransactionalTradeItem;
    public itemPriceBaseQuantity?: number;
    public retailPriceExcludingExcise?: number;
    public recommendedRetailPrice?: number;
    public taxInformation: TaxInformation;
    public amountExclusiveAllowancesCharges?: number;
    public amountInclusiveAllowancesCharges?: number;
    public itemPriceExclusiveAllowancesCharges?: number;
    public itemPriceInclusiveAllowancesCharges?: number;
    public tradeAgreement: string;
    public deliveryNote: string;
    public promotionalDeal: DocumentReference;
    public invoiceAllowanceCharge: InvoiceAllowanceCharge[] = [];
    public extendedProperties: Extension;

    public constructor(init?: Partial<InvoiceLineItem>) { (Object as any).assign(this, init); }
}

export class InvoiceTotals
{
    public baseAmount?: number;
    public prepaidAmount?: number;
    public prepaidAmountDate?: string;
    public totalAmountInvoiceAllowancesCharges?: number;
    public totalLineAmountInclusiveAllowancesCharges?: number;
    public totalTaxAmount?: number;
    public totalInvoiceAmount?: number;
    public totalInvoiceAmountPayable?: number;

    public constructor(init?: Partial<InvoiceTotals>) { (Object as any).assign(this, init); }
}

export class InvoiceClass extends BaseDocument
{
    public countryOfSupplyOfGoods: string;
    public buyer: TransactionalParty;
    public seller: TransactionalParty;
    public payee: TransactionalParty;
    public payer: TransactionalParty;
    public shipFrom: TransactionalParty;
    public shipTo: TransactionalParty;
    public ultimateConsignee: TransactionalParty;
    public supplierAccountReceivable: string;
    public invoiceIdentification: string;
    public invoice: Invoice;
    public salesOrder: DocumentReference;
    public purchaseOrder: DocumentReference;
    public deliveryNote: DocumentReference;
    public tradeAgreement: DocumentReference;
    public shipmentTransportationInformation: ShipmentTransportationInformation;
    public paymentTerms: string;
    public invoiceLineItem: InvoiceLineItem[] = [];
    public invoiceTotals: InvoiceTotals;

    public constructor(init?: Partial<InvoiceClass>) { super(init); (Object as any).assign(this, init); }
}

export class InvoiceMessage
{
    public header: Header;
    public invoice: InvoiceClass;

    public constructor(init?: Partial<InvoiceMessage>) { (Object as any).assign(this, init); }
}

/** @description Credit Note */
// @Api(Description="Credit Note")
// @ApiResponse(Description="Credit Note data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType="typeof(ServiceStack.IReturnVoid)", StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType="typeof(System.ArgumentOutOfRangeException)", StatusCode=400)
export class GetCreditNoteById implements IGetDocumentById
{
    /** @description Credit Note ID or Token */
    // @ApiMember(Description="Credit Note ID or Token", ExcludeInSchema=true, ParameterType="path")
    public id: string;

    public constructor(init?: Partial<GetCreditNoteById>) { (Object as any).assign(this, init); }
}

TypeScript GetCreditNoteById DTOs

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

HTTP + JSV

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

GET /api/creditNote/{Id} HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	header: 
	{
		documentIdentification: 
		{
			identifier: String,
			type: String
		},
		sender: 
		{
			identifier: 
			{
				authority: String,
				text: String
			},
			contactInformation: 
			[
				{
					
				}
			]
		},
		receiver: 
		{
			identifier: 
			{
				authority: String,
				text: String
			},
			contactInformation: 
			[
				{
					
				}
			]
		}
	},
	invoice: 
	{
		countryOfSupplyOfGoods: String,
		buyer: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		seller: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		payee: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		payer: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		shipFrom: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		shipTo: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		ultimateConsignee: 
		{
			contact: 
			[
				{
					contactTypeCode: String,
					personName: String,
					departmentName: String,
					jobTitle: String,
					responsibility: String,
					communicationChannel: 
					[
						{
							communicationChannelCode: String,
							communicationChannelName: String,
							communicationValue: String
						}
					]
				}
			],
			address: 
			{
				streetAddressOne: String,
				streetAddressTwo: String,
				streetAddressThree: String,
				city: String,
				postalCode: String,
				provinceCode: String,
				countryCode: String
			},
			communicationChannel: 
			[
				{
					code: String,
					value: String
				}
			],
			financialInstitutionInformation: 
			{
				financialInstitutionBranchName: String,
				financialInstitutionName: String,
				financialRoutingNumber: 
				{
					number: String,
					numberTypeCode: String
				},
				financialAccount: 
				{
					number: String,
					numberTypeCode: String,
					name: String
				},
				swiftCode: String,
				exportersCode: String
			},
			dutyFeeTaxRegistration: String,
			entityIdentification: String,
			gln: String,
			name: String,
			additionalPartyIdentification: 
			[
				{
					code: String,
					value: String
				}
			]
		},
		supplierAccountReceivable: String,
		invoiceIdentification: String,
		invoice: 
		{
			creationDate: 0001-01-01,
			revisionNumber: 0,
			entityIdentification: String
		},
		salesOrder: 
		{
			creationDateTime: 0001-01-01,
			revisionNumber: 0,
			lineItemNumber: 0,
			entityIdentification: String
		},
		purchaseOrder: 
		{
			creationDateTime: 0001-01-01,
			revisionNumber: 0,
			lineItemNumber: 0,
			entityIdentification: String
		},
		deliveryNote: 
		{
			creationDateTime: 0001-01-01,
			revisionNumber: 0,
			lineItemNumber: 0,
			entityIdentification: String
		},
		tradeAgreement: 
		{
			creationDateTime: 0001-01-01,
			revisionNumber: 0,
			lineItemNumber: 0,
			entityIdentification: String
		},
		shipmentTransportationInformation: 
		{
			carrier: 
			{
				contact: 
				[
					{
						contactTypeCode: String,
						personName: String,
						departmentName: String,
						jobTitle: String,
						responsibility: String,
						communicationChannel: 
						[
							{
								communicationChannelCode: String,
								communicationChannelName: String,
								communicationValue: String
							}
						]
					}
				],
				address: 
				{
					streetAddressOne: String,
					streetAddressTwo: String,
					streetAddressThree: String,
					city: String,
					postalCode: String,
					provinceCode: String,
					countryCode: String
				},
				communicationChannel: 
				[
					{
						code: String,
						value: String
					}
				],
				financialInstitutionInformation: 
				{
					financialInstitutionBranchName: String,
					financialInstitutionName: String,
					financialRoutingNumber: 
					{
						number: String,
						numberTypeCode: String
					},
					financialAccount: 
					{
						number: String,
						numberTypeCode: String,
						name: String
					},
					swiftCode: String,
					exportersCode: String
				},
				dutyFeeTaxRegistration: String,
				entityIdentification: String,
				gln: String,
				name: String,
				additionalPartyIdentification: 
				[
					{
						code: String,
						value: String
					}
				]
			},
			freightForwarder: 
			{
				contact: 
				[
					{
						contactTypeCode: String,
						personName: String,
						departmentName: String,
						jobTitle: String,
						responsibility: String,
						communicationChannel: 
						[
							{
								communicationChannelCode: String,
								communicationChannelName: String,
								communicationValue: String
							}
						]
					}
				],
				address: 
				{
					streetAddressOne: String,
					streetAddressTwo: String,
					streetAddressThree: String,
					city: String,
					postalCode: String,
					provinceCode: String,
					countryCode: String
				},
				communicationChannel: 
				[
					{
						code: String,
						value: String
					}
				],
				financialInstitutionInformation: 
				{
					financialInstitutionBranchName: String,
					financialInstitutionName: String,
					financialRoutingNumber: 
					{
						number: String,
						numberTypeCode: String
					},
					financialAccount: 
					{
						number: String,
						numberTypeCode: String,
						name: String
					},
					swiftCode: String,
					exportersCode: String
				},
				dutyFeeTaxRegistration: String,
				entityIdentification: String,
				gln: String,
				name: String,
				additionalPartyIdentification: 
				[
					{
						code: String,
						value: String
					}
				]
			}
		},
		paymentTerms: String,
		invoiceLineItem: 
		[
			{
				lineNumber: 0,
				parentLineItemNumber: String,
				invoicedQuantity: 
				{
					value: 0,
					measurementUnitCode: String,
					codeListVersion: String
				},
				transactionalTradeItem: 
				{
					gtin: String,
					additionalTradeItemIdentification: 
					[
						{
							code: String,
							value: String
						}
					],
					tradeItemQuantity: 0,
					tradeItemDescription: String,
					productVariantIdentifier: String,
					itemTypeCode: String,
					tradeItemDataOwner: String,
					butterFatReference: String,
					transactionalItemData: 
					[
						{
							availableForSaleDate: 0001-01-01,
							batchNumber: String,
							bestBeforeDate: 0001-01-01,
							countryOfOrigin: String,
							itemExpirationDate: 0001-01-01,
							lotNumber: String,
							packagingDate: 0001-01-01,
							productionDate: 0001-01-01,
							productQualityIndication: String,
							sellByDate: 0001-01-01,
							serialNumber: 
							[
								String
							],
							shelfLife: String,
							tradeItemQuantity: 0,
							itemInContactWithFoodProduct: False,
							transactionalItemWeight: 
							[
								{
									measurementUnitCode: String,
									measurementType: String,
									measurementValue: String
								}
							],
							transactionalItemVolume: 
							[
								{
									measurementUnitCode: String,
									measurementType: String,
									measurementValue: String
								}
							],
							serialNumberRange: 
							[
								{
									maximumValue: String,
									minimumValue: String
								}
							],
							transactionalItemDimensions: 
							[
								{
									measurementUnitCode: String,
									depth: String,
									height: String,
									width: String
								}
							],
							transactionalItemLogisticUnitInformation: 
							{
								numberOfLayers: 0,
								numberOfUnitsPerLayer: 0,
								numberOfUnitsPerPallet: 0,
								packagingTerms: String,
								packageTypeCode: String,
								maximumStackingFactor: 0,
								returnablePackageTransportCostPayment: String,
								dimensionsOfLogisticUnit: 
								[
									{
										measurementUnitCode: String,
										depth: String,
										height: String,
										width: String
									}
								]
							},
							transactionalItemDataCarrierAndIdentification: 
							{
								gs1TransactionalItemIdentificationKey: String,
								dataCarrier: String
							},
							tradeItemWaste: 
							[
								{
									wasteIdentification: String,
									typeOfWaste: 
									[
										{
											code: String,
											value: String
										}
									]
								}
							],
							transactionalItemOrganicInformation: 
							{
								isTradeItemOrganic: False,
								organicCertification: String
							},
							avpList: 
							[
								{
									code: String,
									value: String
								}
							]
						}
					],
					colour: 
					[
						{
							colourCode: String,
							colourDescription: String
						}
					],
					size: 
					{
						descriptiveSize: String,
						sizeCode: String
					},
					tradeItemClassification: 
					{
						gpcCategoryCode: String,
						additionalTradeItemClassificationCode: 
						[
							{
								code: String,
								value: String
							}
						],
						gpcCategoryName: String,
						gpcAttribute: 
						[
							{
								code: String,
								value: String
							}
						]
					},
					avpList: 
					[
						{
							code: String,
							value: String
						}
					]
				},
				itemPriceBaseQuantity: 0,
				retailPriceExcludingExcise: 0,
				recommendedRetailPrice: 0,
				taxInformation: 
				{
					taxPercentage: 0,
					taxAmount: 0
				},
				amountExclusiveAllowancesCharges: 0,
				amountInclusiveAllowancesCharges: 0,
				itemPriceExclusiveAllowancesCharges: 0,
				itemPriceInclusiveAllowancesCharges: 0,
				tradeAgreement: String,
				deliveryNote: String,
				promotionalDeal: 
				{
					creationDateTime: 0001-01-01,
					revisionNumber: 0,
					lineItemNumber: 0,
					entityIdentification: String
				},
				invoiceAllowanceCharge: 
				[
					{
						allowanceCharge: 
						{
							allowanceChargeAmount: 0,
							allowanceChargePercentage: 0,
							allowanceChargeType: String,
							allowanceOrChargeType: String,
							amountPerUnit: 0,
							baseAmount: 0,
							baseNumberOfUnits: String,
							bracketIdentifier: String,
							effectiveDateType: 0001-01-01,
							sequenceNumber: String,
							settlementType: String,
							specialServiceType: String,
							allowanceChargeDescription: String
						},
						leviedDutyFeeTax: 
						{
							taxPercentage: 0,
							taxAmount: 0
						}
					}
				],
				extendedProperties: {}
			}
		],
		invoiceTotals: 
		{
			baseAmount: 0,
			prepaidAmount: 0,
			prepaidAmountDate: 0001-01-01,
			totalAmountInvoiceAllowancesCharges: 0,
			totalLineAmountInclusiveAllowancesCharges: 0,
			totalTaxAmount: 0,
			totalInvoiceAmount: 0,
			totalInvoiceAmountPayable: 0
		},
		currencyCode: String,
		documentActionCode: ADD,
		documentStatusCode: ADDITIONAL_TRANSMISSION,
		documentStructureVersion: String,
		lastUpdateDateTime: 0001-01-01,
		revisionNumber: 0,
		avpList: 
		[
			{
				code: String,
				value: String
			}
		]
	}
}