跳转到主要内容
GET
Lists billing contracts, each with the service lines it is made of.

授权

X-API-Key
string
header
必填

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

查询参数

Cursor
string

Opaque pagination cursor from a previous page; omit for the first page. Only valid against the same filters that produced it.

PageSize
integer<int32>
默认值:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

ClientIds
string

Comma-separated client ids; keeps only contracts billed to any of them.

StatusIds
string

Comma-separated status ids: 1 Active, 2 Expired, 3 Archived. Omitted returns Active and Expired (archived excluded). Any other id is a 400.

Query
string

Free text matched against the contract's name and reference. Max 200 characters.

CreatedSince
string<date-time>

Keeps only contracts created at or after this UTC instant.

CreatedBefore
string<date-time>

Keeps only contracts created at or before this UTC instant.

UpdatedSince
string<date-time>

Keeps only contracts last updated at or after this UTC instant. A contract never changed is excluded.

UpdatedBefore
string<date-time>

Keeps only contracts last updated at or before this UTC instant. A contract never changed is excluded.

EndDateSince
string<date-time>

Keeps only contracts ending on or after this date. A contract with no end date is excluded.

EndDateBefore
string<date-time>

Keeps only contracts ending strictly before this date. A contract with no end date is excluded.

SortBy
string
默认值:createdOn

Sort field: createdOn (default), updatedOn, startDate or endDate. Any other value is a 400.

SortOrder
string
默认值:desc

Sort direction: asc or desc (default). Any other value is a 400.

响应

OK

StatusCode
enum<integer>
可用选项:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object[] | null
DataContext
object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Notifications
object[]