Sign in

v1

latestOpenAPI 3.1.12026-07-2452287575.4 KB
Receivables

List Receivables

Returns a list of Receivables that were previously created.

get/v1/receivables

Query parameters

pageinteger

Retrieve a specific page of a List.

page_sizeinteger

Set the number of results per page of a List.

amount_duestring decimal

Filter for transactions with the given amount due.

amount_due.gtstring decimal

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

amount_due.gtestring decimal

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

amount_due.ltstring decimal

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

amount_due.ltestring decimal

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

amount_paidstring decimal

Filter for transactions with the given amount paid.

amount_paid.gtstring decimal

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

amount_paid.gtestring decimal

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

amount_paid.ltstring decimal

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

amount_paid.ltestring decimal

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

bill_numberstring

Filter for transactions with the bill_number provided.

companystring uuid
Example:bba63245-37d2-4c6a-9e82-e9d12a247c06

Filter for receivables due from this Company ID.

created_atstring date-time

Filter for transactions created at the given date and time.

created_at.gtstring date-time

Filter for transactions created after the given date and time.

created_at.gtestring date-time

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

created_at.ltstring date-time

Filter for transactions created before the given date and time.

created_at.ltestring date-time

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

deposit_into_accountstring[]

Filter for receivables that deposit into the given account IDs.

[
  "bba63245-37d2-4c6a-9e82-e9d12a247c06"
]
due_onstring date

Filter for transactions due on the given date.

due_on.gtstring date

Filter for transactions due after the given date.

due_on.gtestring date

Filter for transactions due after or on the given date.

due_on.ltstring date

Filter for transactions due before the given date.

due_on.ltestring date

Filter for transactions due before or on the given date.

external_idstring

Filter for transactions by the external ID provided.

issued_onstring date

Filter for invoices issued on the given date.

issued_on.gtstring date

Filter for invoices issued after the given date.

issued_on.gtestring date

Filter for invoices issued after or on the given date.

issued_on.ltstring date

Filter for invoices issued before the given date.

issued_on.ltestring date

Filter for invoices issued before or on the given date.

sortstring[]

Sort the transactions by the given attributes

statusItemsCommonStatus[]

Filter for transactions with the given statuses.

status_changed_atstring date-time

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

status_changed_at.gtstring date-time

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

status_changed_at.gtestring date-time

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

status_changed_at.ltstring date-time

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

status_changed_at.ltestring date-time

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

Response

OK

object'List' required

The object’s type (List).

Example response

{
  "results": [
    {
      "created_at": "2021-05-15T03:49:53.299680+00:00",
      "deposit_into_account": {
        "type_details": {
          "primary_color": "#0075a3"
        }
      },
      "send_on": "2022-11-26"
    }
  ]
}