DX STF Client API

<back to all web services

GetSettlementById

Settlement Requests

Settlement

Requires Authentication
The following routes are available for this service:
GET/api/settlement/{Id}Get specific Settlement by Settlement Id
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;

namespace DX.STF.Application.ClientApi.Messages.Settlement
{
    ///<summary>
    ///Settlement
    ///</summary>
    [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)]
    public partial class GetSettlementById
        : IGetDocumentById
    {
        ///<summary>
        ///Settlement ID or Token
        ///</summary>
        [ApiMember(Description="Settlement ID or Token", ExcludeInSchema=true, ParameterType="path")]
        public virtual Guid Id { 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# GetSettlementById DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SettlementMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Models.Dto.GS1">
  <Header>
    <documentIdentification>
      <creationDateAndTime>0001-01-01T00:00:00</creationDateAndTime>
      <identifier>String</identifier>
      <type>String</type>
    </documentIdentification>
    <receiver>
      <contactInformation>
        <ContactInformation />
      </contactInformation>
      <identifier>
        <authority>String</authority>
        <text>String</text>
      </identifier>
    </receiver>
    <sender>
      <contactInformation>
        <ContactInformation />
      </contactInformation>
      <identifier>
        <authority>String</authority>
        <text>String</text>
      </identifier>
    </sender>
  </Header>
  <Settlement>
    <AvpList>
      <AvpList>
        <Code>String</Code>
        <Value>String</Value>
      </AvpList>
    </AvpList>
    <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
    <CurrencyCode>String</CurrencyCode>
    <DocumentActionCode>ADD</DocumentActionCode>
    <DocumentStatusCode>ADDITIONAL_TRANSMISSION</DocumentStatusCode>
    <DocumentStructureVersion>String</DocumentStructureVersion>
    <LastUpdateDateTime>0001-01-01T00:00:00</LastUpdateDateTime>
    <RevisionNumber>0</RevisionNumber>
    <BatchIdentification>String</BatchIdentification>
    <Extension>
      <AdjustmentAndDiscountSummary>
        <AdjustmentAndDiscountSummary>
          <AmountNett>0</AmountNett>
          <AmountTotal>0</AmountTotal>
          <AmountVat>0</AmountVat>
          <ReasonMessage>String</ReasonMessage>
        </AdjustmentAndDiscountSummary>
      </AdjustmentAndDiscountSummary>
      <SettlementExtensionLineItem>
        <SettlementExtensionLineItem>
          <DocumentNumber>String</DocumentNumber>
          <DocumentType>String</DocumentType>
          <ItemText>String</ItemText>
          <Number>0</Number>
        </SettlementExtensionLineItem>
      </SettlementExtensionLineItem>
      <TotalAmountSplit>
        <AmountNett>0</AmountNett>
        <AmountTotal>0</AmountTotal>
        <AmountVat>0</AmountVat>
      </TotalAmountSplit>
    </Extension>
    <Payee>
      <AdditionalPartyIdentification>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
      </AdditionalPartyIdentification>
      <Gln>String</Gln>
      <Name>String</Name>
      <Address>
        <City>String</City>
        <CountryCode>String</CountryCode>
        <PostalCode>String</PostalCode>
        <ProvinceCode>String</ProvinceCode>
        <StreetAddressOne>String</StreetAddressOne>
        <StreetAddressThree>String</StreetAddressThree>
        <StreetAddressTwo>String</StreetAddressTwo>
      </Address>
      <CommunicationChannel>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
      </CommunicationChannel>
      <Contact>
        <Contact>
          <CommunicationChannel>
            <CommunicationChannel>
              <CommunicationChannelCode>String</CommunicationChannelCode>
              <CommunicationChannelName>String</CommunicationChannelName>
              <CommunicationValue>String</CommunicationValue>
            </CommunicationChannel>
          </CommunicationChannel>
          <ContactTypeCode>String</ContactTypeCode>
          <DepartmentName>String</DepartmentName>
          <JobTitle>String</JobTitle>
          <PersonName>String</PersonName>
          <Responsibility>String</Responsibility>
        </Contact>
      </Contact>
      <DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
      <EntityIdentification>String</EntityIdentification>
      <FinancialInstitutionInformation>
        <ExportersCode>String</ExportersCode>
        <FinancialAccount>
          <Name>String</Name>
          <Number>String</Number>
          <NumberTypeCode>String</NumberTypeCode>
        </FinancialAccount>
        <FinancialInstitutionBranchName>String</FinancialInstitutionBranchName>
        <FinancialInstitutionName>String</FinancialInstitutionName>
        <FinancialRoutingNumber>
          <Number>String</Number>
          <NumberTypeCode>String</NumberTypeCode>
        </FinancialRoutingNumber>
        <SwiftCode>String</SwiftCode>
      </FinancialInstitutionInformation>
    </Payee>
    <Payer>
      <AdditionalPartyIdentification>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
      </AdditionalPartyIdentification>
      <Gln>String</Gln>
      <Name>String</Name>
      <Address>
        <City>String</City>
        <CountryCode>String</CountryCode>
        <PostalCode>String</PostalCode>
        <ProvinceCode>String</ProvinceCode>
        <StreetAddressOne>String</StreetAddressOne>
        <StreetAddressThree>String</StreetAddressThree>
        <StreetAddressTwo>String</StreetAddressTwo>
      </Address>
      <CommunicationChannel>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
      </CommunicationChannel>
      <Contact>
        <Contact>
          <CommunicationChannel>
            <CommunicationChannel>
              <CommunicationChannelCode>String</CommunicationChannelCode>
              <CommunicationChannelName>String</CommunicationChannelName>
              <CommunicationValue>String</CommunicationValue>
            </CommunicationChannel>
          </CommunicationChannel>
          <ContactTypeCode>String</ContactTypeCode>
          <DepartmentName>String</DepartmentName>
          <JobTitle>String</JobTitle>
          <PersonName>String</PersonName>
          <Responsibility>String</Responsibility>
        </Contact>
      </Contact>
      <DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
      <EntityIdentification>String</EntityIdentification>
      <FinancialInstitutionInformation>
        <ExportersCode>String</ExportersCode>
        <FinancialAccount>
          <Name>String</Name>
          <Number>String</Number>
          <NumberTypeCode>String</NumberTypeCode>
        </FinancialAccount>
        <FinancialInstitutionBranchName>String</FinancialInstitutionBranchName>
        <FinancialInstitutionName>String</FinancialInstitutionName>
        <FinancialRoutingNumber>
          <Number>String</Number>
          <NumberTypeCode>String</NumberTypeCode>
        </FinancialRoutingNumber>
        <SwiftCode>String</SwiftCode>
      </FinancialInstitutionInformation>
    </Payer>
    <PaymentEffectiveDate>0001-01-01T00:00:00</PaymentEffectiveDate>
    <PaymentMethod>
      <AutomatedClearingHousePaymentFormat>String</AutomatedClearingHousePaymentFormat>
      <PaymentMethodCode>String</PaymentMethodCode>
      <PaymentMethodIdentification>String</PaymentMethodIdentification>
    </PaymentMethod>
    <RemitTo>
      <AdditionalPartyIdentification>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
      </AdditionalPartyIdentification>
      <Gln>String</Gln>
      <Name>String</Name>
      <Address>
        <City>String</City>
        <CountryCode>String</CountryCode>
        <PostalCode>String</PostalCode>
        <ProvinceCode>String</ProvinceCode>
        <StreetAddressOne>String</StreetAddressOne>
        <StreetAddressThree>String</StreetAddressThree>
        <StreetAddressTwo>String</StreetAddressTwo>
      </Address>
      <CommunicationChannel>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
      </CommunicationChannel>
      <Contact>
        <Contact>
          <CommunicationChannel>
            <CommunicationChannel>
              <CommunicationChannelCode>String</CommunicationChannelCode>
              <CommunicationChannelName>String</CommunicationChannelName>
              <CommunicationValue>String</CommunicationValue>
            </CommunicationChannel>
          </CommunicationChannel>
          <ContactTypeCode>String</ContactTypeCode>
          <DepartmentName>String</DepartmentName>
          <JobTitle>String</JobTitle>
          <PersonName>String</PersonName>
          <Responsibility>String</Responsibility>
        </Contact>
      </Contact>
      <DutyFeeTaxRegistration>String</DutyFeeTaxRegistration>
      <EntityIdentification>String</EntityIdentification>
      <FinancialInstitutionInformation>
        <ExportersCode>String</ExportersCode>
        <FinancialAccount>
          <Name>String</Name>
          <Number>String</Number>
          <NumberTypeCode>String</NumberTypeCode>
        </FinancialAccount>
        <FinancialInstitutionBranchName>String</FinancialInstitutionBranchName>
        <FinancialInstitutionName>String</FinancialInstitutionName>
        <FinancialRoutingNumber>
          <Number>String</Number>
          <NumberTypeCode>String</NumberTypeCode>
        </FinancialRoutingNumber>
        <SwiftCode>String</SwiftCode>
      </FinancialInstitutionInformation>
    </RemitTo>
    <SettlementCurrency>String</SettlementCurrency>
    <SettlementHandlingTypeCode>String</SettlementHandlingTypeCode>
    <SettlementLineItem>
      <SettlementLineItem>
        <AmountPaid>0</AmountPaid>
        <AvpList>
          <Code>String</Code>
          <Value>String</Value>
        </AvpList>
        <DebitCreditAdvice>
          <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
          <EntityIdentification>String</EntityIdentification>
          <LineItemNumber>0</LineItemNumber>
          <RevisionNumber>0</RevisionNumber>
        </DebitCreditAdvice>
        <Invoice>
          <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
          <EntityIdentification>String</EntityIdentification>
          <LineItemNumber>0</LineItemNumber>
          <RevisionNumber>0</RevisionNumber>
          <ContentOwner>
            <AdditionalPartyIdentification>
              <AvpList>
                <Code>String</Code>
                <Value>String</Value>
              </AvpList>
            </AdditionalPartyIdentification>
            <Gln>String</Gln>
          </ContentOwner>
          <InvoiceTypeCode>String</InvoiceTypeCode>
        </Invoice>
        <LineItemNumber>0</LineItemNumber>
        <OriginalAmount>0</OriginalAmount>
        <RequestForPayment>
          <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
          <EntityIdentification>String</EntityIdentification>
          <LineItemNumber>0</LineItemNumber>
          <RevisionNumber>0</RevisionNumber>
        </RequestForPayment>
        <SettlementAdjustment>
          <SettlementAdjustment>
            <AdjustmentAmount>0</AdjustmentAmount>
            <FinancialAdjusmentReasonPartyRoleCode>String</FinancialAdjusmentReasonPartyRoleCode>
            <FinancialAdjustmentReasonCode>String</FinancialAdjustmentReasonCode>
            <TransactionalReference>
              <CreationDateTime>0001-01-01T00:00:00</CreationDateTime>
              <EntityIdentification>String</EntityIdentification>
              <LineItemNumber>0</LineItemNumber>
              <RevisionNumber>0</RevisionNumber>
              <TransactionalReferenceTypeCode>String</TransactionalReferenceTypeCode>
            </TransactionalReference>
          </SettlementAdjustment>
        </SettlementAdjustment>
        <SettlementParty>
          <SettlementParty>
            <AdditionalPartyIdentification>
              <AvpList>
                <Code>String</Code>
                <Value>String</Value>
              </AvpList>
            </AdditionalPartyIdentification>
            <Gln>String</Gln>
            <PartyRoleCode>String</PartyRoleCode>
          </SettlementParty>
        </SettlementParty>
      </SettlementLineItem>
    </SettlementLineItem>
    <TotalAmount>0</TotalAmount>
    <settlementIdentification>String</settlementIdentification>
  </Settlement>
</SettlementMessage>