List claims

get

https://sandbox.numeral.io/v1/claims

List and filter claims.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

int32

Defaults to 25

starting_after

string

The ID of the object from which your list request will start. It is not included in the result.

sort_order

string

enum

Order is based on attribute created_at. If asc, results are fetched in chronological order. If desc, results are fetched in reversed chronological order. Default order is desc.

Allowed:

start_date

date

The creation date of the claim.

end_date

date

The creation date of the claim.

start_value_date

date

The value date of the claim.

end_value_date

date

The value date of the claim.

type

string

enum

The type of the claim.

Allowed:

connected_account_id

string

The ID of the connected account used to send or receive the claim.

related_payment_type

string

enum

The payment type on which the claim applies, either incoming_payment or payment_order.

Allowed:

related_payment_id

string

The ID of the payment (payment order or incoming payment) on which the claim applies.

originating_account_number

string

The account number of the entity having sent the claim.

receiving_account_number

string

The account number of the entity having received the claim.

status

string

enum

The status of the claim.

Allowed:

file_id

string

The ID of the file including the claim.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of filtered claims.

400Validation error.

500Internal server error.