Invoices

This resource represents a client invoice document for a booking. A new invoice is generated every time a change is made on the booking which would impact the balance or statuses of services within the invoice.

All invoices for a booking are available on the /bookings/{id}/invoices endpoint.

XML Schema:

Fields

Name

Type

Description

id (read-only)

String

href (read-only)

Field

date_created (required)

Datetime

The time when the resource was created, in the standard Dates & Times.

audience (required)

String

The intended audience of this document. Either AGENT or CUSTOMER.

document (read-only)

Reference Object

The related document resource.

booking (read-only)

Reference Object

The related booking resource.

invoice_number (required)

String

The invoice number as seen on the PDF document.

agent (read-only)

Reference Object

The agent that generated this invoice.

type (required)

String

The type of invoice.

auto_generated (required)

Boolean

Whether the invoice was automatically generated by the system.

Get an Invoice

GET /invoices/(string: invoice_id)/