---
title: "Get Aged Creditors"
method: GET
path: "/accounting/aged-creditors"
tags: ["Aged Creditors"]
---

# Get Aged Creditors

`GET /accounting/aged-creditors`

Get Aged Creditors

## Query parameters

- `raw` boolean
- `filter` AgedReportFilter
  - `customer_id` string — Filter by customer id
  - `supplier_id` string — Filter by supplier id
  - `report_as_of_date` string — The cutoff date for considering transactions
  - `period_count` integer — Number of periods to split the aged creditors report into
  - `period_length` integer — Length of each period in days
- `pass_through` PassThroughQuery
  - `example_downstream_property` string — All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)
- `fields` string, nullable

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required
- `x-apideck-service-id` string
- `x-apideck-company-id` string

## Response `200`

Aged Creditors

- GetAgedCreditorsResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `service` string, required — Apideck ID of service provider
  - `resource` string, required — Unified API resource name
  - `operation` string, required — Operation performed
  - `data` AgedCreditors, required
    - `report_generated_at` string, date-time — The exact date and time the report was generated.
    - `report_as_of_date` string, date — The cutoff date for transactions included in the report.
    - `period_count` integer — Number of aging periods shown in the report.
    - `period_length` integer — Length of each aging period in days.
    - `outstanding_balances` OutstandingBalanceBySupplier[]
      - `supplier_id` string — Unique identifier for the supplier.
      - `supplier_name` string — Full name of the supplier.
      - `outstanding_balances_by_currency` OutstandingBalanceByCurrency[]
        - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable — Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
        - `total_amount` number — Total amount of the outstanding balance.
        - `balances_by_period` BalanceByPeriod[]
          - `start_date` string, date, nullable — The starting date of the period. If not provided, it represents the oldest period, where all transactions due before the specified `end_date` are included.
          - `end_date` string, date, nullable — The ending date of the period. If not provided, it represents an open-ended period starting from the `start_date`, typically capturing future-dated transactions that are not yet aged.
          - `total_amount` number — Total amount of the period.
          - `balances_by_transaction` BalanceByTransaction[]
            - `transaction_id` string — Unique identifier for the transaction.
            - `transaction_date` string, date — Date of the transaction.
            - `transaction_type` 'invoice' | 'credit_note' | 'bill' | 'payment' | 'bill_payment' — Type of the transaction.
            - `due_date` string, date — Due date of the transaction.
            - `original_amount` number — Original amount of the transaction.
            - `outstanding_balance` number — Outstanding balance of the transaction.
            - `transaction_number` string — Transaction number of the transaction.
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.net/apideck-libraries/apis/accounting-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/accounting-api/versions/33e09b023d02/schema)