Invoices
Invoices

Invoices

Supported Formats

json
>>>

GET /open_api/v1/invoices
Invoices index

Index of invoices, paginated. Ordered by created_at descendant.

Supported Formats

json

Examples

# /open_api/v1/invoices?user_id=211&page=1&per_page=3
{
  "invoices": [
    {
      "id": 2809,
      "user_id": 211,
      "payment_gateway_object": {
        id: "in_187DLE4zBvgjueAZ6L7SyQlU",
        type: "Stripe::Invoice"
      },
      "reference": "1605017/VL",
      "total": 1000,
      "type": null,
      "description": null,
      "invoice_url": "/open_api/v1/invoices/2809/download",
      "main_object": {
        "type": "Reservation",
        "id": 3257,
        "created_at": "2016-05-04T01:54:16.686+02:00"
      }
    },
    {
      "id": 2783,
      "user_id": 211,
      "payment_gateway_object": {
        id: "pi_2Dat4P2eYbKYlo2C3MxszwQp",
        type: "Stripe::PaymentIntent"
      },
      "reference": "1604176/VL",
      "total": 2000,
      "type": null,
      "description": null,
      "invoice_url": "/open_api/v1/invoices/2783/download",
      "main_object": {
        "type": "Reservation",
        "id": 3229,
        "created_at": "2016-04-28T18:14:52.524+02:00"
      }
    },
    {
      "id": 2773,
      "user_id": 211,
      "payment_gateway_object": {
        id: "ba15dc9d8f3e0fa17bf527466",
        type: "PayZen::Order"
      },
      "reference": "1604166/VL",
      "total": 2000,
      "type": null,
      "description": null,
      "invoice_url": "/open_api/v1/invoices/2773/download",
      "main_object": {
        "type": "Reservation",
        "id": 3218,
        "created_at": "2016-04-27T10:50:30.806+02:00"
      }
    }
  ]
}

Params

Param name Description
page
optional

Page number

Validations:

  • Must be a Integer
per_page
optional

Number of objects per page. Default is 20.

Validations:

  • Must be a Integer
user_id
optional

Scope the request to one or various users.

Validations:

  • Must be one of: Integer, Array.
>>>

GET /open_api/v1/invoices/:id/download
Download an invoice

Supported Formats

json

Examples

# /open_api/v1/invoices/2809/download

Params

Param name Description
id
required

Invoice id

Validations:

  • Must be a Integer