Get invoices

cloud

GET 
/v2/organizations/:organizationId/billing/invoices

Get invoices

Request

Path Parameters

organizationId int64required

Query Parameters

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 10

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Responses

200

OK

application/json

Schema

Schema

_embedded object
invoices object[]
Array [
id int64required
number stringrequired
The number on the invoice
createdAt int64required
total numberrequired
The Total amount with tax
taxRatePercentage number
pdfReady booleanrequired
Whether pdf is ready to download. If not, wait around few minutes until it's generated.
hasUsage booleanrequired
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "invoices": [
      {
        "id": 0,
        "number": "string",
        "createdAt": 0,
        "total": 0,
        "taxRatePercentage": 0,
        "pdfReady": true,
        "hasUsage": true
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...