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}
Name | Description | Type | Additional information |
---|---|---|---|
movementType | MovementType |
Required |
|
movementType | MovementType |
Required |
None.
Response Information
CashVoucherPostModel
Name | Description | Type | Additional information |
---|---|---|---|
CashRegisterId |
Cash register id |
integer |
Required |
DateOfTransaction |
The date of transaction |
date |
Required |
DocumentSerialNumber |
Document Serial Number |
integer |
Required |
ElectronicRecordsOfSales |
Electronic records of sales information. |
ElectronicRecordsOfSalesPostModel |
None. |
ExchangeRate |
Exchange rate |
decimal number |
None. |
ExchangeRateAmount |
Exchange rate amount |
decimal number |
None. |
InvoiceId |
Id of paired invoice |
integer |
None. |
InvoiceType |
Type of paired invoice |
InvoiceType |
None. |
IsIncomeTax |
Include subject to income tax |
boolean |
Required |
Items |
Model of entity for inserting a new item. |
Collection of CashVoucherItemPostModel |
Required |
MovementType |
The movement type (issue/entry) |
MovementType |
Required |
Name |
Document name or description |
string |
Required Length: between 0 and 200 inclusive |
PartnerId |
Id of the partner's contact. |
integer |
None. |
Person |
Name of the supplier/customer. Can also be used as a note. |
string |
Length: between 0 and 100 inclusive |
Tags |
Tags |
Collection of integer |
None. |
VariableSymbol |
Variable symbol |
string |
Length: between 0 and 10 inclusive |
Sample:
{ "CashRegisterId": 1, "DateOfTransaction": "2023-09-30T20:40:27.2218452+00:00", "DocumentSerialNumber": 3, "ElectronicRecordsOfSales": { "EetStatus": null, "IsEet": false, "RegisteredSale": null, "EetResponsibility": 0 }, "ExchangeRate": 1.0, "ExchangeRateAmount": 1.0, "InvoiceId": 1, "InvoiceType": 0, "IsIncomeTax": true, "Items": [ { "CustomVatRate": 1.0, "Name": "sample string 1", "Price": 2.0, "PriceType": 0, "VatRateType": 0 } ], "MovementType": 1, "Name": "sample string 5", "PartnerId": 1, "Person": "sample string 6", "Tags": [ 1 ], "VariableSymbol": "sample string 7" }
Sample:
<CashVoucherPostModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.Version3.CashVoucher"> <CashRegisterId>1</CashRegisterId> <DateOfTransaction>2023-09-30T20:40:27.2218452+00:00</DateOfTransaction> <DocumentSerialNumber>3</DocumentSerialNumber> <ElectronicRecordsOfSales xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.Version3.RegisteredSale"> <d2p1:EetResponsibility>Idoklad</d2p1:EetResponsibility> <d2p1:EetStatus i:nil="true" /> <d2p1:IsEet>false</d2p1:IsEet> <d2p1:RegisteredSale i:nil="true" /> </ElectronicRecordsOfSales> <ExchangeRate>1</ExchangeRate> <ExchangeRateAmount>1</ExchangeRateAmount> <InvoiceId>1</InvoiceId> <InvoiceType>Issued</InvoiceType> <IsIncomeTax>true</IsIncomeTax> <Items> <CashVoucherItemPostModel> <CustomVatRate>1</CustomVatRate> <Name>sample string 1</Name> <Price>2</Price> <PriceType>WithVat</PriceType> <VatRateType>0</VatRateType> </CashVoucherItemPostModel> </Items> <MovementType>Entry</MovementType> <Name>sample string 5</Name> <PartnerId>1</PartnerId> <Person>sample string 6</Person> <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> </Tags> <VariableSymbol>sample string 7</VariableSymbol> </CashVoucherPostModel>