DX STF Client API

<back to all web services

AddSettlement

Settlement Requests

Settlement

Requires Authentication
The following routes are available for this service:
POST/api/settlementAdd new Settlement
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.Settlement;
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.Settlement
{
    ///<summary>
    ///Settlement
    ///</summary>
    [Api(Description="Settlement")]
    [ApiResponse(Description="Add Settlement request received", IsDefaultResponse=true, StatusCode=200)]
    [ApiResponse(Description="Settlement not accepted, Confirm Sender GLN", ResponseType=typeof(System.UnauthorizedAccessException), StatusCode=403)]
    public partial class AddSettlement
        : IPost
    {
        ///<summary>
        ///Settlement model containing all of the Settlement data
        ///</summary>
        [ApiMember(Description="Settlement model containing all of the Settlement data", ParameterType="model")]
        public virtual SettlementMessage Settlement { 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 AdjustmentAndDiscountSummary
    {
        public virtual decimal AmountTotal { get; set; }
        public virtual decimal AmountNett { get; set; }
        public virtual decimal AmountVat { get; set; }
        public virtual string ReasonMessage { 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 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 partial class ContentOwner
    {
        public virtual string Gln { get; set; }
        public virtual List<AvpList> AdditionalPartyIdentification { get; set; } = [];
    }

    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_PartyIdentification
    {
        public virtual List<AvpList> AdditionalPartyIdentification { get; set; } = [];
        public virtual string Gln { get; set; }
    }

    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 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 InvoiceDocumentReference
        : DocumentReference
    {
        public virtual string InvoiceTypeCode { get; set; }
        public virtual ContentOwner ContentOwner { 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 PaymentMethod
    {
        public virtual string AutomatedClearingHousePaymentFormat { get; set; }
        public virtual string PaymentMethodCode { get; set; }
        public virtual string PaymentMethodIdentification { get; set; }
    }

    public partial class Settlement
        : BaseDocument
    {
        public virtual string BatchIdentification { get; set; }
        public virtual DateTime PaymentEffectiveDate { get; set; }
        public virtual string SettlementCurrency { get; set; }
        public virtual string SettlementHandlingTypeCode { get; set; }
        public virtual decimal? TotalAmount { get; set; }
        public virtual PaymentMethod PaymentMethod { get; set; }
        public virtual TransactionalParty Payee { get; set; }
        public virtual TransactionalParty Payer { get; set; }
        public virtual TransactionalParty RemitTo { get; set; }
        public virtual string settlementIdentification { get; set; }
        public virtual List<SettlementLineItem> SettlementLineItem { get; set; } = [];
        public virtual SettlementExtension Extension { get; set; }
    }

    public partial class SettlementAdjustment
    {
        public virtual decimal? AdjustmentAmount { get; set; }
        public virtual string FinancialAdjusmentReasonPartyRoleCode { get; set; }
        public virtual string FinancialAdjustmentReasonCode { get; set; }
        public virtual TransactionalReference TransactionalReference { get; set; }
    }

    public partial class SettlementExtension
    {
        public virtual List<SettlementExtensionLineItem> SettlementExtensionLineItem { get; set; } = [];
        public virtual List<AdjustmentAndDiscountSummary> AdjustmentAndDiscountSummary { get; set; } = [];
        public virtual TotalAmountSplit TotalAmountSplit { get; set; }
    }

    public partial class SettlementExtensionLineItem
    {
        public virtual int Number { get; set; }
        public virtual string DocumentType { get; set; }
        public virtual string DocumentNumber { get; set; }
        public virtual string ItemText { get; set; }
    }

    public partial class SettlementLineItem
    {
        public virtual decimal? AmountPaid { get; set; }
        public virtual long LineItemNumber { get; set; }
        public virtual decimal? OriginalAmount { get; set; }
        public virtual List<SettlementAdjustment> SettlementAdjustment { get; set; } = [];
        public virtual AvpList AvpList { get; set; }
        public virtual DocumentReference DebitCreditAdvice { get; set; }
        public virtual InvoiceDocumentReference Invoice { get; set; }
        public virtual DocumentReference RequestForPayment { get; set; }
        public virtual List<SettlementParty> SettlementParty { get; set; } = [];
    }

    public partial class SettlementMessage
    {
        public virtual Header Header { get; set; }
        public virtual Settlement Settlement { get; set; }
    }

    public partial class SettlementParty
        : Ecom_PartyIdentification
    {
        public virtual string PartyRoleCode { get; set; }
    }

    public partial class TotalAmountSplit
    {
        public virtual decimal AmountTotal { get; set; }
        public virtual decimal AmountNett { get; set; }
        public virtual decimal AmountVat { 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 TransactionalReference
        : DocumentReference
    {
        public virtual string TransactionalReferenceTypeCode { get; set; }
    }

}

C# AddSettlement 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/settlement HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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

{
	
}