Request Information

Create new cash voucher.

Example URL:
v2.0/CashVouchers

None.

Cash voucher model for creation.

CashVoucherApiModelInsert
NameDescriptionTypeAdditional information
CashRegisterId

Cash register id

integer

None.

DateOfTransaction

The date of transaction

date

Required

DocumentSerialNumber

Document Serial Number

integer

None.

ElectronicRecordsOfSales

Electronic records of sales information.

ElectronicRecordsOfSalesApiModel

None.

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.

IsIncomeTax

Include subject to income tax

boolean

Used in Cz legislation.

Item

Model of entity for inserting a new item.

CashVoucherItemApiModelInsert

Only returns the first item. Use Items.

Items

Model of entity for inserting a new item.

Collection of CashVoucherItemApiModelInsert

None.

MovementType

The movement type (issue/entry)

MovementType

None.

MyCompanyDocumentAddressId

Id of your contact information at the time of saving.

integer

Not used, will be ignored.

Name

Document name or description

string

Length: between 0 and 200 inclusive

PartnerContactId

Id of the partner's contact.

integer

None.

PartnerDocumentAddressId

Id of the partner's contact at the time of saving.

integer

Not used, will be ignored.

Person

Name of the supplier/customer. Can also be used as a note.

string

Length: between 0 and 100 inclusive

VariableSymbol

Variable symbol

string

Length: between 0 and 10 inclusive

Sample:
{
  "CashRegisterId": 1,
  "DateOfTransaction": "2021-05-11T10:19:25.765982+00:00",
  "DocumentSerialNumber": 3,
  "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-11T10:19:25.765982+00:00",
      "DateOfSale": "2021-05-11T10:19:25.765982+00:00",
      "DateOfSend": "2021-05-11T10:19:25.765982+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": "0d7f501a-b29e-48fc-ad82-c096021c4db1",
      "VatIdentificationNumber": "sample string 24"
    },
    "EetResponsibility": 0
  },
  "ExchangeRate": 1.0,
  "ExchangeRateAmount": 1.0,
  "Exported": 0,
  "Item": {
    "Amount": 1.0,
    "CustomVatRate": 1.0,
    "Name": "sample string 2",
    "Price": 3.0,
    "PriceType": 0,
    "Status": 64,
    "VariableSymbol": "sample string 5",
    "VatRate": 6.0,
    "VatRateType": 0
  },
  "Items": [
    {
      "Amount": 1.0,
      "CustomVatRate": 1.0,
      "Name": "sample string 2",
      "Price": 3.0,
      "PriceType": 0,
      "Status": 64,
      "VariableSymbol": "sample string 5",
      "VatRate": 6.0,
      "VatRateType": 0
    }
  ],
  "MovementType": 1,
  "MyCompanyDocumentAddressId": 1,
  "Name": "sample string 4",
  "PartnerContactId": 1,
  "PartnerDocumentAddressId": 1,
  "Person": "sample string 5",
  "VariableSymbol": "sample string 6",
  "IsIncomeTax": true
}
Sample:
<CashVoucherApiModelInsert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
  <CashRegisterId>1</CashRegisterId>
  <DateOfTransaction>2021-05-11T10:19:25.765982+00:00</DateOfTransaction>
  <DocumentSerialNumber>3</DocumentSerialNumber>
  <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-11T10:19:25.765982+00:00</DateOfAnswer>
      <DateOfSale>2021-05-11T10:19:25.765982+00:00</DateOfSale>
      <DateOfSend>2021-05-11T10:19:25.765982+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>0d7f501a-b29e-48fc-ad82-c096021c4db1</Uuid>
      <VatIdentificationNumber>sample string 24</VatIdentificationNumber>
    </RegisteredSale>
  </ElectronicRecordsOfSales>
  <ExchangeRate>1</ExchangeRate>
  <ExchangeRateAmount>1</ExchangeRateAmount>
  <Exported>0</Exported>
  <IsIncomeTax>true</IsIncomeTax>
  <Item>
    <Amount>1</Amount>
    <CustomVatRate>1</CustomVatRate>
    <Name>sample string 2</Name>
    <Price>3</Price>
    <PriceType>WithVat</PriceType>
    <Status>64</Status>
    <VariableSymbol>sample string 5</VariableSymbol>
    <VatRate>6</VatRate>
    <VatRateType>0</VatRateType>
  </Item>
  <Items>
    <CashVoucherItemApiModelInsert>
      <Amount>1</Amount>
      <CustomVatRate>1</CustomVatRate>
      <Name>sample string 2</Name>
      <Price>3</Price>
      <PriceType>WithVat</PriceType>
      <Status>64</Status>
      <VariableSymbol>sample string 5</VariableSymbol>
      <VatRate>6</VatRate>
      <VatRateType>0</VatRateType>
    </CashVoucherItemApiModelInsert>
  </Items>
  <MovementType>Entry</MovementType>
  <MyCompanyDocumentAddressId>1</MyCompanyDocumentAddressId>
  <Name>sample string 4</Name>
  <PartnerContactId>1</PartnerContactId>
  <PartnerDocumentAddressId>1</PartnerDocumentAddressId>
  <Person>sample string 5</Person>
  <VariableSymbol>sample string 6</VariableSymbol>
</CashVoucherApiModelInsert>

Response Information

CashVoucherApiModel
NameDescriptionTypeAdditional information
CashRegisterId

Cash register id

integer

None.

CurrencyId

The currency id.

integer

None.

DateLastChange

Date since the last change

date

Readonly

DateOfTransaction

The date of transaction

date

Required

DocumentNumber

DocumentNumber

string

None.

DocumentSerialNumber

Document Serial Number

integer

None.

EetResponsibility

Responsibility for handlig of electronic records of sales

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

IsEet

Indicates whether the cash voucher is registered in EET.

boolean

None.

IsIncomeTax

Include subject to income tax

boolean

Used in Cz legislation.

IsSummarySalesReceipt

Flag for summary cash vouchers from sales receipts

boolean

None.

Item

[Deprecated - Only returns the first item] The cash voucher item.

CashVoucherItemApiModel

Only returns the first item. Use Items.

Items

The cash voucher items.

Collection of CashVoucherItemApiModel

None.

MovementType

The movement type (issue/entry)

MovementType

None.

MyCompanyDocumentAddressId

Id of your contact information at the time of saving.

integer

None.

Name

Document name or descritpion

string

None.

PartnerContactId

Id of the partner's contact.

integer

None.

PartnerDocumentAddressId

Id of the partner's contact at the time of saving.

integer

None.

Person

Name of the supplier/customer. Can also be used as a note.

string

None.

RecountVersion

Recount Version

RecountVersion

None.

RegisteredSale

Registered sale

RegisteredSaleApiModel

None.

SummarySalesReceiptDate

Date of accounting

date

None.

TotalVat

Total amount of VAT in used currency

decimal number

Readonly

TotalVatHc

Total amount of VAT in home currency

decimal number

Readonly

TotalWithoutVat

Total amount without VAT in the used currency.

decimal number

Readonly

TotalWithoutVatHc

Total amount without VAT in home currency

decimal number

Readonly

TotalWithVat

Total amount with VAT in used currency

decimal number

Readonly

TotalWithVatHc

Total amount with VAT in home currency

decimal number

Readonly

VariableSymbol

Variable symbol

string

None.

Sample:
{
  "CashRegisterId": 1,
  "CurrencyId": 2,
  "DateLastChange": "2021-05-11T10:19:25.765982+00:00",
  "DateOfTransaction": "2021-05-11T10:19:25.765982+00:00",
  "DocumentNumber": "sample string 5",
  "DocumentSerialNumber": 6,
  "EetResponsibility": 0,
  "ExchangeRate": 1.0,
  "ExchangeRateAmount": 1.0,
  "Exported": 0,
  "IsEet": true,
  "IsSummarySalesReceipt": true,
  "Item": {
    "Amount": 1.0,
    "Name": "sample string 2",
    "Price": 3.0,
    "PriceTotalWithoutVat": 4.0,
    "PriceTotalWithoutVatHc": 5.0,
    "PriceTotalWithVat": 6.0,
    "PriceTotalWithVatHc": 7.0,
    "PriceType": 0,
    "Status": 64,
    "VariableSymbol": "sample string 9",
    "VatRate": 10.0,
    "VatRateType": 0,
    "VatTotal": 11.0,
    "VatTotalHc": 12.0,
    "Id": 13
  },
  "Items": [
    {
      "Amount": 1.0,
      "Name": "sample string 2",
      "Price": 3.0,
      "PriceTotalWithoutVat": 4.0,
      "PriceTotalWithoutVatHc": 5.0,
      "PriceTotalWithVat": 6.0,
      "PriceTotalWithVatHc": 7.0,
      "PriceType": 0,
      "Status": 64,
      "VariableSymbol": "sample string 9",
      "VatRate": 10.0,
      "VatRateType": 0,
      "VatTotal": 11.0,
      "VatTotalHc": 12.0,
      "Id": 13
    }
  ],
  "MovementType": 1,
  "MyCompanyDocumentAddressId": 1,
  "Name": "sample string 9",
  "PartnerContactId": 1,
  "PartnerDocumentAddressId": 1,
  "Person": "sample string 10",
  "RegisteredSale": {
    "BaseTaxBasicRateHc": 1.0,
    "BaseTaxReducedRate1Hc": 2.0,
    "BaseTaxReducedRate2Hc": 3.0,
    "BaseTaxZeroRateHc": 4.0,
    "Bkp": "sample string 5",
    "CancelledRegisteredSaleId": 1,
    "CashVoucherId": 1,
    "DateOfAnswer": "2021-05-11T10:19:25.765982+00:00",
    "DateOfSale": "2021-05-11T10:19:25.765982+00:00",
    "DateOfSend": "2021-05-11T10:19:25.765982+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": "4e602c95-2ead-4836-b17e-9a860e39c01b",
    "VatIdentificationNumber": "sample string 30",
    "Id": 31
  },
  "SummarySalesReceiptDate": "2021-05-11T10:19:25.765982+00:00",
  "TotalVat": 12.0,
  "TotalVatHc": 13.0,
  "TotalWithoutVat": 14.0,
  "TotalWithoutVatHc": 15.0,
  "TotalWithVat": 16.0,
  "TotalWithVatHc": 17.0,
  "VariableSymbol": "sample string 18",
  "IsIncomeTax": true,
  "RecountVersion": 0,
  "Id": 20
}
Sample:
<CashVoucherApiModel 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">20</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>
  <CashRegisterId>1</CashRegisterId>
  <CurrencyId>2</CurrencyId>
  <DateLastChange>2021-05-11T10:19:25.765982+00:00</DateLastChange>
  <DateOfTransaction>2021-05-11T10:19:25.765982+00:00</DateOfTransaction>
  <DocumentNumber>sample string 5</DocumentNumber>
  <DocumentSerialNumber>6</DocumentSerialNumber>
  <EetResponsibility>Idoklad</EetResponsibility>
  <ExchangeRate>1</ExchangeRate>
  <ExchangeRateAmount>1</ExchangeRateAmount>
  <Exported>0</Exported>
  <IsEet>true</IsEet>
  <IsIncomeTax>true</IsIncomeTax>
  <IsSummarySalesReceipt>true</IsSummarySalesReceipt>
  <Item>
    <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">13</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>
    <Amount>1</Amount>
    <Name>sample string 2</Name>
    <Price>3</Price>
    <PriceTotalWithVat>6</PriceTotalWithVat>
    <PriceTotalWithVatHc>7</PriceTotalWithVatHc>
    <PriceTotalWithoutVat>4</PriceTotalWithoutVat>
    <PriceTotalWithoutVatHc>5</PriceTotalWithoutVatHc>
    <PriceType>WithVat</PriceType>
    <Status>64</Status>
    <VariableSymbol>sample string 9</VariableSymbol>
    <VatRate>10</VatRate>
    <VatRateType>0</VatRateType>
    <VatTotal>11</VatTotal>
    <VatTotalHc>12</VatTotalHc>
  </Item>
  <Items>
    <CashVoucherItemApiModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">13</Id>
      <Links xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Links>
      <Amount>1</Amount>
      <Name>sample string 2</Name>
      <Price>3</Price>
      <PriceTotalWithVat>6</PriceTotalWithVat>
      <PriceTotalWithVatHc>7</PriceTotalWithVatHc>
      <PriceTotalWithoutVat>4</PriceTotalWithoutVat>
      <PriceTotalWithoutVatHc>5</PriceTotalWithoutVatHc>
      <PriceType>WithVat</PriceType>
      <Status>64</Status>
      <VariableSymbol>sample string 9</VariableSymbol>
      <VatRate>10</VatRate>
      <VatRateType>0</VatRateType>
      <VatTotal>11</VatTotal>
      <VatTotalHc>12</VatTotalHc>
    </CashVoucherItemApiModel>
  </Items>
  <MovementType>Entry</MovementType>
  <MyCompanyDocumentAddressId>1</MyCompanyDocumentAddressId>
  <Name>sample string 9</Name>
  <PartnerContactId>1</PartnerContactId>
  <PartnerDocumentAddressId>1</PartnerDocumentAddressId>
  <Person>sample string 10</Person>
  <RecountVersion>None</RecountVersion>
  <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-11T10:19:25.765982+00:00</DateOfAnswer>
    <DateOfSale>2021-05-11T10:19:25.765982+00:00</DateOfSale>
    <DateOfSend>2021-05-11T10:19:25.765982+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>4e602c95-2ead-4836-b17e-9a860e39c01b</Uuid>
    <VatIdentificationNumber>sample string 30</VatIdentificationNumber>
  </RegisteredSale>
  <SummarySalesReceiptDate>2021-05-11T10:19:25.765982+00:00</SummarySalesReceiptDate>
  <TotalVat>12</TotalVat>
  <TotalVatHc>13</TotalVatHc>
  <TotalWithVat>16</TotalWithVat>
  <TotalWithVatHc>17</TotalWithVatHc>
  <TotalWithoutVat>14</TotalWithoutVat>
  <TotalWithoutVatHc>15</TotalWithoutVatHc>
  <VariableSymbol>sample string 18</VariableSymbol>
</CashVoucherApiModel>