Get Invoices

GetInvoices returns a paginated list of invoices for the given Organisation. The query parameters from and to can be used to filter the invoices returned. If no query parameters are provided, this endpoint will return the upcoming invoice. If to is not provided, it will default to the current date. If from is not provided, it will default to a calendar month before the current date.

GET /organisations/{organisation_id}/billing/invoices

Get Invoices

cURL

curl --request GET \
  --url https://platform.versori.com/api/organisations/v1/organisations/{organisation_id}/billing/invoices \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "invoiceStartDate": "2023-12-25",
    "invoiceEndDate": "2023-12-25",
    "totalAmount": {
      "isNegative": true,
      "integral": 123,
      "fractional": 123
    },
    "invoiceURL": "<string>",
    "productBreakdowns": [
      {
        "productName": "<string>",
        "quantity": 123,
        "total": {
          "isNegative": true,
          "integral": 123,
          "fractional": 123
        }
      }
    ],
    "usageStatistics": {},
    "metaData": {}
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organisation_id · string · required

Query Parameters

from · string<date>

to · string<date>

Response

200

application/json

OK

invoiceStartDate · string<date> · required

invoiceEndDate · string<date> · required

totalAmount · object · required

MonetaryValue is a monetary value, i.e. £12.50. It is represented as a whole number integral and a fractional part. The integral part is the whole number of pounds, dollars, ... and the fractional part is the number of pence, cents, ..., in the value. The isNegative property denotes if the value is negative.

Show child attributes

invoiceURL · string<uri> · required

productBreakdowns · object[]

Show child attributes

usageStatistics · object

Show child attributes

metaData · object

Show child attributes