POST v1/{organizationId}/vouchers/manuel/{guid}/book

Books a manuel voucher

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

Guid of the voucher to book

globally unique identifier

Required

organizationId

string

None.

Body Parameters

Data used for the booking transaction

BookModel
NameDescriptionTypeAdditional information
Number

Optional. If specified, the voucher will be created with this number. If the number is already taken the booking of the voucher will fail.

integer

None.

Timestamp

Timestamp to validate against. This is a safety measure to ensure that an API partner is only making changes to the latest version of the entity. The timestamp is generated on Dinero's server every time the entity is updated, and is returned as a part of CreatedResponse and UpdatedResponse. It's also available on the entity itself. If you get a timestamp outdated exception (error code 58), you will need to get the latest version of the enity and use its timestamp.

string

None.

Sample:
{
  "Number": null,
  "Timestamp": "00000000020A5EA8"
}

Response Information

Resource Description

ManuelVoucherReadModel
NameDescriptionType
VoucherNumber

The vouchers number

integer
VoucherDate

Date of the voucher

string
TotalInclVat

Total amount of money in the voucher, including vat

decimal number
TotalExclVat

Total amount of money in the voucher, excluding vat

decimal number
FileGuid

Guid of the file associated with the voucher

string
Guid

Guid of the voucher

globally unique identifier
Status

Voucher status: Draft, Editing or Booked

string
Lines

List of the lines on the voucher

Collection of ManuelVoucherLineReadModel
Timestamp

Timestamp used to validate version in case of updating

string
ExternalReference

Your external id This can be used for ID'ing in external apps/services e.g. a web shop. The maximum length is 128 characters

string
Sample:
{
  "VoucherNumber": null,
  "VoucherDate": "2018-09-02",
  "TotalInclVat": 100.0,
  "TotalExclVat": 80.0,
  "FileGuid": "687f0b3b-7de5-4a4c-b2bd-7b4b761bbf60s",
  "Guid": "00000000-0000-0000-0000-000000000000",
  "Status": "Draft",
  "Lines": [
    {
      "Description": "Sale of things",
      "AmountExclVatValue": 80.0,
      "AmountInclVatValue": 100.0,
      "VatAmountValue": 20.0,
      "AccountNumber": 55000,
      "BalancingAccountNumber": 1000,
      "AccountVatCode": "I25",
      "BalancingAccountVatCode": "I25"
    },
    {
      "Description": "Sale of things",
      "AmountExclVatValue": 80.0,
      "AmountInclVatValue": 100.0,
      "VatAmountValue": 20.0,
      "AccountNumber": 55000,
      "BalancingAccountNumber": 1000,
      "AccountVatCode": "I25",
      "BalancingAccountVatCode": "I25"
    }
  ],
  "Timestamp": "00000000000017B7",
  "ExternalReference": "e.g. WebShopID:42"
}