---
title: "Get clients/suppliers outstanding items"
method: GET
path: "/consumers/{consumer_id}/accounting/outstandings"
tags: ["Accounting", "Outstanding"]
---

# Get clients/suppliers outstanding items

`GET /consumers/{consumer_id}/accounting/outstandings`

Returns a list of all clients/suppliers outstanding items

## Path parameters

- `consumer_id` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `folder_id` string, nullable
- `type` 'client' | 'supplier', required
- `unposted_allowed` 'true' | 'false', required

## Response `200`

Successful Response

- ChiftPageOutstandingItem
  - `items` OutstandingItem[], required
    - `id` string, required — Unique id of the outstanding item instance in the accounting system.
    - `number` string, nullable — Invoice, Journal entry or Financial entry number of the outstanding item.
    - `journal_id` string, required — Id of the journal instance associated with the outstanding item.
    - `journal_type` 'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' | 'financial_operation' | 'miscellaneous_operation' | 'unknown', required
    - `date` string, date, required — Accounting date of the outstanding item.
    - `due_date` string, date, nullable — Due date of the outstanding item.
    - `currency` string, required — Currency of the outstanding item (e.g., EUR, USD).
    - `currency_exchange_rate` number, required — Exchange rate applicable at the date of the outstanding item if currency different from folder's default currency.
    - `amount` number, required — Total amount
    - `open_amount` number, required — Open amount.
    - `partner_id` string, required — Id of the thirdparty (customer, supplier or employee) in the accounting system linked to the outstanding item. This is used to identify the entity associated with the outstanding item.
    - `account_number` string, required — Account number in the chart of accounts associated with the outstanding item. This is typically used to book the outstanding item against a specific ledger account.
    - `reference` string, nullable — Reference of the outstanding item. This is an optional field that can be used to store additional information or context related to the outstanding item, such as an invoice number or a transaction reference.
    - `matching_numbers` string[], nullable — List of matching numbers associated with the outstanding item. This is used to track any matching operations that have been performed on the outstanding item, such as payments or adjustments.
    - `payment_communication` string, nullable — Payment communication associated with the outstanding item. This is an optional field that can be used to store additional information related to the payment
    - `posted` boolean, required — Indicates if the outstanding item has been posted (finalized) in the accounting system. If not provided, it defaults to True.
    - `original_document` OriginalOutstandingItem
      - `id` string, nullable — Unique id of the original outstanding item in the accounting system.
      - `number` string, nullable — Number of the original outstanding item.
      - `journal_id` string, nullable — Id of the journal associated with the original outstanding item.
      - `journal_type` 'customer_invoice' | 'customer_refund' | 'supplier_invoice' | 'supplier_refund' | 'financial_operation' | 'miscellaneous_operation' | 'unknown'
      - `date` string, date, nullable — Date of the original outstanding item.
      - `due_date` string, date, nullable — Due date of the original outstanding item.
      - `reference` string, nullable — Reference of the original outstanding item.
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `400` — Bad Request
- `422` — Validation Error

---

[API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/revisions/b5f1214a482a/schema)