Search settlements

Returns all settlements matching the given filter criteria. In case no settlement matches, an empty collection is returned. Supports wildcards in filter fields.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 0 and 50

Filter settlements by Settlementnumber. Place holders are supported.

string
length between 0 and 50

Filter settlements by Settlementtype. Place holders are supported.

string
length between 0 and 50

Filter settlements by Billingscenario. Place holders are supported.

string
length between 0 and 50

Filter settlements by Provider companyNo. Place holders are supported.

status_list
array of strings
length between 0 and 50

Filter settlements by status code. Possible Status Codes are: READY, COMPILED, RELEASED, COMPLETE, CANCELLED Place holders are supported.

status_list
int32
≥ 0
Defaults to 0

The starting point from which to return elements of the ordered list.
Minimum : 0

int32
1 to 1000
Defaults to 1000

The maximum number of elements to be returned from the ordered list.
Minimum : 1
Maximum : 1000

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json