---
title: "Gets a list of company_ledger"
method: GET
path: "/api/v1/company_ledger"
tags: ["company_ledger"]
---

# Gets a list of company_ledger

`GET /api/v1/company_ledger`

## Request

- Base URL: `https://demo.invoiceninja.com`
- URL: `https://demo.invoiceninja.com/api/v1/company_ledger`
- Auth: none declared. Required headers: `X-API-TOKEN`, `X-Requested-With`
- TypeScript: <https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/docs/api/v1/company_ledger/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists the company_ledger.

## Query parameters

- `include` string

## Headers

- `X-API-TOKEN` string, required
- `X-Requested-With` string, required

## Response `200`

A list of company_ledger

- object
  - `data` CompanyLedger[]
    - `entity_id` string: This field will reference one of the following entity hashed ID payment_id, invoice_id or credit_id
    - `notes` string: The notes which reference this entry of the ledger
    - `balance` number, float: The client balance
    - `adjustment` number, float: The amount the client balance is adjusted by
    - `updated_at` number: Timestamp
    - `created_at` number: Timestamp
  - `meta` Meta
    - `pagination` Pagination
      - `total` integer: The total number of items
      - `count` integer: The number of items per page
      - `per_page` integer: The number of items per page
      - `current_page` integer: The current page number
      - `total_pages` integer: The total number of pages
      - `links` object: The pagination links

## Other responses

- `401`: Authentication error
- `403`: Authorization error
- `422`: Validation error
- `default`: Unexpected Error

## Changes

- **2025-05-24** `93bb427f804b`: 1 breaking
  - the `meta` response's property type changed from `object` to no type for status `200`
- **2024-06-06** `8e82a2bd77e0`: 2 breaking, 9 info
  - the response's body type changed from no type to `object` for status `default`
  - the `data/items/` response's property type changed from no type to `object` for status `200`
  - added the optional property `code` to the response with the `default` status
  - added the optional property `data/items/adjustment` to the response with the `200` status
  - …7 more
- **2024-06-05** `e61df65649e2`: 2 breaking, 9 warning
  - the response's body type changed from `object` to no type for status `default`
  - the `data/items/` response's property type changed from `object` to no type for status `200`
  - removed the optional property `code` from the response with the `default` status
  - removed the optional property `data/items/adjustment` from the response with the `200` status
  - …7 more
- **2024-03-07** `71171a40d629`: 5 breaking, 14 info
  - the response's body type changed from no type to `object` for status `401`
  - the response's body type changed from no type to `object` for status `403`
  - the response's body type changed from no type to `object` for status `422`
  - the response's body type changed from no type to `object` for status `default`
  - …15 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/changes/api/v1/company_ledger/get.md)

---

[API](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference.md) - [All operations](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/invoiceninja/apis/invoice-ninja-api-reference/revisions/bcda1f823746?raw)