API - Planyo Web Services - generate_invoice

You are here: Planyo » Help » API » generate_invoice

generate_invoice

Description:

Generates a new invoice if one hasn't already been created for given reservation or if the reserved items have changed since the last invoice. This function will work only when using parent&corrective invoices.

Input:

reservation_id int required
Reservation ID for which an invoice should be generated
method string required
must be set to generate_invoice
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

id int
ID of the generated invoice. 'null' is returned when no invoice was generated (the reservation already had an invoice or the items didn't change).
url string
The url where the generated invoice can be downloaded.

API playground:

Click here to test this function in the API playground.