COconductor-is

List bills and credits available to pay for a vendor

Changed on

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.

get/quickbooks-desktop/bills-to-pay

Request

Query parameters

vendorIdstring required

The vendor whose open bills and available credits should be returned.

Example:80000001-1234567890
payablesAccountIdstring

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
dueDatestring date

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
currencyIdsstring[]

Filter for open bills and available credits in these currencies.

[
  "80000001-1234567890"
]

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

Returns open vendor bills and available vendor credits for a specific QuickBooks Desktop vendor.

objectType'list' required

The type of object. This value is always "list".

urlstring required

The endpoint URL where this list can be accessed.

Example response

{
  "objectType": "list",
  "url": "/v1/quickbooks-desktop/bills-to-pay",
  "data": [
    {
      "bill": {
        "billId": "123ABC-1234567890",
        "transactionType": "bill",
        "payablesAccount": {
          "id": "80000001-1234567890",
          "fullName": "Accounts-Payable"
        },
        "transactionDate": "2024-10-01",
        "refNumber": "BILL-1234",
        "dueDate": "2024-10-31",
        "amountDue": "1000.00",
        "currency": {
          "id": "80000001-1234567890",
          "fullName": "USD"
        },
        "exchangeRate": 1.2345,
        "amountDueInHomeCurrency": "1234.56"
      },
      "credit": {
        "creditTransactionId": "123ABC-1234567890",
        "transactionType": "vendor_credit",
        "payablesAccount": {
          "id": "80000001-1234567890",
          "fullName": "Accounts-Payable"
        },
        "transactionDate": "2024-10-01",
        "refNumber": "CREDIT-1234",
        "creditRemaining": "25.11",
        "currency": {
          "id": "80000001-1234567890",
          "fullName": "USD"
        },
        "exchangeRate": 1.2345,
        "creditRemainingInHomeCurrency": "25.11"
      }
    }
  ]
}

Changes

  • 8ee3502091a4Revision changes
    • warning

      added the new transfer_inventory enum value to the //// response property for the response status

    • warning

      added the new transfer_inventory enum value to the //// response property for the response status

  • daabb801a173Revision changes
    • warning

      added the new unknown enum value to the //// response property for the response status

    • warning

      added the new unknown enum value to the //// response property for the response status