--- title: "List all receive-payments" method: GET path: "/quickbooks-desktop/receive-payments" --- # List all receive-payments `GET /quickbooks-desktop/receive-payments` Returns a list of receive-payments. Use the `cursor` parameter to paginate through the results. ## Query parameters - `ids` string[] — Filter for specific receive-payments by their QuickBooks-assigned unique identifier(s). **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request. **NOTE**: If any of the values you specify in this parameter are not found, the request will return an error. - `refNumbers` string[] — Filter for specific receive-payments by their ref-number(s), case-sensitive. In QuickBooks, ref-numbers are not required to be unique and can be arbitrarily changed by the QuickBooks user. **IMPORTANT**: If you include this parameter, QuickBooks will ignore all other query parameters for this request. **NOTE**: If any of the values you specify in this parameter are not found, the request will return an error. - `limit` integer — The maximum number of objects to return. Accepts values ranging from 1 to 150, defaults to 150. When used with cursor-based pagination, this parameter controls how many results are returned per page. To paginate through results, combine this with the `cursor` parameter. Each response will include a `nextCursor` value that can be passed to subsequent requests to retrieve the next page of results. - `cursor` string — The pagination token to fetch the next set of results when paginating with the `limit` parameter. Do not include this parameter on the first call. Use the `nextCursor` value returned in the previous response to request subsequent results. - `updatedAfter` string — Filter for receive-payments updated on or after this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. - `updatedBefore` string — Filter for receive-payments updated on or before this date/time. Accepts the following ISO 8601 formats: - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`). - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks Desktop interprets the timestamp in the local timezone of the end-user's computer. - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) - QuickBooks Desktop interprets the timestamp using the specified timezone. - `transactionDateFrom` string, date — Filter for receive-payments whose `date` field is on or after this date, in ISO 8601 format (YYYY-MM-DD). **NOTE:** QuickBooks Desktop interprets this date as the **start of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T00:00:00`). - `transactionDateTo` string, date — Filter for receive-payments whose `date` field is on or before this date, in ISO 8601 format (YYYY-MM-DD). **NOTE:** QuickBooks Desktop interprets this date as the **end of the specified day** in the local timezone of the end-user's computer (e.g., `2025-01-01` → `2025-01-01T23:59:59`). - `customerIds` string[] — Filter for receive-payments received from these customers. - `accountIds` string[] — Filter for receive-payments associated with these accounts. - `refNumberContains` string — Filter for receive-payments whose `refNumber` contains this substring. **NOTE**: If you use this parameter, you cannot also use `refNumberStartsWith` or `refNumberEndsWith`. - `refNumberStartsWith` string — Filter for receive-payments whose `refNumber` starts with this substring. **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberEndsWith`. - `refNumberEndsWith` string — Filter for receive-payments whose `refNumber` ends with this substring. **NOTE**: If you use this parameter, you cannot also use `refNumberContains` or `refNumberStartsWith`. - `refNumberFrom` string — Filter for receive-payments whose `refNumber` is greater than or equal to this value. If omitted, the range will begin with the first number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison. - `refNumberTo` string — Filter for receive-payments whose `refNumber` is less than or equal to this value. If omitted, the range will end with the last number of the list. Uses a numerical comparison for values that contain only digits; otherwise, uses a lexicographical comparison. - `currencyIds` string[] — Filter for receive-payments in these currencies. - `includeLineItems` boolean — Whether to include line items in the response. Defaults to `true`. ## Headers - `Conductor-End-User-Id` string, required — The ID of the End-User to receive this request. ## Response `200` Returns a list of receive-payments. - object - `objectType` 'list', required — The type of object. This value is always `"list"`. - `url` string, required — The endpoint URL where this list can be accessed. - `data` QbdReceivePayment[], required — The array of receive-payments. - `id` string, required — The unique identifier assigned by QuickBooks to this receive-payment. This ID is unique across all transaction types. - `objectType` 'qbd_receive_payment', required — The type of object. This value is always `"qbd_receive_payment"`. - `createdAt` string, required — The date and time when this receive-payment was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer. - `updatedAt` string, required — The date and time when this receive-payment was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer. - `revisionNumber` string, required — The current QuickBooks-assigned revision number of this receive-payment object, which changes each time the object is modified. When updating this object, you must provide the most recent `revisionNumber` to ensure you're working with the latest data; otherwise, the update will return an error. - `customer` object, nullable, required — The customer or customer-job to which the payment for this receive-payment is credited. - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `receivablesAccount` object, nullable, required — The Accounts-Receivable (A/R) account to which this receive-payment is assigned, used to track the amount owed. If omitted, QuickBooks Desktop uses the default A/R account configured in the company file. **IMPORTANT**: If this receive-payment is linked to other transactions, this A/R account must match the `receivablesAccount` used in all linked transactions. - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `transactionDate` string, date, required — The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD). - `refNumber` string, nullable, required — The case-sensitive user-defined reference number for this receive-payment, 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. - `totalAmount` string, required — The total monetary amount of this receive-payment, represented as a decimal string. - `currency` object, nullable, required — The receive-payment's currency. For built-in currencies, the name and code are standard ISO 4217 international values. For user-defined currencies, all values are editable. - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `exchangeRate` number, nullable, required — The market exchange rate between this receive-payment'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). - `totalAmountInHomeCurrency` string, nullable, required — The total monetary amount of this receive-payment converted to the home currency of the QuickBooks company file. Represented as a decimal string. - `paymentMethod` object, nullable, required — The receive-payment's payment method (e.g., cash, check, credit card). - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `memo` string, nullable, required — A memo or note for this receive-payment that will be displayed at the beginning of reports containing details about this receive-payment. - `depositToAccount` object, nullable, required — The account where the funds for this receive-payment will be or have been deposited. - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `creditCardTransaction` QbdCreditCardTransaction, required - `request` QbdCreditCardTransactionRequest, required - `number` string, required — The credit card number. Must be masked with lower case "x" and no dashes. - `expirationMonth` number, required — The month when the credit card expires. - `expirationYear` number, required — The year when the credit card expires. - `name` string, nullable, required — The cardholder's name on the card. - `address` string, nullable, required — The card's billing address. - `postalCode` string, nullable, required — The card's billing address ZIP or postal code. - `commercialCardCode` string, nullable, required — The commercial card code identifies the type of business credit card being used (purchase, corporate, or business) for Visa and Mastercard transactions only. When provided, this code may qualify the transaction for lower processing fees compared to the standard rates that apply when no code is specified. - `transactionMode` 'card_not_present' | 'card_present', nullable, required — Indicates whether this credit card transaction came from a card swipe (`card_present`) or not (`card_not_present`). - `transactionType` 'authorization' | 'capture' | 'charge' | 'refund' | 'voice_authorization', nullable, required — The QBMS transaction type from which the current transaction data originated. - `response` QbdCreditCardTransactionResponse, required - `statusCode` number, required — The status code returned in the original QBMS transaction response for this credit card transaction. - `statusMessage` string, required — The status message returned in the original QBMS transaction response for this credit card transaction. - `creditCardTransactionId` string, required — The ID returned from the credit card processor for this credit card transaction. - `merchantAccountNumber` string, required — The QBMS account number of the merchant who is running this transaction using the customer's credit card. - `authorizationCode` string, nullable, required — The authorization code returned from the credit card processor to indicate that this charge will be paid by the card issuer. - `avsStreetStatus` 'fail' | 'not_available' | 'pass', nullable, required — Indicates whether the street address supplied in the transaction request matches the customer's address on file at the card issuer. - `avsZipStatus` 'fail' | 'not_available' | 'pass', nullable, required — Indicates whether the customer postal ZIP code supplied in the transaction request matches the customer's postal code recognized at the card issuer. - `cardSecurityCodeMatch` 'fail' | 'not_available' | 'pass', nullable, required — Indicates whether the card security code supplied in the transaction request matches the card security code recognized for that credit card number at the card issuer. - `reconBatchId` string, nullable, required — An internal ID returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature. - `paymentGroupingCode` number, nullable, required — An internal code returned by QuickBooks Merchant Services (QBMS) from the transaction request, needed for the QuickBooks reconciliation feature. - `paymentStatus` 'completed' | 'unknown', required — Indicates whether this credit card transaction is known to have been successfully processed by the card issuer. - `transactionAuthorizedAt` string, required — The date and time when the credit card processor authorized this credit card transaction. - `transactionAuthorizationStamp` number, nullable, required — An internal value for this credit card transaction, needed for the QuickBooks reconciliation feature. - `clientTransactionId` string, nullable, required — A value returned from QBMS transactions for future use by the QuickBooks Reconciliation feature. - `unusedPayment` string, nullable, required — The amount of this receive-payment that remains unapplied to any transactions. This occurs in two cases: (1) When the sum of `paymentAmount` amounts in `applyToTransactions` is less than `totalAmount`, leaving a portion of the payment unused, or (2) When a payment is received that equals the exact amount of an invoice, but credits or discounts are also applied, resulting in excess payment. - `unusedCredits` string, nullable, required — The amount of credit that remains unused after applying credits to this receive-payment. This occurs when the `applyCredit.appliedAmount` specified for a credit memo (`applyCredit.creditMemoId`) in the `applyToTransactions` array is less than the total available credit amount for that credit memo. - `externalId` string, nullable, required — A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation. - `appliedToTransactions` QbdTargetTransaction[], required — The invoice(s) paid by this receive-payment. - `transactionId` string, required — The ID of the target transaction to which this payment is applied. - `transactionType` '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' | 'unknown', required — The type of transaction for this target transaction. - `transactionDate` string, date, nullable, required — The date of this target transaction, in ISO 8601 format (YYYY-MM-DD). - `refNumber` string, nullable, required — The case-sensitive user-defined reference number for this target transaction, 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. - `balanceRemaining` string, nullable, required — The outstanding balance of this target transaction after applying any credits or payments. Represented as a decimal string. - `amount` string, nullable, required — The monetary amount of this target transaction, represented as a decimal string. - `discountAmount` string, nullable, required — The monetary amount by which to reduce this target transaction's balance, represented as a decimal string. - `discountAccount` object, nullable, required — The financial account used to track this target transaction's discount. - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `discountClass` object, nullable, required — The class used to track this target transaction's discount. - `id` string, nullable, required — 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. - `fullName` string, nullable, required — 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. - `linkedTransactions` QbdLinkedTransaction[], required — The target transaction's linked transactions, such as payments applied, credits used, or associated purchase orders. **IMPORTANT**: You must specify the parameter `includeLinkedTransactions` when fetching a list of target transactions to receive this field because it is not returned by default. - `id` string, required — The unique identifier assigned by QuickBooks to this linked transaction. This ID is unique across all transaction types. - `objectType` 'qbd_linked_transaction', required — The type of object. This value is always `"qbd_linked_transaction"`. - `transactionType` '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' | 'unknown', required — The type of transaction for this linked transaction. - `transactionDate` string, date, required — The date of this linked transaction, in ISO 8601 format (YYYY-MM-DD). - `refNumber` string, nullable, required — The case-sensitive user-defined reference number for this linked transaction, 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. - `linkType` 'amount' | 'quantity', nullable, required — Indicates the nature of the link between the transactions: `amount` denotes an amount-based link (e.g., an invoice linked to a payment), and `quantity` denotes a quantity-based link (e.g., an invoice created from a sales order based on the quantity of items received). - `amount` string, nullable, required — The monetary amount of this linked transaction, represented as a decimal string. - `customFields` QbdCustomField[], required — The custom fields for the receive-payment object, added as user-defined data extensions, not included in the standard QuickBooks object. - `ownerId` string, required — The identifier of the owner of the custom field, which QuickBooks internally calls a "data extension". For public custom fields visible in the UI, such as those added by the QuickBooks user, this is always "0". For private custom fields that are only visible to the application that created them, this is a valid GUID identifying the owning application. Internally, Conductor always fetches all public custom fields (those with an `ownerId` of "0") for all objects. - `name` string, required — The name of the custom field, unique for the specified `ownerId`. For public custom fields, this name is visible as a label in the QuickBooks UI. - `type` 'amount_type' | 'date_time_type' | 'integer_type' | 'percent_type' | 'price_type' | 'quantity_type' | 'string_1024_type' | 'string_255_type', required — The data type of this custom field. - `value` string, required — The value of this custom field. The maximum length depends on the field's data type. - `nextCursor` string, nullable, required — The `nextCursor` is a pagination token returned in the response when you use the `limit` parameter in your request. To retrieve subsequent pages of results, include this token as the value of the `cursor` request parameter in your following API calls. **NOTE**: The `nextCursor` value remains constant throughout the pagination process for a specific list instance; continue to use the same `nextCursor` token in each request to fetch additional pages. - `remainingCount` number, nullable, required — The number of objects remaining to be fetched. - `hasMore` boolean, required — Indicates whether there are more objects to be fetched. --- [API](https://skmtc.net/conductor-is/apis/conductor-api.md) · [All operations](https://skmtc.net/conductor-is/apis/conductor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductor-is/conductor-api/revisions/0b07b3ebe160/schema)