POST v1/{organizationId}/invoices/{guid}/book

Book invoice.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

Guid of the invoice 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

200 (ok) if the invoice has been successfully been booked.

UpdatedResponseModel
NameDescriptionType
Guid

The id of the object

globally unique identifier
TimeStamp

Timestamp of version. To avoid concurrency issues.

string
Sample:
{
  "Guid": "b8337405-d291-47f9-bce2-464f68f92c5a",
  "TimeStamp": "00000000020A5EA8"
}