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 .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
			}
		]
	}
}