List Receivables

get

https://api.routable.com/v1/receivables

Returns a list of Receivables that were previously created.

Query Params

page

integer

≥ 1

Defaults to 1

Retrieve a specific page of a List.

page_size

integer

1 to 100

Defaults to 10

Set the number of results per page of a List.

amount_due

string

Filter for transactions with the given amount due.

amount_due.gt

string

Filter for transactions with an amount due greater than the given amount due.

amount_due.gte

string

Filter for transactions with an amount due greater than or equal to the given amount due.

amount_due.lt

string

Filter for transactions with an amount due lower than the given amount due.

amount_due.lte

string

Filter for transactions with an amount due lower than or equal to the given amount due.

amount_paid

string

Filter for transactions with the given amount paid.

amount_paid.gt

string

Filter for transactions with an amount paid greater than the given amount.

amount_paid.gte

string

Filter for transactions with an amount paid greater than or equal to the given amount.

amount_paid.lt

string

Filter for transactions with an amount paid lower than the given amount.

amount_paid.lte

string

Filter for transactions with an amount paid lower than or equal to the given amount.

bill_number

string

Filter for transactions with the bill_number provided.

company

uuid

Filter for receivables due from this Company ID.

created_at

date-time

Filter for transactions created at the given date and time.

created_at.gt

date-time

Filter for transactions created after the given date and time.

created_at.gte

date-time

Filter for transactions created after or at the given date and time.

created_at.lt

date-time

Filter for transactions created before the given date and time.

created_at.lte

date-time

Filter for transactions created before or at the given date and time.

deposit_into_account

array of uuids

Filter for receivables that deposit into the given account IDs.

deposit_into_account

due_on

date

Filter for transactions due on the given date.

due_on.gt

date

Filter for transactions due after the given date.

due_on.gte

date

Filter for transactions due after or on the given date.

due_on.lt

date

Filter for transactions due before the given date.

due_on.lte

date

Filter for transactions due before or on the given date.

external_id

string

Filter for transactions by the external ID provided.

issued_on

date

Filter for invoices issued on the given date.

issued_on.gt

date

Filter for invoices issued after the given date.

issued_on.gte

date

Filter for invoices issued after or on the given date.

issued_on.lt

date

Filter for invoices issued before the given date.

issued_on.lte

date

Filter for invoices issued before or on the given date.

sort

array of strings

Sort the transactions by the given attributes

sort

status

array of objects

Filter for transactions with the given statuses.

status

status_changed_at

date-time

Filter for transactions where status changed at the given date and time.

status_changed_at.gt

date-time

Filter for transactions where status changed after the given date and time.

status_changed_at.gte

date-time

Filter for transactions where status changed after or at the given date and time.

status_changed_at.lt

date-time

Filter for transactions where status changed before the given date and time.

status_changed_at.lte

date-time

Filter for transactions where status changed before or at the given date and time.

Response

200OK