DX STF Client API

GetSettlementById

Settlement Requests

Settlement

The following routes are available for this service:
GET	/api/settlement/{Id}	Get specific Settlement by Settlement 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 PaymentMethod
{
    public automatedClearingHousePaymentFormat: string;
    public paymentMethodCode: string;
    public paymentMethodIdentification: string;

    public constructor(init?: Partial<PaymentMethod>) { (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 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 TransactionalReference extends DocumentReference
{
    public transactionalReferenceTypeCode: string;

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

export class SettlementAdjustment
{
    public adjustmentAmount?: number;
    public financialAdjusmentReasonPartyRoleCode: string;
    public financialAdjustmentReasonCode: string;
    public transactionalReference: TransactionalReference;

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

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

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

export class InvoiceDocumentReference extends DocumentReference
{
    public invoiceTypeCode: string;
    public contentOwner: ContentOwner;

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

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

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

export class SettlementParty extends Ecom_PartyIdentification
{
    public partyRoleCode: string;

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

export class SettlementLineItem
{
    public amountPaid?: number;
    public lineItemNumber: number;
    public originalAmount?: number;
    public settlementAdjustment: SettlementAdjustment[] = [];
    public avpList: AvpList;
    public debitCreditAdvice: DocumentReference;
    public invoice: InvoiceDocumentReference;
    public requestForPayment: DocumentReference;
    public settlementParty: SettlementParty[] = [];

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

export class SettlementExtensionLineItem
{
    public number: number;
    public documentType: string;
    public documentNumber: string;
    public itemText: string;

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

export class AdjustmentAndDiscountSummary
{
    public amountTotal: number;
    public amountNett: number;
    public amountVat: number;
    public reasonMessage: string;

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

export class TotalAmountSplit
{
    public amountTotal: number;
    public amountNett: number;
    public amountVat: number;

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

export class SettlementExtension
{
    public settlementExtensionLineItem: SettlementExtensionLineItem[] = [];
    public adjustmentAndDiscountSummary: AdjustmentAndDiscountSummary[] = [];
    public totalAmountSplit: TotalAmountSplit;

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

export class Settlement extends BaseDocument
{
    public batchIdentification: string;
    public paymentEffectiveDate: string;
    public settlementCurrency: string;
    public settlementHandlingTypeCode: string;
    public totalAmount?: number;
    public paymentMethod: PaymentMethod;
    public payee: TransactionalParty;
    public payer: TransactionalParty;
    public remitTo: TransactionalParty;
    public settlementIdentification: string;
    public settlementLineItem: SettlementLineItem[] = [];
    public extension: SettlementExtension;

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

export class SettlementMessage
{
    public header: Header;
    public settlement: Settlement;

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

/** @description Settlement */
// @Api(Description="Settlement")
// @ApiResponse(Description="Settlement 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 GetSettlementById implements IGetDocumentById
{
    /** @description Settlement ID or Token */
    // @ApiMember(Description="Settlement ID or Token", ExcludeInSchema=true, ParameterType="path")
    public id: string;

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

TypeScript GetSettlementById 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/settlement/{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: 
			[
				{
					
				}
			]
		}
	},
	settlement: 
	{
		batchIdentification: String,
		settlementCurrency: String,
		settlementHandlingTypeCode: String,
		totalAmount: 0,
		paymentMethod: 
		{
			automatedClearingHousePaymentFormat: String,
			paymentMethodCode: String,
			paymentMethodIdentification: 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
				}
			]
		},
		remitTo: 
		{
			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
				}
			]
		},
		settlementIdentification: String,
		settlementLineItem: 
		[
			{
				amountPaid: 0,
				lineItemNumber: 0,
				originalAmount: 0,
				settlementAdjustment: 
				[
					{
						adjustmentAmount: 0,
						financialAdjusmentReasonPartyRoleCode: String,
						financialAdjustmentReasonCode: String,
						transactionalReference: 
						{
							transactionalReferenceTypeCode: String,
							creationDateTime: 0001-01-01,
							revisionNumber: 0,
							lineItemNumber: 0,
							entityIdentification: String
						}
					}
				],
				avpList: 
				{
					code: String,
					value: String
				},
				debitCreditAdvice: 
				{
					creationDateTime: 0001-01-01,
					revisionNumber: 0,
					lineItemNumber: 0,
					entityIdentification: String
				},
				invoice: 
				{
					invoiceTypeCode: String,
					contentOwner: 
					{
						gln: String,
						additionalPartyIdentification: 
						[
							{
								code: String,
								value: String
							}
						]
					},
					creationDateTime: 0001-01-01,
					revisionNumber: 0,
					lineItemNumber: 0,
					entityIdentification: String
				},
				requestForPayment: 
				{
					creationDateTime: 0001-01-01,
					revisionNumber: 0,
					lineItemNumber: 0,
					entityIdentification: String
				},
				settlementParty: 
				[
					{
						partyRoleCode: String,
						additionalPartyIdentification: 
						[
							{
								code: String,
								value: String
							}
						],
						gln: String
					}
				]
			}
		],
		extension: 
		{
			settlementExtensionLineItem: 
			[
				{
					number: 0,
					documentType: String,
					documentNumber: String,
					itemText: String
				}
			],
			adjustmentAndDiscountSummary: 
			[
				{
					amountTotal: 0,
					amountNett: 0,
					amountVat: 0,
					reasonMessage: String
				}
			],
			totalAmountSplit: 
			{
				amountTotal: 0,
				amountNett: 0,
				amountVat: 0
			}
		},
		currencyCode: String,
		documentActionCode: ADD,
		documentStatusCode: ADDITIONAL_TRANSMISSION,
		documentStructureVersion: String,
		lastUpdateDateTime: 0001-01-01,
		revisionNumber: 0,
		avpList: 
		[
			{
				code: String,
				value: String
			}
		]
	}
}