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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentIdentification:
    identifier: Optional[str] = None
    type: Optional[str] = None
    creation_date_and_time: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Identifier:
    authority: Optional[str] = None
    text: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactInformation:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Partner:
    identifier: Optional[Identifier] = None
    contact_information: List[ContactInformation] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Header:
    document_identification: Optional[DocumentIdentification] = None
    sender: Optional[Partner] = None
    receiver: Optional[Partner] = None


class DocumentAction(str, Enum):
    ADD = 'ADD'
    CHANGE_BY_REFRESH = 'CHANGE_BY_REFRESH'
    DELETE = 'DELETE'
    REJECTED = 'REJECTED'


class DocumentStatus(str, Enum):
    ADDITIONAL_TRANSMISSION = 'ADDITIONAL_TRANSMISSION'
    COPY = 'COPY'
    ORIGINAL = 'ORIGINAL'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvpList:
    code: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseDocument:
    currency_code: Optional[str] = None
    creation_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    document_action_code: Optional[DocumentAction] = None
    document_status_code: Optional[DocumentStatus] = None
    document_structure_version: Optional[str] = None
    last_update_date_time: Optional[datetime.datetime] = None
    revision_number: Optional[int] = None
    avp_list: List[AvpList] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentMethod:
    automated_clearing_house_payment_format: Optional[str] = None
    payment_method_code: Optional[str] = None
    payment_method_identification: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Ecom_PartyIdentificationType:
    gln: Optional[str] = None
    name: Optional[str] = None
    additional_party_identification: List[AvpList] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommunicationChannel:
    communication_channel_code: Optional[str] = None
    communication_channel_name: Optional[str] = None
    communication_value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Contact:
    contact_type_code: Optional[str] = None
    person_name: Optional[str] = None
    department_name: Optional[str] = None
    job_title: Optional[str] = None
    responsibility: Optional[str] = None
    communication_channel: List[CommunicationChannel] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
    street_address_one: Optional[str] = None
    street_address_two: Optional[str] = None
    street_address_three: Optional[str] = None
    city: Optional[str] = None
    postal_code: Optional[str] = None
    province_code: Optional[str] = None
    country_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialRoutingNumber:
    number: Optional[str] = None
    number_type_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAccount:
    number: Optional[str] = None
    number_type_code: Optional[str] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialInstitutionInformation:
    financial_institution_branch_name: Optional[str] = None
    financial_institution_name: Optional[str] = None
    financial_routing_number: Optional[FinancialRoutingNumber] = None
    financial_account: Optional[FinancialAccount] = None
    swift_code: Optional[str] = None
    exporters_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionalParty(Ecom_PartyIdentificationType):
    contact: List[Contact] = field(default_factory=list)
    address: Optional[Address] = None
    communication_channel: List[AvpList] = field(default_factory=list)
    financial_institution_information: Optional[FinancialInstitutionInformation] = None
    duty_fee_tax_registration: Optional[str] = None
    entity_identification: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentReference:
    creation_date_time: Optional[datetime.datetime] = None
    revision_number: Optional[int] = None
    line_item_number: Optional[int] = None
    entity_identification: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TransactionalReference(DocumentReference):
    transactional_reference_type_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettlementAdjustment:
    adjustment_amount: Optional[Decimal] = None
    financial_adjusment_reason_party_role_code: Optional[str] = None
    financial_adjustment_reason_code: Optional[str] = None
    transactional_reference: Optional[TransactionalReference] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContentOwner:
    gln: Optional[str] = None
    additional_party_identification: List[AvpList] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InvoiceDocumentReference(DocumentReference):
    invoice_type_code: Optional[str] = None
    content_owner: Optional[ContentOwner] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Ecom_PartyIdentification:
    additional_party_identification: List[AvpList] = field(default_factory=list)
    gln: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettlementParty(Ecom_PartyIdentification):
    party_role_code: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettlementLineItem:
    amount_paid: Optional[Decimal] = None
    line_item_number: int = 0
    original_amount: Optional[Decimal] = None
    settlement_adjustment: List[SettlementAdjustment] = field(default_factory=list)
    avp_list: Optional[AvpList] = None
    debit_credit_advice: Optional[DocumentReference] = None
    invoice: Optional[InvoiceDocumentReference] = None
    request_for_payment: Optional[DocumentReference] = None
    settlement_party: List[SettlementParty] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettlementExtensionLineItem:
    number: int = 0
    document_type: Optional[str] = None
    document_number: Optional[str] = None
    item_text: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdjustmentAndDiscountSummary:
    amount_total: Decimal = decimal.Decimal(0)
    amount_nett: Decimal = decimal.Decimal(0)
    amount_vat: Decimal = decimal.Decimal(0)
    reason_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TotalAmountSplit:
    amount_total: Decimal = decimal.Decimal(0)
    amount_nett: Decimal = decimal.Decimal(0)
    amount_vat: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettlementExtension:
    settlement_extension_line_item: List[SettlementExtensionLineItem] = field(default_factory=list)
    adjustment_and_discount_summary: List[AdjustmentAndDiscountSummary] = field(default_factory=list)
    total_amount_split: Optional[TotalAmountSplit] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Settlement(BaseDocument):
    batch_identification: Optional[str] = None
    payment_effective_date: datetime.datetime = datetime.datetime(1, 1, 1)
    settlement_currency: Optional[str] = None
    settlement_handling_type_code: Optional[str] = None
    total_amount: Optional[Decimal] = None
    payment_method: Optional[PaymentMethod] = None
    payee: Optional[TransactionalParty] = None
    payer: Optional[TransactionalParty] = None
    remit_to: Optional[TransactionalParty] = None
    settlement_identification: Optional[str] = None
    settlement_line_item: List[SettlementLineItem] = field(default_factory=list)
    extension: Optional[SettlementExtension] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SettlementMessage:
    header: Optional[Header] = None
    settlement: Optional[Settlement] = None


# @Api(Description="Settlement")
# @ApiResponse(Description="Settlement data", IsDefaultResponse=true, StatusCode=200)
# @ApiResponse(Description="No Content", ResponseType=typeof(IReturnVoid), StatusCode=204)
# @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType=typeof(ArgumentOutOfRangeException), StatusCode=400)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSettlementById(IGetDocumentById):
    """
    Settlement
    """

    # @ApiMember(Description="Settlement ID or Token", ExcludeInSchema=true, ParameterType="path")
    id: Optional[str] = None
    """
    Settlement ID or Token
    """

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