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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


/**
* Settlement
*/
@Api(Description="Settlement")
@ApiResponse(Description="Settlement data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType=IReturnVoid::class, StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=ArgumentOutOfRangeException::class, StatusCode=400)
open class GetSettlementById : IGetDocumentById
{
    /**
    * Settlement ID or Token
    */
    @ApiMember(Description="Settlement ID or Token", ExcludeInSchema=true, ParameterType="path")
    open var id:UUID? = null
}

open class SettlementMessage
{
    open var header:Header? = null
    open var settlement:Settlement? = null
}

@DataContract
open class Header
{
    @DataMember(Name="documentIdentification")
    @SerializedName("documentIdentification")
    open var documentIdentification:DocumentIdentification? = null

    @DataMember(Name="sender")
    @SerializedName("sender")
    open var sender:Partner? = null

    @DataMember(Name="receiver")
    @SerializedName("receiver")
    open var receiver:Partner? = null
}

@DataContract
open class DocumentIdentification
{
    @DataMember(Name="identifier")
    @SerializedName("identifier")
    open var identifier:String? = null

    @DataMember(Name="type")
    @SerializedName("type")
    open var Type:String? = null

    @DataMember(Name="creationDateAndTime")
    @SerializedName("creationDateAndTime")
    open var creationDateAndTime:Date? = null
}

@DataContract
open class Partner
{
    @DataMember(Name="identifier")
    @SerializedName("identifier")
    open var identifier:Identifier? = null

    @DataMember(Name="contactInformation")
    @SerializedName("contactInformation")
    open var contactInformation:ArrayList<ContactInformation> = ArrayList<ContactInformation>()
}

@DataContract
open class Identifier
{
    @DataMember(Name="authority")
    @SerializedName("authority")
    open var authority:String? = null

    @DataMember(Name="text")
    @SerializedName("text")
    open var text:String? = null
}

@DataContract
open class ContactInformation
{
}

open class Settlement : BaseDocument()
{
    open var batchIdentification:String? = null
    open var paymentEffectiveDate:Date? = null
    open var settlementCurrency:String? = null
    open var settlementHandlingTypeCode:String? = null
    open var totalAmount:BigDecimal? = null
    open var paymentMethod:PaymentMethod? = null
    open var payee:TransactionalParty? = null
    open var payer:TransactionalParty? = null
    open var remitTo:TransactionalParty? = null
    open var settlementIdentification:String? = null
    open var settlementLineItem:ArrayList<SettlementLineItem> = ArrayList<SettlementLineItem>()
    open var extension:SettlementExtension? = null
}

open class BaseDocument
{
    open var currencyCode:String? = null
    open var creationDateTime:Date? = null
    open var documentActionCode:DocumentAction? = null
    open var documentStatusCode:DocumentStatus? = null
    open var documentStructureVersion:String? = null
    open var lastUpdateDateTime:Date? = null
    open var revisionNumber:Long? = null
    open var avpList:ArrayList<AvpList> = ArrayList<AvpList>()
}

enum class DocumentAction
{
    Add,
    ChangeByRefresh,
    Delete,
    Rejected,
}

enum class DocumentStatus
{
    AdditionalTransmission,
    Copy,
    Original,
}

open class AvpList
{
    open var code:String? = null
    open var value:String? = null
}

open class PaymentMethod
{
    open var automatedClearingHousePaymentFormat:String? = null
    open var paymentMethodCode:String? = null
    open var paymentMethodIdentification:String? = null
}

open class TransactionalParty : Ecom_PartyIdentificationType()
{
    open var contact:ArrayList<Contact> = ArrayList<Contact>()
    open var address:Address? = null
    open var communicationChannel:ArrayList<AvpList> = ArrayList<AvpList>()
    open var financialInstitutionInformation:FinancialInstitutionInformation? = null
    open var dutyFeeTaxRegistration:String? = null
    open var entityIdentification:String? = null
}

open class Ecom_PartyIdentificationType
{
    open var gln:String? = null
    open var name:String? = null
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class Contact
{
    open var contactTypeCode:String? = null
    open var personName:String? = null
    open var departmentName:String? = null
    open var jobTitle:String? = null
    open var responsibility:String? = null
    open var communicationChannel:ArrayList<CommunicationChannel> = ArrayList<CommunicationChannel>()
}

open class CommunicationChannel
{
    open var communicationChannelCode:String? = null
    open var communicationChannelName:String? = null
    open var communicationValue:String? = null
}

open class Address
{
    open var streetAddressOne:String? = null
    open var streetAddressTwo:String? = null
    open var streetAddressThree:String? = null
    open var city:String? = null
    open var postalCode:String? = null
    open var provinceCode:String? = null
    open var countryCode:String? = null
}

open class FinancialInstitutionInformation
{
    open var financialInstitutionBranchName:String? = null
    open var financialInstitutionName:String? = null
    open var financialRoutingNumber:FinancialRoutingNumber? = null
    open var financialAccount:FinancialAccount? = null
    open var swiftCode:String? = null
    open var exportersCode:String? = null
}

open class FinancialRoutingNumber
{
    open var number:String? = null
    open var numberTypeCode:String? = null
}

open class FinancialAccount
{
    open var number:String? = null
    open var numberTypeCode:String? = null
    open var name:String? = null
}

open class SettlementLineItem
{
    open var amountPaid:BigDecimal? = null
    open var lineItemNumber:Long? = null
    open var originalAmount:BigDecimal? = null
    open var settlementAdjustment:ArrayList<SettlementAdjustment> = ArrayList<SettlementAdjustment>()
    open var avpList:AvpList? = null
    open var debitCreditAdvice:DocumentReference? = null
    open var invoice:InvoiceDocumentReference? = null
    open var requestForPayment:DocumentReference? = null
    open var settlementParty:ArrayList<SettlementParty> = ArrayList<SettlementParty>()
}

open class SettlementAdjustment
{
    open var adjustmentAmount:BigDecimal? = null
    open var financialAdjusmentReasonPartyRoleCode:String? = null
    open var financialAdjustmentReasonCode:String? = null
    open var transactionalReference:TransactionalReference? = null
}

open class TransactionalReference : DocumentReference()
{
    open var transactionalReferenceTypeCode:String? = null
}

open class DocumentReference
{
    open var creationDateTime:Date? = null
    open var revisionNumber:Long? = null
    open var lineItemNumber:Long? = null
    open var entityIdentification:String? = null
}

open class InvoiceDocumentReference : DocumentReference()
{
    open var invoiceTypeCode:String? = null
    open var contentOwner:ContentOwner? = null
}

open class ContentOwner
{
    open var gln:String? = null
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
}

open class SettlementParty : Ecom_PartyIdentification()
{
    open var partyRoleCode:String? = null
}

open class Ecom_PartyIdentification
{
    open var additionalPartyIdentification:ArrayList<AvpList> = ArrayList<AvpList>()
    open var gln:String? = null
}

open class SettlementExtension
{
    open var settlementExtensionLineItem:ArrayList<SettlementExtensionLineItem> = ArrayList<SettlementExtensionLineItem>()
    open var adjustmentAndDiscountSummary:ArrayList<AdjustmentAndDiscountSummary> = ArrayList<AdjustmentAndDiscountSummary>()
    open var totalAmountSplit:TotalAmountSplit? = null
}

open class SettlementExtensionLineItem
{
    open var number:Int? = null
    open var documentType:String? = null
    open var documentNumber:String? = null
    open var itemText:String? = null
}

open class AdjustmentAndDiscountSummary
{
    open var amountTotal:BigDecimal? = null
    open var amountNett:BigDecimal? = null
    open var amountVat:BigDecimal? = null
    open var reasonMessage:String? = null
}

open class TotalAmountSplit
{
    open var amountTotal:BigDecimal? = null
    open var amountNett:BigDecimal? = null
    open var amountVat:BigDecimal? = null
}

Kotlin 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>