Request Information

Pairs a model with an invoice according to the variable symbol and currency.

Example URL:
v2.0/BankStatements/Pair

None.

BankStatementPairingModel
NameDescriptionTypeAdditional information
AccountNumber

Your account number.

string

Length: between 0 and 50 inclusive

Used in Cz legislation.

Amount

Amount sent

decimal number

Required

Balance

Account balance

decimal number

Required

BankCode

Bank code

string

Length: between 0 and 10 inclusive

Used in Cz legislation.

ConstantSymbol

Constant symbol

string

Length: between 0 and 4 inclusive

CurrencyCode

Currency code

string

Required

Length: between 0 and 3 inclusive

DateOfTransaction

Date of transaction. If not set, the current date will be used.

date

None.

Iban

Váš iban

string

Length: between 0 and 50 inclusive

Used in Sk legislation.

MessageForPartner

Message for the partner

string

Length: between 0 and 200 inclusive

MovementType

Movement type

MovementType

Required

PartnerAccountNumber

The partner's account number

string

Length: between 0 and 50 inclusive

PartnerBankCode

The partner's bank code

string

Length: between 0 and 10 inclusive

PartnerIban

The partner's IBAN

string

Length: between 0 and 50 inclusive

SpecificSymbol

Specific symbol

string

Length: between 0 and 10 inclusive

VariableSymbol

Variable symbol

string

Required

Length: between 0 and 10 inclusive

Sample:
{
  "AccountNumber": "sample string 1",
  "Amount": 2.0,
  "Balance": 3.0,
  "BankCode": "sample string 4",
  "MovementType": 1,
  "ConstantSymbol": "sample string 5",
  "CurrencyCode": "sample string 6",
  "DateOfTransaction": "2021-05-09T06:26:37.4364245+00:00",
  "Iban": "sample string 7",
  "MessageForPartner": "sample string 8",
  "PartnerAccountNumber": "sample string 9",
  "PartnerBankCode": "sample string 10",
  "PartnerIban": "sample string 11",
  "SpecificSymbol": "sample string 12",
  "VariableSymbol": "sample string 13"
}
Sample:
<BankStatementPairingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BankStatement">
  <AccountNumber>sample string 1</AccountNumber>
  <Amount>2</Amount>
  <Balance>3</Balance>
  <BankCode>sample string 4</BankCode>
  <ConstantSymbol>sample string 5</ConstantSymbol>
  <CurrencyCode>sample string 6</CurrencyCode>
  <DateOfTransaction>2021-05-09T06:26:37.4364245+00:00</DateOfTransaction>
  <Iban>sample string 7</Iban>
  <MessageForPartner>sample string 8</MessageForPartner>
  <MovementType>Entry</MovementType>
  <PartnerAccountNumber>sample string 9</PartnerAccountNumber>
  <PartnerBankCode>sample string 10</PartnerBankCode>
  <PartnerIban>sample string 11</PartnerIban>
  <SpecificSymbol>sample string 12</SpecificSymbol>
  <VariableSymbol>sample string 13</VariableSymbol>
</BankStatementPairingModel>

Response Information

BankStatementPairingResult
NameDescriptionTypeAdditional information
CreatedBankStatement

BankStatementGetModel

None.

Message

string

None.

PairedInvoiceId

integer

None.

WasPaired

boolean

None.

Sample:
{
  "WasPaired": true,
  "CreatedBankStatement": {
    "BankAccountId": 1,
    "CurrentBalance": 2.0,
    "DateCreated": "2021-05-09T06:26:37.4364245+00:00",
    "DateLastChange": "2021-05-09T06:26:37.4364245+00:00",
    "DocumentNumber": "sample string 5",
    "DocumentSerialNumber": 6,
    "Id": 7,
    "Items": [
      {
        "Id": 1,
        "DateOfTransaction": "2021-05-09T06:26:37.436",
        "MovementType": 1,
        "PaidAmount": 3.0,
        "PaidAmountHc": 4.0,
        "CurrencyId": 5,
        "ExchangeRate": 6.0,
        "ExchangeRateAmount": 7.0,
        "VariableSymbol": "sample string 8",
        "PartnerAccountNumber": "sample string 9",
        "PartnerBankCode": "sample string 10",
        "Text": "sample string 11",
        "SpecificSymbol": "sample string 12",
        "IsPaired": true,
        "ConstantSymbolId": true,
        "PriceType": 0,
        "VatRate": 15.0,
        "VatRateType": 0,
        "PriceTotalWithVat": 16.0,
        "PartnerIban": "sample string 17",
        "PartnerSwift": "sample string 18",
        "IsIncomeTax": true,
        "RecountVersion": 0
      }
    ],
    "NumericSequenceId": 8,
    "PeriodDateFrom": "2021-05-09T06:26:37.4364245+00:00",
    "PeriodDateTo": "2021-05-09T06:26:37.4364245+00:00"
  },
  "PairedInvoiceId": 2,
  "Message": "sample string 3"
}
Sample:
<BankStatementPairingResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BankStatement">
  <CreatedBankStatement>
    <BankAccountId>1</BankAccountId>
    <CurrentBalance>2</CurrentBalance>
    <DateCreated>2021-05-09T06:26:37.4364245+00:00</DateCreated>
    <DateLastChange>2021-05-09T06:26:37.4364245+00:00</DateLastChange>
    <DocumentNumber>sample string 5</DocumentNumber>
    <DocumentSerialNumber>6</DocumentSerialNumber>
    <Id>7</Id>
    <Items>
      <BankStatementItemGetModel>
        <ConstantSymbolId>true</ConstantSymbolId>
        <CurrencyId>5</CurrencyId>
        <DateOfTransaction>2021-05-09T06:26:37.4364245+00:00</DateOfTransaction>
        <ExchangeRate>6</ExchangeRate>
        <ExchangeRateAmount>7</ExchangeRateAmount>
        <Id>1</Id>
        <IsIncomeTax>true</IsIncomeTax>
        <IsPaired>true</IsPaired>
        <MovementType>Entry</MovementType>
        <PaidAmount>3</PaidAmount>
        <PaidAmountHc>4</PaidAmountHc>
        <PartnerAccountNumber>sample string 9</PartnerAccountNumber>
        <PartnerBankCode>sample string 10</PartnerBankCode>
        <PartnerIban>sample string 17</PartnerIban>
        <PartnerSwift>sample string 18</PartnerSwift>
        <PriceTotalWithVat>16</PriceTotalWithVat>
        <PriceType>0</PriceType>
        <RecountVersion>None</RecountVersion>
        <SpecificSymbol>sample string 12</SpecificSymbol>
        <Text>sample string 11</Text>
        <VariableSymbol>sample string 8</VariableSymbol>
        <VatRate>15</VatRate>
        <VatRateType>0</VatRateType>
      </BankStatementItemGetModel>
    </Items>
    <NumericSequenceId>8</NumericSequenceId>
    <PeriodDateFrom>2021-05-09T06:26:37.4364245+00:00</PeriodDateFrom>
    <PeriodDateTo>2021-05-09T06:26:37.4364245+00:00</PeriodDateTo>
  </CreatedBankStatement>
  <Message>sample string 3</Message>
  <PairedInvoiceId>2</PairedInvoiceId>
  <WasPaired>true</WasPaired>
</BankStatementPairingResult>