GET
/
organisations
/
{id}
/
credit_batches

Authorizations

Authorization
string
headerrequired

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

x-client-secret
string
required

A secret token identifying the client connecting to the API

Path Parameters

id
string
required

The ID of the organisation.

Query Parameters

supplier_id
string | null

Filter credit batches by the supplier that was issued the credits

project_id
string | null

Filter credit batches by the project that the credits were issued for

issuance_id
string | null

Filter credit batches by their issuance

delivery_id
string | null

Filter credit batches by the delivery that they were part of

order_id
string | null

Filter credit batches by the order they have been delivered against

retirement_id
string | null

Filter credit batches by the retirement they have been part of

status
enum<string>[] | null

Filter credit batches by status. Note that 'split' status is excluded by default.

Available options:
active,
split,
retired
issued_after
string | null

Filter credit batches to only return ones issued strictly after this timestamp. Format: ISO8601-like including timezone, eg. 2021-01-01T00:00:00Z

issued_before
string | null

Filter credit batches to only return ones issued strictly before this timestamp. Format: ISO8601-like including timezone, eg. 2024-01-01T00:00:00Z

last
integer
default: 10

An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.

Required range: 0 < x < 50
before
string | null

An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page’s start_cursor here when paginated backwards.

Minimum length: 1
first
integer
default: 10

An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.

Required range: 0 < x < 50
after
string | null

An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page’s end_cursor here when paginated forwards.

Minimum length: 1
sort_field
enum<string>
Available options:
issued_at
sort_direction
enum<string>
Available options:
asc,
desc

Response

200 - application/json
nodes
object[]
required
page_info
object
required
total_count
integer
required

Was this page helpful?

Organisation Credit BalanceOrder