DX STF Client API

<back to all web services

AddCreditNote

Credit Note Requests

Credit Note

Requires Authentication
The following routes are available for this service:
POST/api/creditNoteAdd new credit note
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.STF.Application.ClientApi.Messages.CreditNote;
using DX.STF.Models.Dto.GS1;
using DX.Framework.Core.Commands.Dto;

namespace DX.Framework.Core.Commands.Dto
{
    public partial class TokenDto
        : ICommandResponse
    {
        public virtual Guid Token { get; set; }
    }

}

namespace DX.STF.Application.ClientApi.Messages.CreditNote
{
    ///<summary>
    ///Credit Note
    ///</summary>
    [Api(Description="Credit Note")]
    [ApiResponse(Description="Add credit note request received", IsDefaultResponse=true, StatusCode=200)]
    [ApiResponse(Description="Credit note not accepted, Confirm Sender GLN", ResponseType=typeof(System.UnauthorizedAccessException), StatusCode=403)]
    public partial class AddCreditNote
    {
        ///<summary>
        ///Credit Note model containing all of the Credit Note data
        ///</summary>
        [ApiMember(Description="Credit Note model containing all of the Credit Note data", ParameterType="model")]
        public virtual InvoiceMessage CreditNote { get; set; }
    }

}

namespace DX.STF.Models.Dto.GS1
{
    public partial class Address
    {
        public virtual string StreetAddressOne { get; set; }
        public virtual string StreetAddressTwo { get; set; }
        public virtual string StreetAddressThree { get; set; }
        public virtual string City { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string ProvinceCode { get; set; }
        public virtual string CountryCode { get; set; }
    }

    public partial class AllowanceCharge
    {
        public virtual decimal? AllowanceChargeAmount { get; set; }
        public virtual decimal? AllowanceChargePercentage { get; set; }
        public virtual string AllowanceChargeType { get; set; }
        public virtual string AllowanceOrChargeType { get; set; }
        public virtual decimal? AmountPerUnit { get; set; }
        public virtual decimal? BaseAmount { get; set; }
        public virtual string BaseNumberOfUnits { get; set; }
        public virtual string BracketIdentifier { get; set; }
        public virtual DateTime? EffectiveDateType { get; set; }
        public virtual string SequenceNumber { get; set; }
        public virtual string SettlementType { get; set; }
        public virtual string SpecialServiceType { get; set; }
        public virtual string AllowanceChargeDescription { get; set; }
    }

    public partial class AvpList
    {
        public virtual string Code { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class BaseDocument
    {
        public virtual string CurrencyCode { get; set; }
        public virtual DateTime CreationDateTime { get; set; }
        public virtual DocumentAction DocumentActionCode { get; set; }
        public virtual DocumentStatus DocumentStatusCode { get; set; }
        public virtual string DocumentStructureVersion { get; set; }
        public virtual DateTime? LastUpdateDateTime { get; set; }
        public virtual long? RevisionNumber { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

    public partial class Colour
    {
        public virtual string ColourCode { get; set; }
        public virtual string ColourDescription { get; set; }
    }

    public partial class CommunicationChannel
    {
        public virtual string CommunicationChannelCode { get; set; }
        public virtual string CommunicationChannelName { get; set; }
        public virtual string CommunicationValue { get; set; }
    }

    public partial class Contact
    {
        public virtual string ContactTypeCode { get; set; }
        public virtual string PersonName { get; set; }
        public virtual string DepartmentName { get; set; }
        public virtual string JobTitle { get; set; }
        public virtual string Responsibility { get; set; }
        public virtual List<CommunicationChannel> CommunicationChannel { get; set; } = [];
    }

    [DataContract]
    public partial class ContactInformation
    {
    }

    public enum DocumentAction
    {
        ADD,
        CHANGE_BY_REFRESH,
        DELETE,
        REJECTED,
    }

    [DataContract]
    public partial class DocumentIdentification
    {
        [DataMember(Name="identifier")]
        public virtual string Identifier { get; set; }

        [DataMember(Name="type")]
        public virtual string Type { get; set; }

        [DataMember(Name="creationDateAndTime")]
        public virtual DateTime CreationDateAndTime { get; set; }
    }

    public partial class DocumentReference
    {
        public virtual DateTime? CreationDateTime { get; set; }
        public virtual long? RevisionNumber { get; set; }
        public virtual long? LineItemNumber { get; set; }
        public virtual string EntityIdentification { get; set; }
    }

    public enum DocumentStatus
    {
        ADDITIONAL_TRANSMISSION,
        COPY,
        ORIGINAL,
    }

    public partial class Ecom_PartyIdentificationType
    {
        public virtual string Gln { get; set; }
        public virtual string Name { get; set; }
        public virtual List<AvpList> AdditionalPartyIdentification { get; set; } = [];
    }

    public partial class Extension
    {
    }

    public partial class FinancialAccount
    {
        public virtual string Number { get; set; }
        public virtual string NumberTypeCode { get; set; }
        public virtual string Name { get; set; }
    }

    public partial class FinancialInstitutionInformation
    {
        public virtual string FinancialInstitutionBranchName { get; set; }
        public virtual string FinancialInstitutionName { get; set; }
        public virtual FinancialRoutingNumber FinancialRoutingNumber { get; set; }
        public virtual FinancialAccount FinancialAccount { get; set; }
        public virtual string SwiftCode { get; set; }
        public virtual string ExportersCode { get; set; }
    }

    public partial class FinancialRoutingNumber
    {
        public virtual string Number { get; set; }
        public virtual string NumberTypeCode { get; set; }
    }

    [DataContract]
    public partial class Header
    {
        [DataMember(Name="documentIdentification")]
        public virtual DocumentIdentification DocumentIdentification { get; set; }

        [DataMember(Name="sender")]
        public virtual Partner Sender { get; set; }

        [DataMember(Name="receiver")]
        public virtual Partner Receiver { get; set; }
    }

    [DataContract]
    public partial class Identifier
    {
        [DataMember(Name="authority")]
        public virtual string Authority { get; set; }

        [DataMember(Name="text")]
        public virtual string Text { get; set; }
    }

    public partial class Invoice
    {
        public virtual DateTime? CreationDate { get; set; }
        public virtual long? RevisionNumber { get; set; }
        public virtual string EntityIdentification { get; set; }
    }

    public partial class InvoiceAllowanceCharge
    {
        public virtual AllowanceCharge AllowanceCharge { get; set; }
        public virtual TaxInformation LeviedDutyFeeTax { get; set; }
    }

    public partial class InvoiceClass
        : BaseDocument
    {
        public virtual string CountryOfSupplyOfGoods { get; set; }
        public virtual TransactionalParty Buyer { get; set; }
        public virtual TransactionalParty Seller { get; set; }
        public virtual TransactionalParty Payee { get; set; }
        public virtual TransactionalParty Payer { get; set; }
        public virtual TransactionalParty ShipFrom { get; set; }
        public virtual TransactionalParty ShipTo { get; set; }
        public virtual TransactionalParty UltimateConsignee { get; set; }
        public virtual string SupplierAccountReceivable { get; set; }
        public virtual string InvoiceIdentification { get; set; }
        public virtual Invoice Invoice { get; set; }
        public virtual DocumentReference SalesOrder { get; set; }
        public virtual DocumentReference PurchaseOrder { get; set; }
        public virtual DocumentReference DeliveryNote { get; set; }
        public virtual DocumentReference TradeAgreement { get; set; }
        public virtual ShipmentTransportationInformation ShipmentTransportationInformation { get; set; }
        public virtual string PaymentTerms { get; set; }
        public virtual List<InvoiceLineItem> InvoiceLineItem { get; set; } = [];
        public virtual InvoiceTotals InvoiceTotals { get; set; }
    }

    public partial class InvoiceLineItem
    {
        public virtual long? LineNumber { get; set; }
        public virtual string ParentLineItemNumber { get; set; }
        public virtual Quantity InvoicedQuantity { get; set; }
        public virtual TransactionalTradeItem TransactionalTradeItem { get; set; }
        public virtual decimal? ItemPriceBaseQuantity { get; set; }
        public virtual decimal? RetailPriceExcludingExcise { get; set; }
        public virtual decimal? RecommendedRetailPrice { get; set; }
        public virtual TaxInformation TaxInformation { get; set; }
        public virtual decimal? AmountExclusiveAllowancesCharges { get; set; }
        public virtual decimal? AmountInclusiveAllowancesCharges { get; set; }
        public virtual decimal? ItemPriceExclusiveAllowancesCharges { get; set; }
        public virtual decimal? ItemPriceInclusiveAllowancesCharges { get; set; }
        public virtual string TradeAgreement { get; set; }
        public virtual string DeliveryNote { get; set; }
        public virtual DocumentReference PromotionalDeal { get; set; }
        public virtual List<InvoiceAllowanceCharge> InvoiceAllowanceCharge { get; set; } = [];
        public virtual Extension ExtendedProperties { get; set; }
    }

    public partial class InvoiceMessage
    {
        public virtual Header Header { get; set; }
        public virtual InvoiceClass Invoice { get; set; }
    }

    public partial class InvoiceTotals
    {
        public virtual decimal? BaseAmount { get; set; }
        public virtual decimal? PrepaidAmount { get; set; }
        public virtual DateTime? PrepaidAmountDate { get; set; }
        public virtual decimal? TotalAmountInvoiceAllowancesCharges { get; set; }
        public virtual decimal? TotalLineAmountInclusiveAllowancesCharges { get; set; }
        public virtual decimal? TotalTaxAmount { get; set; }
        public virtual decimal? TotalInvoiceAmount { get; set; }
        public virtual decimal? TotalInvoiceAmountPayable { get; set; }
    }

    [DataContract]
    public partial class Partner
    {
        [DataMember(Name="identifier")]
        public virtual Identifier Identifier { get; set; }

        [DataMember(Name="contactInformation")]
        public virtual List<ContactInformation> ContactInformation { get; set; } = [];
    }

    public partial class Quantity
    {
        public virtual decimal? Value { get; set; }
        public virtual string MeasurementUnitCode { get; set; }
        public virtual string CodeListVersion { get; set; }
    }

    public partial class SerialNumberRange
    {
        public virtual string MaximumValue { get; set; }
        public virtual string MinimumValue { get; set; }
    }

    public partial class ShipmentTransportationInformation
    {
        public virtual TransactionalParty Carrier { get; set; }
        public virtual TransactionalParty FreightForwarder { get; set; }
    }

    public partial class Size
    {
        public virtual string DescriptiveSize { get; set; }
        public virtual string SizeCode { get; set; }
    }

    public partial class TaxInformation
    {
        public virtual decimal? TaxPercentage { get; set; }
        public virtual decimal? TaxAmount { get; set; }
    }

    public partial class TradeItemClassification
    {
        public virtual string GpcCategoryCode { get; set; }
        public virtual List<AvpList> AdditionalTradeItemClassificationCode { get; set; } = [];
        public virtual string GpcCategoryName { get; set; }
        public virtual List<AvpList> GpcAttribute { get; set; } = [];
    }

    public partial class TradeItemWaste
    {
        public virtual string WasteIdentification { get; set; }
        public virtual List<AvpList> TypeOfWaste { get; set; } = [];
    }

    public partial class TransactionalItem
    {
        public virtual string MeasurementUnitCode { get; set; }
        public virtual string MeasurementType { get; set; }
        public virtual string MeasurementValue { get; set; }
    }

    public partial class TransactionalItemData
    {
        public virtual DateTime? AvailableForSaleDate { get; set; }
        public virtual string BatchNumber { get; set; }
        public virtual DateTime? BestBeforeDate { get; set; }
        public virtual string CountryOfOrigin { get; set; }
        public virtual DateTime? ItemExpirationDate { get; set; }
        public virtual string LotNumber { get; set; }
        public virtual DateTime? PackagingDate { get; set; }
        public virtual DateTime? ProductionDate { get; set; }
        public virtual string ProductQualityIndication { get; set; }
        public virtual DateTime? SellByDate { get; set; }
        public virtual List<string> SerialNumber { get; set; } = [];
        public virtual string ShelfLife { get; set; }
        public virtual long? TradeItemQuantity { get; set; }
        public virtual bool? ItemInContactWithFoodProduct { get; set; }
        public virtual List<TransactionalItem> TransactionalItemWeight { get; set; } = [];
        public virtual List<TransactionalItem> TransactionalItemVolume { get; set; } = [];
        public virtual List<SerialNumberRange> SerialNumberRange { get; set; } = [];
        public virtual List<TransactionalItemDimension> TransactionalItemDimensions { get; set; } = [];
        public virtual TransactionalItemLogisticUnitInformation TransactionalItemLogisticUnitInformation { get; set; }
        public virtual TransactionalItemDataCarrierAndIdentification TransactionalItemDataCarrierAndIdentification { get; set; }
        public virtual List<TradeItemWaste> TradeItemWaste { get; set; } = [];
        public virtual TransactionalItemOrganicInformation TransactionalItemOrganicInformation { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

    public partial class TransactionalItemDataCarrierAndIdentification
    {
        public virtual string Gs1TransactionalItemIdentificationKey { get; set; }
        public virtual string DataCarrier { get; set; }
    }

    public partial class TransactionalItemDimension
    {
        public virtual string MeasurementUnitCode { get; set; }
        public virtual string Depth { get; set; }
        public virtual string Height { get; set; }
        public virtual string Width { get; set; }
    }

    public partial class TransactionalItemLogisticUnitInformation
    {
        public virtual long? NumberOfLayers { get; set; }
        public virtual long? NumberOfUnitsPerLayer { get; set; }
        public virtual long? NumberOfUnitsPerPallet { get; set; }
        public virtual string PackagingTerms { get; set; }
        public virtual string PackageTypeCode { get; set; }
        public virtual long? MaximumStackingFactor { get; set; }
        public virtual string ReturnablePackageTransportCostPayment { get; set; }
        public virtual List<TransactionalItemDimension> DimensionsOfLogisticUnit { get; set; } = [];
    }

    public partial class TransactionalItemOrganicInformation
    {
        public virtual bool? IsTradeItemOrganic { get; set; }
        public virtual string OrganicCertification { get; set; }
    }

    public partial class TransactionalParty
        : Ecom_PartyIdentificationType
    {
        public virtual List<Contact> Contact { get; set; } = [];
        public virtual Address Address { get; set; }
        public virtual List<AvpList> CommunicationChannel { get; set; } = [];
        public virtual FinancialInstitutionInformation FinancialInstitutionInformation { get; set; }
        public virtual string DutyFeeTaxRegistration { get; set; }
        public virtual string EntityIdentification { get; set; }
    }

    public partial class TransactionalTradeItem
    {
        public virtual string Gtin { get; set; }
        public virtual List<AvpList> AdditionalTradeItemIdentification { get; set; } = [];
        public virtual decimal? TradeItemQuantity { get; set; }
        public virtual string TradeItemDescription { get; set; }
        public virtual string ProductVariantIdentifier { get; set; }
        public virtual string ItemTypeCode { get; set; }
        public virtual string TradeItemDataOwner { get; set; }
        public virtual string ButterFatReference { get; set; }
        public virtual List<TransactionalItemData> TransactionalItemData { get; set; } = [];
        public virtual List<Colour> Colour { get; set; } = [];
        public virtual Size Size { get; set; }
        public virtual TradeItemClassification TradeItemClassification { get; set; }
        public virtual List<AvpList> AvpList { get; set; } = [];
    }

}

C# AddCreditNote 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.

POST /api/creditNote HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	creditNote: 
	{
		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
				}
			]
		}
	}
}

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

{
	
}