---
title: "Returns the account receivables for the customer"
method: GET
path: "/account_receivables"
tags: ["Account receivables"]
---

# Returns the account receivables for the customer

`GET /account_receivables`

## Request

- Base URL: `https://api.treasury.shinkansen.finance/v1`
- URL: `https://api.treasury.shinkansen.finance/v1/account_receivables`
- Auth: API key in header `Shinkansen-Treasury-Api-Key`

Returns a paginated list of account receivables for the customer. The information can be filtered using the different parameters. Custom field filtering is supported using the custom_field_{field_name} parameter format.

## Query parameters

- `external_id` string
- `payee_id` string
- `payee_name` string
- `state[]` string[]
- `type[]` string[]
- `description` string
- `gte_amount` string
- `lte_amount` string
- `gte_updated_at` string, date-time
- `lte_updated_at` string, date-time
- `gte_inserted_at` string, date-time
- `lte_inserted_at` string, date-time
- `gte_lowerbound_due_date` string, date
- `lte_upperbound_due_date` string, date
- `tag_codes[]` string[]
- `custom_field_{field_name}` string
- `page_size` integer
- `page` integer

## Response `200`

Account receivables successfully retrieved. The response includes the account receivables with their associated entities (reconciliation links) and tags, along with pagination metadata.

- object: Response containing the account receivables and pagination metadata
  - `account_receivables` AccountReceivableWithEntities[], required: List of account receivables with their associated entities and tags
    - `id` string, uuid, required: System-assigned unique identifier for the account receivable
    - `external_id` string: External identifier provided by the customer
    - `payee_id` string, required: Identifier for the payee (debtor)
    - `payee_id_schema` string, required: Schema used for the payee identification
    - `payee_name` string: Name of the payee (debtor)
    - `amount` string, required: Total amount of the account receivable
    - `unreconciled_amount` string: Amount that has not been reconciled yet
    - `currency` string, required: Currency code for the amount
    - `description` string: Description of the account receivable
    - `state` 'pending' | 'expired' | 'partially_reconciled' | 'reconciled' | 'archived', required: Current state of the account receivable
    - `type` 'account_receivable': Type of the account receivable
    - `lowerbound_due_date` string, date: Lower bound of the due date range
    - `upperbound_due_date` string, date: Upper bound of the due date range
    - `inserted_at` string, date-time: Timestamp when the account receivable was created
    - `updated_at` string, date-time: Timestamp when the account receivable was last updated
    - `custom_fields` object: Custom fields for any client-specific data they want to associate with the account receivable. This allows clients to store additional metadata that is relevant to their business processes and reporting needs.
    - `entities` object[], required: Associated entities (reconciliation links) for this account receivable
      - `amount` string, required: Total amount of the linked entity
      - `linked_amount` string, required: Amount linked to this account receivable
      - `unreconciled_amount` string, required: Unreconciled amount of the linked entity
      - `currency` string, required: Currency code for the amounts
      - `debtor_id` string: ID of the debtor
      - `debtor_schema_name` string: Schema name for the debtor ID
      - `debtor_name` string: Name of the debtor
      - `debtor_account` string: Account number of the debtor
      - `debtor_account_type` string: Type of the debtor account
      - `debtor_account_schema_name` string: Schema name for the debtor account
      - `debtor_account_schema_id` string: Schema ID for the debtor account
      - `creditor_account` string: Account number of the creditor
      - `creditor_account_type` string: Type of the creditor account
      - `creditor_account_schema_name` string: Schema name for the creditor account
      - `creditor_account_schema_id` string: Schema ID for the creditor account
      - `execution_date` string, date-time: Execution date of the transaction
      - `lowerbound_execution_date` string, date: Lower bound of the execution date range
      - `upperbound_execution_date` string, date: Upper bound of the execution date range
      - `lowerbound_booking_date` string, date: Lower bound of the booking date range
      - `upperbound_booking_date` string, date: Upper bound of the booking date range
      - `description` string: Description of the linked entity
      - `created_by` string: Email of the user who created the link
      - `state` string, required: State of the linked entity
      - `updated_at` string, date-time: Timestamp when the entity was last updated
      - `inserted_at` string, date-time: Timestamp when the entity was created
    - `tags` object[], required: Tags associated with this account receivable
      - `name` string, required: Display name of the tag
      - `code` string, required: Code identifier for the tag
      - `inserted_at` string, date-time, required: Timestamp when the tag was created
      - `updated_at` string, date-time, required: Timestamp when the tag was last updated
  - `meta` object, required: Pagination metadata
    - `current_page` integer, required: Current page number
    - `total_pages` integer, required: Total number of pages
    - `total_count` integer, required: Total number of account receivables

## Other responses

- `401`: The `Shinkansen-Treasury-Api-Key` header is missing or does not match a Treasury customer. The body is the plain text `Unauthorized`, not JSON.
- `403`: The API key is valid but lacks the scope this endpoint requires. The body is the plain text `Forbidden`, not JSON.

---

[API](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints.md) - [All operations](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/shinkansen/apis/treasury-shinkansen-endpoints/revisions/2d3ec7684af3?raw)