--- title: "List Receivables" method: GET path: "/v1/receivables" tags: ["Receivables"] --- # List Receivables `GET /v1/receivables` Returns a list of Receivables that were previously created. ## Query parameters - `page` integer - `page_size` integer - `amount_due` string, decimal - `amount_due.gt` string, decimal - `amount_due.gte` string, decimal - `amount_due.lt` string, decimal - `amount_due.lte` string, decimal - `amount_paid` string, decimal - `amount_paid.gt` string, decimal - `amount_paid.gte` string, decimal - `amount_paid.lt` string, decimal - `amount_paid.lte` string, decimal - `bill_number` string - `company` string, uuid - `created_at` string, date-time - `created_at.gt` string, date-time - `created_at.gte` string, date-time - `created_at.lt` string, date-time - `created_at.lte` string, date-time - `deposit_into_account` string[] - `due_on` string, date - `due_on.gt` string, date - `due_on.gte` string, date - `due_on.lt` string, date - `due_on.lte` string, date - `external_id` string - `issued_on` string, date - `issued_on.gt` string, date - `issued_on.gte` string, date - `issued_on.lt` string, date - `issued_on.lte` string, date - `sort` string[] - `status` ItemsCommonStatus[] - `status_changed_at` string, date-time - `status_changed_at.gt` string, date-time - `status_changed_at.gte` string, date-time - `status_changed_at.lt` string, date-time - `status_changed_at.lte` string, date-time ## Response `200` OK - ItemsReceivablesDiscriminatedReceivableList - `object` 'List', required — The object’s type (`List`). - `links` SharedListLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `next` string, uri, nullable — Link to the next page of results. - `prev` string, uri, nullable — Link to the previous page of results. - `results` ItemsReceivablesCommonCompactReceivable[], required - `id` string, uuid, required — The resource ID. - `amount` string, decimal, required — The total amount for this payment. - `amount_due` string, decimal, required — The total amount remaining due for this payment. - `amount_paid` string, decimal, required — The total amount paid for this payment. - `amount_recipient` number, double — The amount that will be sent to the recipient. - `amount_sender` number, double — The amount paid by the sender. - `bill_number` string, nullable, required — The bill number for this item. If you have integrated your accounting software, this will match the bill number in that application. - `created_at` string, date-time, required — The creation date and time of the Item. - `currency_code` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' — An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_recipient` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' — An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `currency_code_sender` 'AED' | 'AUD' | 'BHD' | 'BRL' | 'BSD' | 'CAD' | 'CHF' | 'CNY' | 'COP' | 'CRC' | 'CZK' | 'DKK' | 'DOP' | 'EGP' | 'EUR' | 'GBP' | 'GTQ' | 'HKD' | 'HNL' | 'HUF' | 'IDR' | 'INR' | 'ILS' | 'JPY' | 'KES' | 'KRW' | 'KWD' | 'KZT' | 'MXN' | 'MYR' | 'NGN' | 'NIO' | 'NOK' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'QAR' | 'RON' | 'SAR' | 'SEK' | 'SGD' | 'THB' | 'TRY' | 'TWD' | 'UGX' | 'USD' | 'UYU' | 'VND' | 'ZAR' — An ISO 4217 currency code. Only currencies currently supported by Routable are available. - `due_on` string, date, required — The date the payment is due. - `exchange_rate` string — The exchange rate used to convert the amount_sender into the amount_recipient. - `expected_on` string, date, nullable, required — The date the payment is expected to hit the receiving account. - `external_id` string, nullable — An external ID that you have assigned to this transaction - for example, an invoice or payment number in your application. - `fixed_side` 'sender' | 'recipient' — Which amount associated with the Item is fixed and will be used to determine the other side's amount. - `issued_on` string, date, required — The date the invoice was issued. - `is_exchange_rate_locked` boolean — Designate whether or not the exchange_rate value is actually the one that will be used to perform the currency conversion (true) or if it is an estimate based on the current rate (false). - `reference` string, nullable — This field is used as an additional reference number for the item when Routable is **not** integrated with your accounting software. If you have integrated your accounting software with Routable, this field is not used. - `sent_on` string, date, nullable — The date the payment or invoice was sent to the receiving Company. If the Payable or Receivable is created after the [cut-off time](https://docs.routable.com/en/articles/5149655-bank-transfer-payment-delivery-options) for the chosen `delivery_method`, the `sent_on` date will reflect the date the transaction was actually sent, which may be the following business day after the requested `send_on` date. - `status` 'canceled' | 'completed' | 'compliance_hold' | 'created' | 'externally_paid' | 'failed' | 'initiated' | 'issue' | 'needs_approval' | 'new' | 'pending' | 'po_discrepancy_hold' | 'processing' | 'ready_to_send' | 'scheduled', required — The status of the payment: | Value | Description | | `canceled` | The payment was canceled. No funds were sent to the **receiver**. | | `completed` | The payment was completed. The **receiver** has received the funds at the specified `pay_to_payment_method`. | | `compliance_hold` | The payment has been held pending resolution of a **compliance hold.** See the `Company`'s `compliance_checks` for details. | | `created` | The payment is newly created. | | `externally_paid` | The payment is a record of a payment made outside of Routable. | `failed` | The payment failed at some point on its journey through the banking system. See `failure_detail` for details and resolutions. | | `initiated` | The transfer of funds has begun. This corresponds to the "In Transit" state in the Routable UI. | | `issue` | The payment failed at some point while Routable was creating it. See `failure_detail` for details and resolutions. | | `needs_approval` | The payment has been paused until it receives approval from all required approvers. | | `pending` | The payment is held pending the `pay_to_company`'s selection of a payment and/or `type` (`vendor_choice` `Payables`). | | `po_discrepancy_hold` | The payment has been held pending resolution of a purchase order discrepancy. | | `processing` | The payment is currently being processed in Routable. (**Note:** As payment are only in this status for a few seconds, `payable.status_changed` webhooks are **not fired** for it.) | | `ready_to_send` | The payment is waiting to be manually sent, either through the Routable Dashboard or an update to `send_on`. | | `scheduled` | The payment is scheduled to be sent on the future date referenced in `send_on`. | - `status_changed_at` string, date-time, required — The datetime of the last status change. - `links` ItemsCommonItemLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `confirmation` string, nullable — Link to download payment confirmation document as a PDF. - `object` 'Receivable', required — The object’s type (`Receivable`). - `deposit_into_account` AccountsCompactAccountBank, required - `object` 'Account', required — The object’s type (`Account`). - `id` string, uuid, required — The Account ID. - `links` AccountsAccountLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `type` 'bank', required — The type of Account - `type_details` AccountsAccountBankTypeDetails, required - `account_number` string, required — The bank account number. In responses, all but the last four digits will be masked for security. - `account_type` 'checking' | 'savings', required — The type of bank account. - `institution_name` string, required — The bank's name. - `logo` string, uri — The URL of the bank's logo in PNG format. - `primary_color` string — The bank's primary color hex code. - `routing_number` string, required — The bank's nine-digit routing number. - `due_from_company` CompaniesCompactCompany, required - `object` 'Company', required — The object’s type (`Company`). - `id` string, uuid, required — The Company ID. - `display_name` string, required — The Company's name for display in the Routable Dashboard. - `links` CompaniesCompanyLinks, required — Related links. - `self` string, uri-reference, required — Link to this object. - `compliance_checks` string, uri-reference, required — Link to this Company's Compliance Reports. - `contacts` string, uri-reference, required — Link to this Company's Contacts. - `payables` string, uri-reference, required — Link to this Company's Payables. - `payment_methods` string, uri-reference, required — Link to this Company's Payment Methods. - `receivables` string, uri-reference, required — Link to this Company's Receivables. - `tax_forms` string, uri-reference, required — Link to this Company's most recent TaxForm. - `send_on` string, date, nullable — The date that the Receivable should be sent **in Pacific Time**. - When set to today, the Receivable will be sent immediately. - When set to `null`, the Receivable will be put in a `ready_to_send` status. - When set to a date in the future, the Receivable will be scheduled for a future date. No email communications will go out until that date. - `terms` 'net30' | 'net60' | 'see_invoice' | 'upon_receipt' — The payment terms for this Receivable. * `net30` - The Receivable is due 30 days from today. * `net60` - The Receivable is due 60 days from today. * `see_invoice` - The Receivable is due on the date specified in the `due_on` request field. * `upon_receipt` - The Receivable is due immediately. - `type` 'external' | 'invoice', required — The type of Receivable. - `version` integer — The current version of the Receivable that is incremental per change, starting at 1 at the moment of creation. --- [API](https://skmtc.net/routable/apis/routable-api.md) · [All operations](https://skmtc.net/routable/apis/routable-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/routable/routable-api/versions/9f17a8bc982a/schema)