> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync2books.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List bill payments



## OpenAPI

````yaml /openapi/accounting.json get /bill-payments
openapi: 3.1.0
info:
  title: Sync2Books Accounting API
  version: 1.0.0
  description: >-
    Write categorized expenses, bills, invoices, and payments to your customers'
    accounting systems (QuickBooks Online, Xero, Sage, Dynamics 365 Business
    Central, Odoo) through one API.


    This is a **separate product** from the [Sync2Books Compliance API
    (eTIMS)](/etims-overview) — use this one to sync bookkeeping data to an
    accounting system; use that one for KRA tax compliance in Kenya. A company
    can use either, both, or neither.


    Writes are **asynchronous**: most create endpoints queue the record and
    return a `syncBatchId` you confirm via the [Sync](#tag/Sync) endpoints — see
    [The sync model](/concepts/sync-model).
servers:
  - url: https://api.sync2books.com
    description: Production
  - url: https://sandbox-api.sync2books.com
    description: Sandbox (coming soon)
security:
  - ApiKeyAuth: []
tags:
  - name: Companies
    description: Your customers — the entities you sync data for.
  - name: Expenses
    description: Categorized expenses, receipts, and payments.
  - name: Bills
    description: Accounts-payable documents (money you owe suppliers).
  - name: Invoices
    description: Accounts-receivable documents (money customers owe you).
  - name: Bill Payments
    description: Payments applied against one or more bills.
  - name: Attachments
    description: Receipts and supporting documents on a synced transaction.
  - name: Sync
    description: Track and retry the asynchronous batches every write creates.
paths:
  /bill-payments:
    get:
      tags:
        - Bill Payments
      summary: List bill payments
      parameters:
        - name: page
          in: query
          schema:
            type: integer
        - name: limit
          in: query
          schema:
            type: integer
            maximum: 100
        - name: search
          in: query
          schema:
            type: string
        - name: paymentMethod
          in: query
          schema:
            type: string
            enum:
              - cash
              - check
              - bank_transfer
              - credit_card
              - other
        - name: currency
          in: query
          schema:
            type: string
        - name: minAmount
          in: query
          schema:
            type: number
        - name: maxAmount
          in: query
          schema:
            type: number
        - name: startDate
          in: query
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          schema:
            type: string
            format: date
        - name: billId
          in: query
          schema:
            type: string
        - name: vendorId
          in: query
          schema:
            type: string
        - name: syncStatus
          in: query
          schema:
            type: string
            enum:
              - pending
              - syncing
              - synced
              - failed
        - name: sortBy
          in: query
          schema:
            type: string
            enum:
              - paymentDate
              - totalAmount
              - createdAt
              - updatedAt
        - name: sortOrder
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillPaymentListResponse'
components:
  schemas:
    BillPaymentListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/BillPayment'
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        totalPages:
          type: integer
        hasNextPage:
          type: boolean
        hasPreviousPage:
          type: boolean
    BillPayment:
      allOf:
        - $ref: '#/components/schemas/CreateBillPaymentRequest'
        - type: object
          properties:
            id:
              type: string
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
    CreateBillPaymentRequest:
      type: object
      required:
        - supplierRef
        - accountRef
        - totalAmount
        - currency
        - date
      properties:
        billPaymentCode:
          type: string
        supplierRef:
          $ref: '#/components/schemas/PartyRef'
        accountRef:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
            name:
              type: string
        totalAmount:
          $ref: '#/components/schemas/Money'
        currency:
          type: string
        currencyRate:
          type: number
          minimum: 0.0001
        date:
          type: string
          format: date
        note:
          type: string
        paymentMethodRef:
          $ref: '#/components/schemas/Ref'
        billRef:
          type: object
          properties:
            id:
              type: string
            billCode:
              type: string
        lines:
          type: array
          items:
            type: object
            required:
              - amount
              - allocatedOnDate
            properties:
              amount:
                $ref: '#/components/schemas/Money'
              allocatedOnDate:
                type: string
                format: date
              reference:
                type: string
              links:
                type: array
                items:
                  type: object
                  properties:
                    billId:
                      type: string
                    amount:
                      $ref: '#/components/schemas/Money'
    PartyRef:
      type: object
      required:
        - id
      properties:
        id:
          type: string
        name:
          type: string
    Money:
      type: number
      description: Decimal amount in the document's `currency`.
    Ref:
      type: object
      required:
        - id
      properties:
        id:
          type: string
        name:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your application's API key (`sk_development_…` or `sk_production_…`). An
        optional `X-Signature` / `X-Timestamp` HMAC pair may additionally be
        sent for stronger security — see
        [Authentication](/concepts/authentication).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.