---
title: "Get list of bills"
method: GET
path: "/v3/bills"
tags: ["bills"]
---

# Get list of bills

`GET /v3/bills`

Get a list of bill objects. By default, you get 20 results on one page of results. Set `max` in your request to get up to 100 results on one page.

See [Search operations with lists](https://developer.bill.com/docs/search-op-with-lists) in the Guides section for filtering, sorting, and pagination examples.

## Query parameters

- `max` integer, nullable — Maximum number of results
- `sort` string, nullable — Field name and sort order. Both simple and compound sorting is available. The format is `sort={field_01}:{sort_order},{field_02}:{sort_order}`. **NOTE**: Sorting occurs in the specified order.
- `filters` string, nullable — Field name, operator, and value. Both simple and compound filtering is available. The format is `filters={field_01}:{op}:{value},{field_02}:{op}:{value}`.
- `page` string, nullable — Next page of results. When a list has multiple pages, the `nextPage` and `prevPage` values in the response enable you to navigate between the pages of results. Set `page` as the `nextPage` or `prevPage` value for navigation.

## Headers

- `sessionId` string, nullable — API session ID generated with `/v3/login`
- `devKey` string, nullable — Developer key generated with your BILL developer account

## Response `200`

Get list of bills response

- ListBillResponseDto — Response from a list API request with paging references.
  - `nextPage` string
  - `prevPage` string
  - `results` BillReadWithoutApproversResponseDto[]
    - `id` string, required — BILL-generated ID of the bill. The value begins with `00n`.
    - `recordStatus` 'ACTIVE' | 'INACTIVE' | 'DRAFT' | 'DRAFT_DELETED' | 'UNDEFINED', required — Bill record status. When `recordStatus` is `ACTIVE`, `archived` is set as `false`. For any other `recordStatus` value, `archived` is set as `true`.
    - `archived` boolean, required — Set as `true` if the bill is archived
    - `vendorId` string, required — BILL-generated ID of the vendor. The value begins with `009`.
    - `vendorName` string, required — Vendor name
    - `fundingAmount` number — Bill total amount. This value is in USD.
    - `amount` number — Bill total amount. For a bill in an international currency (not USD), this value is in the local currency.
    - `paidAmount` number — Bill paid amount. This value is the sum of all cleared payments and any credit amount applied to the bill.
    - `dueAmount` number — Bill due amount. The value is calculated by subtracting any applied credits (`creditAmount`), scheduled payment (`scheduledAmount`), and cleared payment from the bill `amount`.
    - `scheduledAmount` number — Bill scheduled amount. The value is set as the vendor payment amount that is pending clearance.
    - `creditAmount` number — Credit amount applied to the bill
    - `exchangeRate` number — Exchange rate for the bill amount in an international currency (not USD). The BILL exchange rate changes periodically and a different rate may apply at the time of payment.
    - `description` string — Bill description
    - `dueDate` string, date — Bill due date. The value is in the `yyyy-MM-dd` format.
    - `paymentTermId` string
    - `invoice` object — Invoice information
      - `invoiceNumber` string
      - `invoiceDate` string, date
    - `billLineItems` BillResponseLineItem[] — Bill line item information
      - `id` string — BILL-generated ID of the bill line item. The value begins with `bli`.
      - `amount` number, required — Bill line item amount. For a bill in an international currency (not USD), this value is in the local currency. If you set `amount`, `quantity`, and `price`, BILL uses the `amount` value as the bill line item total amount.
      - `quantity` number — Bill line item unit quantity
      - `price` number — Bill line item unit price. For a bill in an international currency (not USD), this value is in the local currency.
      - `description` string — Bill line item description
      - `classifications` object — General ledger classifications information for the bill line item
        - `chartOfAccountId` string — BILL-generated ID of the chart of accounts. The value begins with `0ca`.
        - `accountingClassId` string — BILL-generated ID of the accounting class. The value begins with `cls`.
        - `departmentId` string — BILL-generated ID of the department. The value begins with `0de`.
        - `employeeId` string — BILL-generated ID of the employee. The value begins with `emp`.
        - `jobId` string — BILL-generated ID of the job. The value begins with `job`.
        - `locationId` string — BILL-generated ID of the location. The value begins with `loc`.
        - `itemId` string — BILL-generated ID of the item. The value begins with `0ii`.
        - `customerId` string — BILL-generated ID of the customer. The value begins with `0cu`.
    - `payFromChartOfAccountId` string — BILL-generated ID of the chart of accounts for the bill payment. The value begins with `0ca`.
    - `paymentStatus` 'PAID' | 'UNPAID' | 'PARTIALLY_PAID' | 'SCHEDULED' | 'IN_PROCESS' | 'UNDEFINED' — Bill payment status.
    - `approvalStatus` 'UNASSIGNED' | 'ASSIGNED' | 'APPROVED' | 'APPROVING' | 'DENIED' | 'UNDEFINED' — Bill approval status.
    - `createdBy` string — BILL-generated ID of the user that created the bill. The value begins with `006`.
    - `createdTime` string, date-time — Created date and time
    - `updatedTime` string, date-time — Updated date and time
    - `classifications` object — General ledger classifications information for the bill
      - `chartOfAccountId` string
      - `accountingClassId` string
      - `departmentId` string
      - `locationId` string
    - `purchaseOrderNumber` string — Purchase order number linked with the bill

## Other responses

- `4XX` — List of errors.
- `5XX` — List of errors.

---

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