---
title: "Query bills"
method: POST
path: "/v6/bills/query"
tags: ["Bills"]
---

# Query bills

`POST /v6/bills/query`

Query bills for the authenticated user

## Request body

- BillsGetParam
  - `cursor` string, nullable — Cursor from the previous paginated response
  - `limit` integer — Page size, i.e. number of items to return per page
  - `sort` BillsSort — Sort order for the items in the response.
    - `orderBy` 'NAME' | 'DATE' | 'DATE_PROXIMITY' — Sort column
    - `direction` 'ASC' | 'DESC' — Sort direction. Defaults to DESC
    - `value` string — The date for proximity search
  - `filter` BillsFilterParam — Filter for items in the response.
    - `search` string — Search filter
    - `name` StringFilter — Name filter
      - `equal` string — Value - returns all records with specified field equal to this value.
      - `notEqual` string — Value - returns all records with specified field not equal to this value.
      - `greaterThan` string — Value - returns all records with specified field greater than to this value.
      - `greaterThanEqual` string — Value - returns all records with specified field greater than or equal to this value.
      - `lessThan` string — Value - returns all records with specified field less than to this value.
      - `lessThanEqual` string — Value - returns all records with specified field less than or equal to this value.
      - `contain` string — Value - returns all records with specified field containing this value.
    - `status` EnumStatusListFilter — Status filter
      - `in` string[]
      - `notIn` string[]
      - `equal` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `notEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `greaterThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `greaterThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `lessThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
      - `lessThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED'
    - `billStatus` BillStatusListFilter — Bill status filter
      - `in` string[] — List of values to include.
      - `notIn` string[] — List of values to exclude.
    - `vendor` VendorExpandOnlyFilter — Vendor expand filter
      - `expand` boolean — Expand - whether to display additional nested data
    - `glAccount` GlAccountExpandOnlyFilter — GL Account expand filter
      - `expand` boolean — Expand - whether to display additional nested data

## Response `200`

Success

- PaginatedResponseBillGetDto
  - `result` 'SUCCESS' | 'FAILURE' — The result of the action performed.
  - `data` BillGetDto[] — The data generated by the action performed.
    - `id` string, required — Id of the bill
    - `name` string, required — Name of the bill
    - `billNo` integer, required — Bill number
    - `status` 'ACTIVE' | 'INACTIVE' | 'REMOVED', required — Status of the bill
    - `billStatus` 'DRAFT' | 'OPEN' | 'CLOSED' | 'CANCELLED' | 'REFUNDED', required — Bill status of the bill
    - `date` string, date, required — Date of the bill
    - `vendor` VendorExpanded, nullable, required — Vendor associated with this child payment
      - `id` string, required — Id of the vendor
      - `name` string — Name of the vendor
    - `apiName` 'BOX' | 'CLOVER' | 'STRIPE' | 'PLAID' | 'KNOX' | 'UBER' | 'FRESHBOOKS' | 'HARVEST' | 'KW' | 'FRESHBOOKS2' | 'CAPITAL_ONE' | 'SQUARE' | 'DOTLOOP' | 'REALOGY' | 'UPWORK' | 'SHOPIFY' | 'DEDUCTR' | 'ENTERPRISE' | 'MOXIWORKS' | 'APPDIRECT' | 'LONEWOLF' | 'LONEWOLF_TRANSACTIONDESK' | 'SAMPLE_BANK' | 'TAXBOT' | 'GUSTO' | 'XERO' | 'UNIT' | 'MOOV' | 'QBO' | 'QUALPAY' | 'BENCH' | 'PARTNER_IMPLEMENTATION' | 'CHECK' | 'RUTTER' | 'WAVE' | 'MANUAL_ENTRY' | 'CSV_IMPORT' | 'ADYEN' | 'PAYABLI' | 'MANUAL_ENTRY' | 'MELIO' | 'PARTNER_IMPLEMENTATION' | 'STRIPE', required — Name of the API from which this bill originated
    - `apiSourceId` string, nullable, required — Id of the bill on associated API
    - `lineItems` BillLineItemGetDto[]
      - `id` string, required — Id of the bill line item
      - `description` string, required — Description of the line item
      - `amount` integer, required — Amount of the line item (in cents)
      - `apiItemId` string, nullable, required — API item id of the line item
      - `glAccount` GlAccountExpanded, required — GL account details
        - `id` string, required — Id of the GL account
        - `name` string — Name of the GL account
        - `accountNo` string — Number of the GL account
        - `type` 'ASSET' | 'LIABILITY' | 'EQUITY' | 'INCOME' | 'COGS' | 'EXPENSE' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'SUSPENSE' — Type the GL account
        - `iconUrl` string — Icon URL of the GL account
        - `displayName` string — Display name of the GL account
    - `installments` InstallmentGetDto[]
      - `id` string, required — Id of the installment
      - `name` string, nullable, required — Name of the installment
      - `dueDate` string, date, nullable, required — Due date of the installment
      - `balance` integer, nullable, required — Balance of the installment (in cents)
      - `amountDue` AmountDue, nullable, required — Amount due for the installment
        - `value` string, nullable, required — The amount due value
        - `type` 'AMOUNT' | 'PERCENT', nullable, required — The type of the amount due value
    - `customData` JsonNode, nullable — Custom JSON in which you can store any data with max length of 2000 characters
      - `empty` boolean
      - `array` boolean
      - `null` boolean
      - `object` boolean
      - `float` boolean
      - `string` boolean
      - `number` boolean
      - `missingNode` boolean
      - `valueNode` boolean
      - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
      - `pojo` boolean
      - `integralNumber` boolean
      - `floatingPointNumber` boolean
      - `short` boolean
      - `int` boolean
      - `long` boolean
      - `double` boolean
      - `bigDecimal` boolean
      - `bigInteger` boolean
      - `textual` boolean
      - `boolean` boolean
      - `binary` boolean
      - `container` boolean
      - `embeddedValue` boolean
  - `cursor` ResponseCursor — Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.
    - `after` string — After cursor - Fetches entities after this cursor. Useful for paging forwards.
    - `before` string — Before cursor - Fetches entities before this cursor. Useful for paging backwards.

## Other responses

- `400` — Bad request
- `401` — Not authenticated
- `403` — Not authorized
- `404` — Endpoint not found
- `500` — Internal server error

---

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