POST api/externaltransaction/cashMovements

For external parties to call and provide instructions to move cash for an external product.

Request Information

URI Parameters

None.

Body Parameters

ExternalTransactionCreation
NameDescriptionTypeAdditional information
TransactionDate

Date

Required

SettlementDate

Date

Required

ExternalTransactionType

enExternalTransactionType

Required

JournalEntries

Collection of JournalEntrySingleTransaction

None.

Request Formats

application/json, text/json

Sample:
{
  "TransactionDate": "2021-11-1",
  "SettlementDate": "2021-11-2",
  "ExternalTransactionType": 6,
  "JournalEntries": [
    {
      "AccountID": 100101,
      "Reference": 1009,
      "Amount": 500.55,
      "DrCr": 2,
      "Description": "Credit entry"
    },
    {
      "AccountID": 100102,
      "Reference": 1009,
      "Amount": 500.55,
      "DrCr": 1,
      "Description": "Debit entry"
    }
  ]
}

application/xml, text/xml

Sample:
<ExternalTransactionCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ExternalTransaction">
  <ExternalTransactionType xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ExternalTransaction.Base">Ledger</ExternalTransactionType>
  <JournalEntries xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ExternalTransaction" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ExternalTransaction.Base">
    <d2p1:JournalEntrySingleTransaction>
      <AccountID>100101</AccountID>
      <Amount>500.55</Amount>
      <Description>Credit entry</Description>
      <DrCr>CR</DrCr>
      <Reference>1009</Reference>
    </d2p1:JournalEntrySingleTransaction>
    <d2p1:JournalEntrySingleTransaction>
      <AccountID>100102</AccountID>
      <Amount>500.55</Amount>
      <Description>Debit entry</Description>
      <DrCr>DR</DrCr>
      <Reference>1009</Reference>
    </d2p1:JournalEntrySingleTransaction>
  </JournalEntries>
  <SettlementDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ExternalTransaction.Base" />
  <TransactionDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ExternalTransaction.Base" />
</ExternalTransactionCreation>

Response Information

Resource Description

StatusCodeResult
NameDescriptionTypeAdditional information
StatusCode

HttpStatusCode

None.

Request

HttpRequestMessage

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

Error Response Information

Resource Description

BadRequestResult
NameDescriptionTypeAdditional information
Errors

Collection of Error

None.

Error Response Formats

application/json, text/json

Sample:
{
  "Errors": [
    {
      "Code": 10001,
      "Description": "sample string 1"
    },
    {
      "Code": 10001,
      "Description": "sample string 1"
    }
  ]
}