GET v2.0/CashVouchers/Default/{movementType}/{invoiceType}/{invoiceId}

Request Information

Method returns empty cash voucher with default values. Returned resource is suitable for creation of a new cash voucher.

Example URL:
 v2.0/CashVouchers/Default/{movementType}/{invoiceType}/{invoiceId}

URL parameters
Body parameters

Name	Type	Additional information
movementType	MovementType	Required
movementType	MovementType	Required
invoiceType	InvoiceType	Required
invoiceType	InvoiceType	Required
invoiceId	integer	Required
invoiceId	integer	Required

None.

CashVoucherApiModelInsert

Name	Description	Type	Additional 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

application/json, text/json
application/xml, text/xml

Sample:

{
  "CashRegisterId": 1,
  "DateOfTransaction": "2024-04-26T13:00:26.4652094+00:00",
  "DocumentSerialNumber": 3,
  "ElectronicRecordsOfSales": {
    "EetStatus": null,
    "IsEet": false,
    "RegisteredSale": null,
    "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>2024-04-26T13:00:26.4652094+00:00</DateOfTransaction>
  <DocumentSerialNumber>3</DocumentSerialNumber>
  <ElectronicRecordsOfSales>
    <EetResponsibility>Idoklad</EetResponsibility>
    <EetStatus i:nil="true" />
    <IsEet>false</IsEet>
    <RegisteredSale i:nil="true" />
  </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>