API docs by Redocly

Newbook External Document Generation Documentation (1.0.0)

Download OpenAPI specification:Download

Newbook Engineering team: support@newbook.cloud

Introduction

Newbook allows our clients to set up an Integration to an endpoint of your specification, accepting a POST request with information detailing an Invoice and its connected items.

Information detailing the client's business will be delivered, as well as information detailing the Client Account the Invoice is saved against.

These details are suggested to be enough for your endpoint to analyse and generate HTML, in a layout which a Guest would understand to be an Invoice document.

endpoint

Newbook will send a request to your endpoint. The URL can be anything.

This will be either a GET request with no data payload, or a POST request with full details of the Invoice etc.

Clients can configure multiple integrations in this way. For example, it is possible to set up different endpoints (and different Invoice templates to use inside Newbook) if the client asked you to build one Invoice Document layout for Long Term bookings and another for Short Term bookings.

Authorizations:
basicAuth
Request Body schema: application/json
type
string
Value: "invoice"
object

Information about this Invoice

object

Information about the object for the Client Account this Invoice is attached to

object

Information about this Instance (Newbook client)

object

Information about this Guest

object

Information detailing all the associated Items for this Invoice

Request samples

Content type
application/json
{
  • "type": "invoice",
  • "typeData": {
    },
  • "accountData": {
    },
  • "businessData": {
    },
  • "modelData": {
    },
  • "transactions": {
    }
}