Request Information

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

Example URL:
v2.0/IssuedDocumentPayments

None.

Payment entity for creation

IssuedDocumentPaymentApiModelInsert
NameDescriptionTypeAdditional information
DateOfPayment

Date of payment

date

None.

DateOfVatApplication

Date of vat application

date

Used in Sk legislation.

ElectronicRecordsOfSales

Electronic records of sales information.

ElectronicRecordsOfSalesApiModel

Used in Cz legislation.

InvoiceId

Document Id

integer

Required

PaymentAmount

Payment ammount

decimal number

None.

PaymentOptionId

Payment option id

integer

None.

SalesPosEquipmentId

POS equipment Id.

integer

Used in Cz legislation.

SendPaymentConfirmation

Send payment confirmation

boolean

None.

Sample:
{
  "ElectronicRecordsOfSales": {
    "EetStatus": 1,
    "IsEet": true,
    "RegisteredSale": {
      "BaseTaxBasicRateHc": 1.0,
      "BaseTaxReducedRate1Hc": 2.0,
      "BaseTaxReducedRate2Hc": 3.0,
      "BaseTaxZeroRateHc": 4.0,
      "Bkp": "sample string 5",
      "DateOfAnswer": "2021-05-07T01:36:04.8878917+00:00",
      "DateOfSale": "2021-05-07T01:36:04.8878917+00:00",
      "DateOfSend": "2021-05-07T01:36:04.8878917+00:00",
      "Fik": "sample string 9",
      "Pkp": "sample string 10",
      "ReceiptNumber": "sample string 11",
      "SalesOfficeDesignation": 12,
      "SalesPosEquipmentId": 1,
      "TaxBasicRateHc": 13.0,
      "TaxReducedRate1Hc": 14.0,
      "TaxReducedRate2Hc": 15.0,
      "TotalAdvancePayment": 16.0,
      "TotalFromAdvancePayment": 17.0,
      "TotalTravelServiceHc": 18.0,
      "TotalUsedGoodsBasicRateHc": 19.0,
      "TotalUsedGoodsReducedRate1Hc": 20.0,
      "TotalUsedGoodsReducedRate2Hc": 21.0,
      "TotalWithVatHc": 22.0,
      "Uuid": "8b987bd6-1036-46c5-a3af-9089616ae8d3",
      "VatIdentificationNumber": "sample string 24"
    },
    "EetResponsibility": 0
  },
  "SalesPosEquipmentId": 1,
  "SendPaymentConfirmation": true,
  "DateOfPayment": "2021-05-07T01:36:04.8878917+00:00",
  "DateOfVatApplication": "2021-05-07T01:36:04.8878917+00:00",
  "Exported": "sample string 3",
  "InvoiceId": 4,
  "PaymentAmount": 5.0,
  "PaymentOptionId": 6
}
Sample:
<IssuedDocumentPaymentApiModelInsert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
  <DateOfPayment>2021-05-07T01:36:04.8878917+00:00</DateOfPayment>
  <DateOfVatApplication>2021-05-07T01:36:04.8878917+00:00</DateOfVatApplication>
  <Exported>sample string 3</Exported>
  <InvoiceId>4</InvoiceId>
  <PaymentAmount>5</PaymentAmount>
  <PaymentOptionId>6</PaymentOptionId>
  <ElectronicRecordsOfSales>
    <EetResponsibility>Idoklad</EetResponsibility>
    <EetStatus>NotRegistered</EetStatus>
    <IsEet>true</IsEet>
    <RegisteredSale>
      <BaseTaxBasicRateHc>1</BaseTaxBasicRateHc>
      <BaseTaxReducedRate1Hc>2</BaseTaxReducedRate1Hc>
      <BaseTaxReducedRate2Hc>3</BaseTaxReducedRate2Hc>
      <BaseTaxZeroRateHc>4</BaseTaxZeroRateHc>
      <Bkp>sample string 5</Bkp>
      <DateOfAnswer>2021-05-07T01:36:04.8878917+00:00</DateOfAnswer>
      <DateOfSale>2021-05-07T01:36:04.8878917+00:00</DateOfSale>
      <DateOfSend>2021-05-07T01:36:04.8878917+00:00</DateOfSend>
      <Fik>sample string 9</Fik>
      <Pkp>sample string 10</Pkp>
      <ReceiptNumber>sample string 11</ReceiptNumber>
      <SalesOfficeDesignation>12</SalesOfficeDesignation>
      <SalesPosEquipmentId>1</SalesPosEquipmentId>
      <TaxBasicRateHc>13</TaxBasicRateHc>
      <TaxReducedRate1Hc>14</TaxReducedRate1Hc>
      <TaxReducedRate2Hc>15</TaxReducedRate2Hc>
      <TotalAdvancePayment>16</TotalAdvancePayment>
      <TotalFromAdvancePayment>17</TotalFromAdvancePayment>
      <TotalTravelServiceHc>18</TotalTravelServiceHc>
      <TotalUsedGoodsBasicRateHc>19</TotalUsedGoodsBasicRateHc>
      <TotalUsedGoodsReducedRate1Hc>20</TotalUsedGoodsReducedRate1Hc>
      <TotalUsedGoodsReducedRate2Hc>21</TotalUsedGoodsReducedRate2Hc>
      <TotalWithVatHc>22</TotalWithVatHc>
      <Uuid>8b987bd6-1036-46c5-a3af-9089616ae8d3</Uuid>
      <VatIdentificationNumber>sample string 24</VatIdentificationNumber>
    </RegisteredSale>
  </ElectronicRecordsOfSales>
  <SalesPosEquipmentId>1</SalesPosEquipmentId>
  <SendPaymentConfirmation>true</SendPaymentConfirmation>
</IssuedDocumentPaymentApiModelInsert>

Response Information

IssuedDocumentPaymentApiModel
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.

EetResponsibility

Responsibility for handlig of electronic records of sales of payments document

EetResponsibility

Used in Cz 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

IsConfirmationSent

boolean

None.

IsEet

Indicates whether the document of payment is registered in electronics records of sales.

boolean

Used in Cz legislation.

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.

RegisteredSale

Registered sale

RegisteredSaleApiModel

Used in Cz legislation.

Sample:
{
  "EetResponsibility": 0,
  "IsEet": true,
  "RegisteredSale": {
    "BaseTaxBasicRateHc": 1.0,
    "BaseTaxReducedRate1Hc": 2.0,
    "BaseTaxReducedRate2Hc": 3.0,
    "BaseTaxZeroRateHc": 4.0,
    "Bkp": "sample string 5",
    "CancelledRegisteredSaleId": 1,
    "CashVoucherId": 1,
    "DateOfAnswer": "2021-05-07T01:36:04.8878917+00:00",
    "DateOfSale": "2021-05-07T01:36:04.8878917+00:00",
    "DateOfSend": "2021-05-07T01:36:04.8878917+00:00",
    "DocumentNumber": "sample string 9",
    "DocumentType": 0,
    "EetRegime": 0,
    "ErrorCode": 10,
    "ErrorText": "sample string 11",
    "Fik": "sample string 12",
    "IsCanceled": true,
    "IsFirstReport": true,
    "IssuedInvoiceId": 1,
    "IssuedInvoicePaymentId": 1,
    "Pkp": "sample string 15",
    "ReceiptNumber": "sample string 16",
    "SalesOfficeDesignation": 17,
    "SalesPosEquipmentDesignation": "sample string 18",
    "SalesPosEquipmentId": 1,
    "SalesReceiptId": 1,
    "Status": 0,
    "TaxBasicRateHc": 19.0,
    "TaxReducedRate1Hc": 20.0,
    "TaxReducedRate2Hc": 21.0,
    "TotalAdvancePayment": 22.0,
    "TotalFromAdvancePayment": 23.0,
    "TotalTravelServiceHc": 24.0,
    "TotalUsedGoodsBasicRateHc": 25.0,
    "TotalUsedGoodsReducedRate1Hc": 26.0,
    "TotalUsedGoodsReducedRate2Hc": 27.0,
    "TotalWithVatHc": 28.0,
    "Uuid": "24f512ff-3b8e-4383-b010-d63153ab9cfc",
    "VatIdentificationNumber": "sample string 30",
    "Id": 31
  },
  "IsConfirmationSent": true,
  "CurrencyId": 3,
  "DateCreated": "2021-05-07T01:36:04.8878917+00:00",
  "DateLastChange": "2021-05-07T01:36:04.8878917+00:00",
  "DateOfPayment": "2021-05-07T01:36:04.8878917+00:00",
  "DateOfVatApplication": "2021-05-07T01:36:04.8878917+00:00",
  "ExchangeRate": 8.0,
  "ExchangeRateAmount": 9.0,
  "Exported": 0,
  "InvoiceId": 10,
  "InvoiceDocumentNumber": "sample string 11",
  "Partner": "sample string 12",
  "PartnerId": 13,
  "PaymentAmount": 14.0,
  "PaymentAmountHc": 15.0,
  "PaymentOptionId": 16,
  "Id": 17
}
Sample:
<IssuedDocumentPaymentApiModel 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">17</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>3</CurrencyId>
  <DateCreated>2021-05-07T01:36:04.8878917+00:00</DateCreated>
  <DateLastChange>2021-05-07T01:36:04.8878917+00:00</DateLastChange>
  <DateOfPayment>2021-05-07T01:36:04.8878917+00:00</DateOfPayment>
  <DateOfVatApplication>2021-05-07T01:36:04.8878917+00:00</DateOfVatApplication>
  <ExchangeRate>8</ExchangeRate>
  <ExchangeRateAmount>9</ExchangeRateAmount>
  <Exported>0</Exported>
  <InvoiceDocumentNumber>sample string 11</InvoiceDocumentNumber>
  <InvoiceId>10</InvoiceId>
  <Partner>sample string 12</Partner>
  <PartnerId>13</PartnerId>
  <PaymentAmount>14</PaymentAmount>
  <PaymentAmountHc>15</PaymentAmountHc>
  <PaymentOptionId>16</PaymentOptionId>
  <EetResponsibility>Idoklad</EetResponsibility>
  <IsConfirmationSent>true</IsConfirmationSent>
  <IsEet>true</IsEet>
  <RegisteredSale>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">31</Id>
    <Links xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Links>
    <BaseTaxBasicRateHc>1</BaseTaxBasicRateHc>
    <BaseTaxReducedRate1Hc>2</BaseTaxReducedRate1Hc>
    <BaseTaxReducedRate2Hc>3</BaseTaxReducedRate2Hc>
    <BaseTaxZeroRateHc>4</BaseTaxZeroRateHc>
    <Bkp>sample string 5</Bkp>
    <CancelledRegisteredSaleId>1</CancelledRegisteredSaleId>
    <CashVoucherId>1</CashVoucherId>
    <DateOfAnswer>2021-05-07T01:36:04.8878917+00:00</DateOfAnswer>
    <DateOfSale>2021-05-07T01:36:04.8878917+00:00</DateOfSale>
    <DateOfSend>2021-05-07T01:36:04.8878917+00:00</DateOfSend>
    <DocumentNumber>sample string 9</DocumentNumber>
    <DocumentType>IssuedInvoice</DocumentType>
    <EetRegime>None</EetRegime>
    <ErrorCode>10</ErrorCode>
    <ErrorText>sample string 11</ErrorText>
    <Fik>sample string 12</Fik>
    <IsCanceled>true</IsCanceled>
    <IsFirstReport>true</IsFirstReport>
    <IssuedInvoiceId>1</IssuedInvoiceId>
    <IssuedInvoicePaymentId>1</IssuedInvoicePaymentId>
    <Pkp>sample string 15</Pkp>
    <ReceiptNumber>sample string 16</ReceiptNumber>
    <SalesOfficeDesignation>17</SalesOfficeDesignation>
    <SalesPosEquipmentDesignation>sample string 18</SalesPosEquipmentDesignation>
    <SalesPosEquipmentId>1</SalesPosEquipmentId>
    <SalesReceiptId>1</SalesReceiptId>
    <Status>New</Status>
    <TaxBasicRateHc>19</TaxBasicRateHc>
    <TaxReducedRate1Hc>20</TaxReducedRate1Hc>
    <TaxReducedRate2Hc>21</TaxReducedRate2Hc>
    <TotalAdvancePayment>22</TotalAdvancePayment>
    <TotalFromAdvancePayment>23</TotalFromAdvancePayment>
    <TotalTravelServiceHc>24</TotalTravelServiceHc>
    <TotalUsedGoodsBasicRateHc>25</TotalUsedGoodsBasicRateHc>
    <TotalUsedGoodsReducedRate1Hc>26</TotalUsedGoodsReducedRate1Hc>
    <TotalUsedGoodsReducedRate2Hc>27</TotalUsedGoodsReducedRate2Hc>
    <TotalWithVatHc>28</TotalWithVatHc>
    <Uuid>24f512ff-3b8e-4383-b010-d63153ab9cfc</Uuid>
    <VatIdentificationNumber>sample string 30</VatIdentificationNumber>
  </RegisteredSale>
</IssuedDocumentPaymentApiModel>