Global API
Request

Payment

3min

When processing a Payment, use the requestJSON to pass the Payment data. The returned response will contain a responseJSON section with the Payment response returned by Breadwinner for Quickbooks.

The Payment object has the following parameters.

Payment

Field Name

Data Type

Description

CurrencyRef

value_name

Reference to the currency in which all amounts on the associated transaction are expressed.

CustomerRef*

value_name

The ID (Unique QuickBooks Online ID) for the referenced customer

DepositToAccountRef

value_name

Account to which money is deposited

ExchangeRate

Decimal

Indicates currency exchange rate

Id

String

Unique identifier for this object and ReadOnly field

Line

LineItem

Individual line items of a transaction

Metadata

Metadata

Descriptive information about the object. The MetaData values are set by Data Services and are read only

PaymentMethodRef

value_name

Indicates Payment method reference Id

PaymentRefNum

String

Indicates Reference Number for a payment

PrivateNote

String

Indicates Memo for a payment

Sparse

Boolean

Indicates full update or partial update. Read Only

SyncToken

String

Version number of the object. It is used to lock an object for use by one app at a time. Read Only

TotalAmt

Decimal

Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Read Only

TxnDate

String

The date entered by the user when this transaction occurred. (add by converting date to string)

UnappliedAmt

Decimal

Indicates the amount that has not been applied to pay amounts owed for sales transactions

UniqueId

String

Indicates unique Id

VendorRef

value_name

The ID (Unique QuickBooks Online ID) for the referenced vendor

LineItem

Field Name

Data Type

Description

Amount

Decimal

Indicates the total amount for a particular Invoice or a Credit Memo

LinkedTxn

List<LinkedTransactions>

Indicates a List of LinkedTransactions

LinkedTransactions

Field Name

Data Type

Description

TxnId

String

Indicates Invoice Id or Credit Memo Id

TxnType

String

Indicates value such as Invoice or CreditMemo

Updated 14 May 2024
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Doc contributor
Did this page help you?