Request Information

Create new payment. Payment should contains id of payed document.

Example URL:
v2.0/ReceivedDocumentPayments

None.

Payment entity for creation

ReceivedDocumentPaymentApiModelInsert
NameDescriptionTypeAdditional information
DateOfPayment

Date of payment

date

None.

DateOfVatApplication

Date of vat application

date

Used in Sk legislation.

InvoiceId

Document Id

integer

Required

PaymentAmount

Payment ammount

decimal number

None.

PaymentOptionId

Payment option id

integer

None.

Sample:
{
  "DateOfPayment": "2021-05-11T09:46:37.0764353+00:00",
  "DateOfVatApplication": "2021-05-11T09:46:37.0764353+00:00",
  "Exported": "sample string 3",
  "InvoiceId": 4,
  "PaymentAmount": 5.0,
  "PaymentOptionId": 6
}
Sample:
<ReceivedDocumentPaymentApiModelInsert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
  <DateOfPayment>2021-05-11T09:46:37.0764353+00:00</DateOfPayment>
  <DateOfVatApplication>2021-05-11T09:46:37.0764353+00:00</DateOfVatApplication>
  <Exported>sample string 3</Exported>
  <InvoiceId>4</InvoiceId>
  <PaymentAmount>5</PaymentAmount>
  <PaymentOptionId>6</PaymentOptionId>
</ReceivedDocumentPaymentApiModelInsert>

Response Information

ReceivedDocumentPaymentApiModel
NameDescriptionTypeAdditional information
CurrencyId

Currency Id

integer

None.

DateCreated

Date created

date

None.

DateLastChange

Date last change

date

None.

DateOfPayment

Date of payment

date

None.

DateOfVatApplication

date

Used in Sk legislation.

ExchangeRate

Exchange rate

decimal number

None.

ExchangeRateAmount

Exchange rate amount

decimal number

None.

Exported

Export to another accounting software indication. (It is recommended to use only one external accounting software beside iDoklad.)

ExportedState

None.

Id

Resource identifier

integer

Readonly

InvoiceDocumentNumber

Invoice document number

string

None.

InvoiceId

Document Id

integer

Required

Partner

Partner

string

None.

PartnerId

Partner id

integer

None.

PaymentAmount

Payment ammount

decimal number

None.

PaymentAmountHc

Payment ammount in home currency

decimal number

None.

PaymentOptionId

Payment option id

integer

None.

Sample:
{
  "CurrencyId": 1,
  "DateCreated": "2021-05-11T09:46:37.0764353+00:00",
  "DateLastChange": "2021-05-11T09:46:37.0764353+00:00",
  "DateOfPayment": "2021-05-11T09:46:37.0764353+00:00",
  "DateOfVatApplication": "2021-05-11T09:46:37.0764353+00:00",
  "ExchangeRate": 6.0,
  "ExchangeRateAmount": 7.0,
  "Exported": 0,
  "InvoiceId": 8,
  "InvoiceDocumentNumber": "sample string 9",
  "Partner": "sample string 10",
  "PartnerId": 11,
  "PaymentAmount": 12.0,
  "PaymentAmountHc": 13.0,
  "PaymentOptionId": 14,
  "Id": 15
}
Sample:
<ReceivedDocumentPaymentApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">15</Id>
  <Links xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Links>
  <CurrencyId>1</CurrencyId>
  <DateCreated>2021-05-11T09:46:37.0764353+00:00</DateCreated>
  <DateLastChange>2021-05-11T09:46:37.0764353+00:00</DateLastChange>
  <DateOfPayment>2021-05-11T09:46:37.0764353+00:00</DateOfPayment>
  <DateOfVatApplication>2021-05-11T09:46:37.0764353+00:00</DateOfVatApplication>
  <ExchangeRate>6</ExchangeRate>
  <ExchangeRateAmount>7</ExchangeRateAmount>
  <Exported>0</Exported>
  <InvoiceDocumentNumber>sample string 9</InvoiceDocumentNumber>
  <InvoiceId>8</InvoiceId>
  <Partner>sample string 10</Partner>
  <PartnerId>11</PartnerId>
  <PaymentAmount>12</PaymentAmount>
  <PaymentAmountHc>13</PaymentAmountHc>
  <PaymentOptionId>14</PaymentOptionId>
</ReceivedDocumentPaymentApiModel>