v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

List all payments to deposit

Lists received customer payments that are currently available to include in a QuickBooks Desktop deposit. Use each result's paymentTransactionId and, when present, paymentTransactionLineId as the corresponding fields on a deposit line.

NOTE: QuickBooks Desktop does not support pagination for payments to deposit; hence, there is no cursor parameter. Users typically have few payments to deposit.

get/quickbooks-desktop/payments-to-deposit

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Response

Returns a list of payments to deposit.

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/payments-to-deposit",
  "data": [
    {
      "paymentTransactionId": "123ABC-1234567890",
      "paymentTransactionLineId": "456DEF-1234567890",
      "transactionType": "invoice",
      "customer": {
        "id": "80000001-1234567890",
        "fullName": "Acme Corporation"
      },
      "transactionDate": "2024-10-01",
      "refNumber": "PAYMENT-1234",
      "amount": "1000.00",
      "currency": {
        "id": "80000001-1234567890",
        "fullName": "USD"
      },
      "exchangeRate": 1.2345,
      "amountInHomeCurrency": "1234.56"
    }
  ]
}