Create a receive-payment
Creates a new receive-payment.
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").
Body
The customer or customer-job to which the payment for this receive-payment is credited.
The total monetary amount of this receive-payment, represented as a decimal string.
NOTE: The sum of the paymentAmount amounts in the applyToTransactions array cannot exceed the totalAmount, or you will receive an error.
The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).
The invoices to be paid by this receive-payment. This will create a link between this receive-payment and the specified invoices.
IMPORTANT: In each applyToTransactions object, you must specify either paymentAmount, applyCredits, discountAmount, or any combination of these; if none of these are specified, you will receive an error for an empty transaction.
IMPORTANT: The target invoice must have isPaid=false, otherwise, QuickBooks will report this object as "cannot be found".
NOTE: You must specify either isAutoApply or applyToTransactions when creating a receive-payment, but never both.
The credit card transaction data for this receive-payment's payment when using QuickBooks Merchant Services (QBMS). If specifying this field, you must also specify the paymentMethod field.
The account where the funds for this receive-payment will be or have been deposited. If omitted, QuickBooks will use the default Undeposited Funds account.
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).
A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.
IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.
When true, QuickBooks applies totalAmount to any outstanding transaction that exactly matches totalAmount. If no exact match is found, this receive-payment is applied to the oldest outstanding transaction for the customer-job. When false, QuickBooks records the payment but does not apply it to any specific transaction, causing the amount to appear as a credit on the customer-job's next transaction.
IMPORTANT: You must specify either isAutoApply or applyToTransactions when creating a receive-payment, but never both.
A memo or note for this receive-payment that will be displayed at the beginning of reports containing details about this receive-payment.
The receive-payment's payment method (e.g., cash, check, credit card).
NOTE: If this receive-payment contains credit card transaction data supplied from QuickBooks Merchant Services (QBMS) transaction responses, you must specify a credit card payment method (e.g., "Visa", "MasterCard", etc.).
The Accounts-Receivable (A/R) account to which this receive-payment is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/R account.
IMPORTANT: If this receive-payment is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions. For example, when refunding a credit card payment, the A/R account must match the one used in the original credit transactions being refunded.
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.
Response
The invoice(s) paid by this receive-payment.
The date and time when this receive-payment was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
The credit card transaction data for this receive-payment's payment when using QuickBooks Merchant Services (QBMS).
The receive-payment's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The customer or customer-job to which the payment for this receive-payment is credited.
The custom fields for the receive-payment object, added as user-defined data extensions, not included in the standard QuickBooks object.
The account where the funds for this receive-payment will be or have been deposited.
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).
A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.
The unique identifier assigned by QuickBooks to this receive-payment. This ID is unique across all transaction types.
A memo or note for this receive-payment that will be displayed at the beginning of reports containing details about this receive-payment.
The type of object. This value is always "qbd_receive_payment".
"qbd_receive_payment"The receive-payment's payment method (e.g., cash, check, credit card).
The Accounts-Receivable (A/R) account to which this receive-payment is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/R account.
IMPORTANT: If this receive-payment is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions. For example, when refunding a credit card payment, the A/R account must match the one used in the original credit transactions being refunded.
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.
The current 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.
The total monetary amount of this receive-payment, represented as a decimal string.
The total monetary amount of this receive-payment converted to the home currency of the QuickBooks company file. Represented as a decimal string.
The date of this receive-payment, in ISO 8601 format (YYYY-MM-DD).
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.
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.
The date and time when this receive-payment was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.