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

# List bills and credits available to pay for a vendor

> Lists open vendor bills and available vendor credits for a specific QuickBooks Desktop vendor. Use each `bill.billId` as `applyToTransactions[].transactionId` in bill-payment requests. To apply a returned credit, place it under the target bill's `applyToTransactions[].applyCredits[]` entry, set `creditTransactionId` to `credit.creditTransactionId`, and choose an `appliedAmount` that does not exceed `credit.creditRemaining` or the target bill's remaining amount due.

**NOTE:** QuickBooks Desktop does not support pagination for bills to pay; hence, there is no `cursor` parameter. Users typically have few bills to pay.



## OpenAPI

````yaml GET /quickbooks-desktop/bills-to-pay
openapi: 3.1.0
info:
  title: Conductor API
  version: 0.0.1
servers:
  - url: https://api.conductor.is/v1
security:
  - BearerAuth: []
paths:
  /quickbooks-desktop/bills-to-pay:
    get:
      summary: List bills and credits available to pay for a vendor
      description: >-
        Lists open vendor bills and available vendor credits for a specific
        QuickBooks Desktop vendor. Use each `bill.billId` as
        `applyToTransactions[].transactionId` in bill-payment requests. To apply
        a returned credit, place it under the target bill's
        `applyToTransactions[].applyCredits[]` entry, set `creditTransactionId`
        to `credit.creditTransactionId`, and choose an `appliedAmount` that does
        not exceed `credit.creditRemaining` or the target bill's remaining
        amount due.


        **NOTE:** QuickBooks Desktop does not support pagination for bills to
        pay; hence, there is no `cursor` parameter. Users typically have few
        bills to pay.
      parameters:
        - in: header
          name: Conductor-End-User-Id
          schema:
            type: string
            description: The ID of the End-User to receive this request.
            example: end_usr_1234567abcdefg
            x-stainless-naming:
              typescript:
                method_argument: conductorEndUserId
              mcp:
                method_argument: conductorEndUserId
          required: true
          description: The ID of the End-User to receive this request.
        - in: query
          name: vendorId
          schema:
            type: string
            maxLength: 36
            description: >-
              The vendor whose open bills and available credits should be
              returned.
            example: 80000001-1234567890
          required: true
          description: >-
            The vendor whose open bills and available credits should be
            returned.
        - in: query
          name: payablesAccountId
          schema:
            description: >-
              Filter for open bills and available credits assigned to this
              Accounts-Payable account. If omitted, QuickBooks Desktop uses the
              default A/P account configured in the company file.
            example: 80000001-1234567890
            type: string
            maxLength: 36
          description: >-
            Filter for open bills and available credits assigned to this
            Accounts-Payable account. If omitted, QuickBooks Desktop uses the
            default A/P account configured in the company file.
        - in: query
          name: dueDate
          schema:
            description: >-
              Filter the bill branch to open bills due on or before this date,
              in ISO 8601 format (YYYY-MM-DD). If omitted, QuickBooks Desktop
              returns open bills from all due dates. Available credits can still
              be returned because credits do not have a due date.
            example: '2025-02-01'
            type: string
            format: date
          description: >-
            Filter the bill branch to open bills due on or before this date, in
            ISO 8601 format (YYYY-MM-DD). If omitted, QuickBooks Desktop returns
            open bills from all due dates. Available credits can still be
            returned because credits do not have a due date.
        - in: query
          name: currencyIds
          schema:
            description: Filter for open bills and available credits in these currencies.
            example:
              - 80000001-1234567890
            type: array
            items:
              type: string
          description: Filter for open bills and available credits in these currencies.
      responses:
        '200':
          description: >-
            Returns open vendor bills and available vendor credits for a
            specific QuickBooks Desktop vendor.
          headers:
            Conductor-Request-Id:
              required: true
              description: The unique identifier for this API request.
              schema:
                type: string
                description: The unique identifier for this API request.
                example: req_1234567abcdefg
          content:
            application/json:
              schema:
                type: object
                properties:
                  objectType:
                    description: The type of object. This value is always `"list"`.
                    example: list
                    type: string
                    const: list
                  url:
                    type: string
                    description: The endpoint URL where this list can be accessed.
                    example: /v1/quickbooks-desktop/bills-to-pay
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/qbd_bill_to_pay'
                    description: >-
                      The array of bills-to-pay records. Each record has either
                      a `bill` object or a `credit` object, and the other branch
                      is `null`.
                required:
                  - objectType
                  - url
                  - data
                additionalProperties: false
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Conductor from 'conductor-node';

            const conductor = new Conductor({
              apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
            });

            const billsToPays = await conductor.qbd.billsToPay.list({
              vendorId: '80000001-1234567890',
              conductorEndUserId: 'end_usr_1234567abcdefg',
            });

            console.log(billsToPays.data);
        - lang: Python
          source: |-
            import os
            from conductor import Conductor

            conductor = Conductor(
                api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
            )
            bills_to_pays = conductor.qbd.bills_to_pay.list(
                vendor_id="80000001-1234567890",
                conductor_end_user_id="end_usr_1234567abcdefg",
            )
            print(bills_to_pays.data)
components:
  schemas:
    qbd_bill_to_pay:
      type: object
      properties:
        bill:
          anyOf:
            - $ref: '#/components/schemas/qbd_payable_bill'
            - type: 'null'
          description: >-
            The open bill with a positive amount due that can be paid for the
            requested vendor. In each bills-to-pay result, either `bill` is an
            object and `credit` is `null`, or `credit` is an object and `bill`
            is `null`.
        credit:
          anyOf:
            - $ref: '#/components/schemas/qbd_applicable_credit'
            - type: 'null'
          description: >-
            The vendor credit linked to the requested vendor that can be applied
            to open bills. In each bills-to-pay result, either `credit` is an
            object and `bill` is `null`, or `bill` is an object and `credit` is
            `null`.
      required:
        - bill
        - credit
      additionalProperties: false
      title: The Bill To Pay object
      x-conductor-object-type: transaction
      x-conductor-sidebar-group-name: Bills to Pay
      summary: >-
        Bills to pay are open vendor bills and available vendor credits returned
        by QuickBooks Desktop for a specific vendor. Use these records when
        deciding which bills and credits to include in bill check payments or
        bill credit card payments.
    qbd_payable_bill:
      type: object
      properties:
        billId:
          type: string
          maxLength: 36
          description: >-
            The ID of the open bill available to pay. Pass this value as
            `transactionId` in a bill-payment `applyToTransactions` entry.
          example: 123ABC-1234567890
        transactionType:
          type: string
          enum:
            - ar_refund_credit_card
            - bill
            - bill_payment_check
            - bill_payment_credit_card
            - build_assembly
            - charge
            - check
            - credit_card_charge
            - credit_card_credit
            - credit_memo
            - deposit
            - estimate
            - inventory_adjustment
            - invoice
            - item_receipt
            - journal_entry
            - liability_adjustment
            - paycheck
            - payroll_liability_check
            - purchase_order
            - receive_payment
            - sales_order
            - sales_receipt
            - sales_tax_payment_check
            - transfer
            - vendor_credit
            - ytd_adjustment
          description: The type of transaction for this payable bill.
          example: bill
        payablesAccount:
          type: object
          properties:
            id:
              anyOf:
                - type: string
                - type: 'null'
              description: >-
                The unique identifier assigned by QuickBooks to this object.
                This ID is unique across all objects of the same type, but not
                across different QuickBooks object types.
              example: 80000001-1234567890
            fullName:
              anyOf:
                - type: string
                - type: 'null'
              description: >-
                The fully-qualified unique name for this object, formed by
                combining the names of its parent objects with its own `name`,
                separated by colons. Not case-sensitive.
              example: Parent:Child:Grandchild
          required:
            - id
            - fullName
          additionalProperties: false
          description: >-
            The Accounts-Payable (A/P) account to which this payable bill is
            assigned, used for accounts-payable tracking.


            **IMPORTANT**: If this payable bill is linked to other transactions,
            this A/P account must match the `payablesAccount` used in those
            other transactions.
          example:
            id: 80000001-1234567890
            fullName: Accounts-Payable
        transactionDate:
          type: string
          format: date
          description: The date of this payable bill, in ISO 8601 format (YYYY-MM-DD).
          example: '2024-10-01'
        refNumber:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The case-sensitive user-defined reference number for this payable
            bill, which can be used to identify the transaction in QuickBooks.
            This value is not required to be unique and can be arbitrarily
            changed by the QuickBooks user.
          example: BILL-1234
        dueDate:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          description: >-
            The date by which this payable bill must be paid, in ISO 8601 format
            (YYYY-MM-DD).
          example: '2024-10-31T00:00:00.000Z'
        amountDue:
          type: string
          description: >-
            The amount QuickBooks Desktop reports as due and available to pay
            for this open bill, represented as a decimal string. Use this value
            as the candidate `applyToTransactions[].paymentAmount` when creating
            a bill payment; reduce the payment by any credits you apply.
          example: '1000.00'
        currency:
          anyOf:
            - type: object
              properties:
                id:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The unique identifier assigned by QuickBooks to this object.
                    This ID is unique across all objects of the same type, but
                    not across different QuickBooks object types.
                  example: 80000001-1234567890
                fullName:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The fully-qualified unique name for this object, formed by
                    combining the names of its parent objects with its own
                    `name`, separated by colons. Not case-sensitive.
                  example: Parent:Child:Grandchild
              required:
                - id
                - fullName
              additionalProperties: false
            - type: 'null'
          description: >-
            The payable bill's currency. For built-in currencies, the name and
            code are standard ISO 4217 international values. For user-defined
            currencies, all values are editable.
          example:
            id: 80000001-1234567890
            fullName: USD
        exchangeRate:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            The market exchange rate between this payable bill's currency and
            the home currency in QuickBooks at the time of this transaction.
            Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD
            if USD is the home currency).
          example: 1.2345
        amountDueInHomeCurrency:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The monetary amount due for this payable bill converted to the home
            currency of the QuickBooks company file. Represented as a decimal
            string.
          example: '1234.56'
      required:
        - billId
        - transactionType
        - payablesAccount
        - transactionDate
        - refNumber
        - dueDate
        - amountDue
        - currency
        - exchangeRate
        - amountDueInHomeCurrency
      additionalProperties: false
      title: The Payable Bill object
      x-conductor-object-type: nested
    qbd_applicable_credit:
      type: object
      properties:
        creditTransactionId:
          type: string
          maxLength: 36
          description: >-
            The ID of the credit transaction available to apply to the vendor's
            open bills. To apply this credit in a bill-payment request, place it
            under the target bill's `applyToTransactions[].applyCredits[]` entry
            and pass this value as `creditTransactionId`.
          example: 123ABC-1234567890
        transactionType:
          type: string
          enum:
            - ar_refund_credit_card
            - bill
            - bill_payment_check
            - bill_payment_credit_card
            - build_assembly
            - charge
            - check
            - credit_card_charge
            - credit_card_credit
            - credit_memo
            - deposit
            - estimate
            - inventory_adjustment
            - invoice
            - item_receipt
            - journal_entry
            - liability_adjustment
            - paycheck
            - payroll_liability_check
            - purchase_order
            - receive_payment
            - sales_order
            - sales_receipt
            - sales_tax_payment_check
            - transfer
            - vendor_credit
            - ytd_adjustment
          description: The type of transaction for this applicable credit.
          example: vendor_credit
        payablesAccount:
          type: object
          properties:
            id:
              anyOf:
                - type: string
                - type: 'null'
              description: >-
                The unique identifier assigned by QuickBooks to this object.
                This ID is unique across all objects of the same type, but not
                across different QuickBooks object types.
              example: 80000001-1234567890
            fullName:
              anyOf:
                - type: string
                - type: 'null'
              description: >-
                The fully-qualified unique name for this object, formed by
                combining the names of its parent objects with its own `name`,
                separated by colons. Not case-sensitive.
              example: Parent:Child:Grandchild
          required:
            - id
            - fullName
          additionalProperties: false
          description: >-
            The Accounts-Payable (A/P) account to which this applicable credit
            is assigned, used for accounts-payable tracking.


            **IMPORTANT**: If this applicable credit is linked to other
            transactions, this A/P account must match the `payablesAccount` used
            in those other transactions.
          example:
            id: 80000001-1234567890
            fullName: Accounts-Payable
        transactionDate:
          type: string
          format: date
          description: The date of this applicable credit, in ISO 8601 format (YYYY-MM-DD).
          example: '2024-10-01'
        refNumber:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The case-sensitive user-defined reference number for this applicable
            credit, which can be used to identify the transaction in QuickBooks.
            This value is not required to be unique and can be arbitrarily
            changed by the QuickBooks user.
          example: CREDIT-1234
        creditRemaining:
          type: string
          description: >-
            The remaining vendor credit available to apply to open bills,
            represented as a decimal string. When applying this credit to a
            bill-payment request, choose an
            `applyToTransactions[].applyCredits[].appliedAmount` that does not
            exceed this value or the target bill's remaining amount due.
          example: '25.11'
        currency:
          anyOf:
            - type: object
              properties:
                id:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The unique identifier assigned by QuickBooks to this object.
                    This ID is unique across all objects of the same type, but
                    not across different QuickBooks object types.
                  example: 80000001-1234567890
                fullName:
                  anyOf:
                    - type: string
                    - type: 'null'
                  description: >-
                    The fully-qualified unique name for this object, formed by
                    combining the names of its parent objects with its own
                    `name`, separated by colons. Not case-sensitive.
                  example: Parent:Child:Grandchild
              required:
                - id
                - fullName
              additionalProperties: false
            - type: 'null'
          description: >-
            The applicable credit's currency. For built-in currencies, the name
            and code are standard ISO 4217 international values. For
            user-defined currencies, all values are editable.
          example:
            id: 80000001-1234567890
            fullName: USD
        exchangeRate:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            The market exchange rate between this applicable credit's currency
            and the home currency in QuickBooks at the time of this transaction.
            Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD
            if USD is the home currency).
          example: 1.2345
        creditRemainingInHomeCurrency:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The remaining balance of this applicable credit converted to the
            home currency of the QuickBooks company file. Represented as a
            decimal string.
          example: '25.11'
      required:
        - creditTransactionId
        - transactionType
        - payablesAccount
        - transactionDate
        - refNumber
        - creditRemaining
        - currency
        - exchangeRate
        - creditRemainingInHomeCurrency
      additionalProperties: false
      title: The Applicable Credit object
      x-conductor-object-type: nested
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Conductor secret key using Bearer auth (e.g., `"Authorization:
        Bearer {{YOUR_SECRET_KEY}}"`).

````