AR Payments - Sage Intacct

DataBlend supports the API calls to Create AR Payment records within Sage Intacct leveraging the Sage Intacct SDK. In addition, Custom Fields can be added for data that is unique to your business practices.

An AR payment is a transaction used to record a payment against an AR invoice or an AR adjustment/debit memo.

Table of Contents:

1 AR Payment Apply
2 AR Payment Item Apply
3 AR Payment Create Standard
4 AR Payment Create Legacy
5 AR Payment Reverse

When to use Standard versus Legacy Call?

If you will have overpayments/advance payments that will not initially be applied to an open invoice, the legacy call will allow you to post both invoice specific entries and advances.
If you need to apply your payment to individual lines of invoices or debit/credit memos in Intacct, you should use the standard call.

AR Payment Apply

You can apply overpayments, advances, credit memos, or negative invoices setting the RECORDNO as follows:

To apply an overpayment or an advance, use the RECORDNO from the ARPAYMENT object.
To apply a credit memo, use the RECORDNO from the ARADJUSTMENT object.
To apply a negative invoice or invoice with an inline credit, use the RECORDNO from the ARINVOICE object.

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes
RECORDNO	RECORDNO	Record number	Yes	Payment record to apply
DATERECEIVED	PAYMENTDATE	Payment date	Yes	Payment date in the `mm/dd/yyyy` format
MEMO	MEMO	Memo	Optional	Expected value is free text (1000)
OVERPAYLOCID	OVERPAYLOCID	Overpayment location	Optional	Expected value is free text
OVERPAYDEPTID	OVERPAYDEPTID	Overpayment department	Optional	Expected value is free text
SUMMARYRECORDNO			Optional	Expected value is free text
TARGET_ENTITY	ENTITY	Entity name	Optional	Expected value is free text (40)
ARPAYMENTITEMS	See table below	See table below	Yes	Transactions records to apply the payment to

AR Payment Item Apply

You can apply the payments to an invoice or a debit memo. To do so, set the INVOICEKEY as follows:

To apply to an invoice, use the RECORDNO from the ARINVOICE object.
To apply to a debit memo, use the RECORDNO from the ARADJUSTMENT.

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes
INVOICEKEY	INVOICEKEY	Record number	Yes	Transaction record number to apply payment to
AMOUNT	AMOUNT	Payment amount	Yes	Amount to apply. This must be less than or equal to `paymentamount` element of payment. Expected value is decimal.

AR Payment Create Standard

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes
ADJUSTMENTAMOUNT	ADJUSTMENTAMOUNT	Adjustment transaction base amount	Optional	Expected value is decimal
ADJUSTMENTENTRYKEY	ADJUSTMENTENTRYKEY	Adjustment transaction entry record number	Optional	Expected value is integer
ADJUSTMENTKEY	ADJUSTMENTKEY	Adjustment transaction record number	Optional	Expected value is integer
ADVANCEENTRYKEY	ADVANCEENTRYKEY	Advance entry record number	Optional	Expected value is integer
ADVANCEKEY	ADVANCEKEY	Advance record number	Optional	Expected value is integer
AMOUNTTOPAY	TOTALDUE	Amount due	Optional	Expected value is decimal
BASECURR	BASECURR	Base currency	Optional	Expected value is free text (3)
BILLTOPAYNAME	BILLTOPAYTONAME	Pay to	Optional	Expected value is free text
CURRENCY	CURRENCY	Payment currency	Yes	Expected value is free text
CUSTOMERID	CUSTOMERID	Customer ID	Yes	Expected value is free text (21)
DESCRIPTION	DESCRIPTION	Memo	Optional	Expected value is free text.
DISCOUNTDATE	DISCOUNTDATE	Discount date	Optional	Discount date in the `mm/dd/yyyy` format. All discounts available at this date are applied. You can supply a date in the past to access a discount whose deadline has already passed. You must provide the correct `TRX_PAYMENTAMOUNT` for the entire amount due (with the discount amount calculated in) for the discount to apply.
DOCNUMBER	DOCNUMBER	Document or check no.	Optional	Expected value is free text (100)
ENTRYKEY	ENTRYKEY	Invoice entry record number	Optional	Expected value is integer
EXCH_RATE_TYPE_ID	EXCH_RATE_TYPE_ID	Exchange rate type	Optional	Do not use if `EXCHANGE_RATE` is set. (Leave blank to use Intacct Daily Rate)
EXCHANGE_RATE	EXCHANGE_RATE	Exchange rate value	Optional	Do not use if `EXCH_RATE_TYPE_ID` is set.
FINANCIALENTITY	FINANCIALENTITY	Financial entity	Optional	Financial entity from which the payment will be paid. Can be a checking account ID or a savings account ID. Required if not using a summary (`PRBATCH`) or undeposited funds account (`UNDEPOSITEDACCOUNTNO`). Expected value is free text (20)
INLINEAMOUNT	INLINEAMOUNT	Inline transaction base amount	Optional	Expected value is decimal
INLINEKEY	INLINEKEY	Inline transaction record number	Optional	Expected value is integer
INLINEENTRYKEY	INLINEENTRYKEY	Inline transaction entry record number	Optional	Expected value is integer
MEMOENTRYRECORDNO			Optional
MEMORECORDNO			Optional
OVERPAYMENTAMOUNT	OVERPAYMENTAMOUNT	Overpayment base amount	Optional	Overpayment amount recorded by the payment. Expected value is decimal
OVERPAYMENTLOCATIONID	OVERPAYMENTLOCATIONID	Location ID	Optional	Location ID in which to receive an overpayment
PAYMENTAMOUNT	PAYMENTAMOUNT	Payment base amount	Optional	Expected value is decimal
PAYMENTDATE	PAYMENTDATE	Payment date	Optional	Payment date in the `mm/dd/yyyy` format when paying with a charge card. This is the date on which the transaction occurred, according to your statement. (Default: today’s date)
PAYMENTMETHOD	PAYMENTMETHOD	Payment method	Yes	Use `Printed Check`, `Cash`, `EFT`, `Credit Card`, `Online Charge Card`, or `Online ACH Debit`.
POSTEDADVANCEAMOUNT	POSTEDADVANCEAMOUNT	Posted advance base amount	Optional	Expected value is decimal
PRBATCH	PRBATCH	Summary	Optional	Expected value is free text (100)
RECEIPTDATE	RECEIPTDATE	Receipt date	Yes	Receipt date in the `mm/dd/yyyy` format. This is the date on which to post to the GL.
RECORDKEY	RECORDKEY	Invoice record number	Optional	Expected value is integer
UNDEPOSITEDACCOUNTNO	UNDEPOSITEDACCOUNTNO	Undeposited funds account no.	Optional	Required if not using a financial entity (`FINANCIALENTITY`) or summary (`PRBATCH`). You can record the deposit so that your books reflect the transfer of funds from your undeposited funds account to your bank account when you move the held payments.. Expected value is free text

AR Payment Create Legacy

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes
AMOUNT	AMOUNT	Base amount	Yes	Expected value is decimal
AUTHCODE	AUTHCODE	Authorization code	Optional	Expected value is free text
BANKACCOUNTID	BANKACCOUNTID	Bank account ID	Yes/Optional	Required if not using `undepfundsacct` or `batchkey`.
BASECURR	BASECURR	Base currency	Yes/Optional	Required if multi currency. Expected value is free text (3)
CCTYPE	CCTYPE	Credit card type	Optional	Expected value is free text
CURRENCY	CURRENCY	Payment currency	Yes/Optional	Required if multi currency. Expected value is free text (3)
CUSTOMERID	CUSTOMERID	Customer ID	Yes	Expected value is free text (21)
DATERECEIVED	DATERECEIVED	Received payment date	Optional	Object
EXCHRATE	EXCHRATE	Exchange rate value	Yes/Optional	Required if multi currency. Do not use if `exchangeratetype` is set.
EXCHRATEDATE	EXCHRATEDATE	Exchange rate date	Yes/Optional	Required if multi currency
EXCHRATETYPE	EXCHRATETYPE	Exchange rate type	Yes/Optional	Required if multi currency. Do not use if `exchrate` is set. (Leave blank to use `Intacct Daily Rate`)
INVOICEKEY	INVOICEKEY	Transaction record number	Yes	Transaction record number to apply payment to. Expected value is integer
OVERPAYDEPTID	OVERPAYDEPTID	Overpayment department ID	Optional	Expected value is free text
OVERPAYLOCID	OVERPAYLOCID	Overpayment location ID	Optional	Expected value is free text
PAYMENTAMOUNT	PAYMENTAMOUNT	Transaction amount	Yes	Expected value is decimal
PAYMENTMETHOD	PAYMENTMETHOD	Payment method	Yes	Use `Printed Check`, `Cash`, `EFT`, `Credit Card`, `Online Charge Card`, or `Online ACH Debit`.
REFERENCENUMBER	REFID	Reference number	Optional	Expected value is free text
TRANSLATEDAMOUNT	TRANSLATEDAMOUNT	Base amount	Optional	Expected value is decimal
UNDEPFUNDSACCT	UNDEPFUNDSACCT	Undeposited funds GL account	Yes/Optional	Required if not using `bankaccountid` or `batchkey`. You can record the deposit so that your books reflect the transfer of funds from your undeposited funds account to your bank account when you move the held payments.

AR Payment Reverse

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes

DataBlend Query Object (SDK)	Sage Intacct Object (API)	Sage Intacct UI Name	Required	Notes
RECORDNO	RECORDNO	Record number	Yes	Payment record to reverse
DATERECEIVED	PAYMENTDATE	Payment Date	Yes	Payment date in the `mm/dd/yyyy` format
SUMMARYRECORDNO			Optional	Expected value is free text
MEMO	MEMO	Memo	Optional	Expected value is free text
OVERPAYLOCID	OVERPAYLOCID	Overpayment location	Optional	Expected value is free text
OVERPAYDEPTID	OVERPAYDEPTID	Overpayment department	Optional	Expected value is free text
AMOUNT	AMOUNT	Amount	Optional	Amount to reverse. This must be less than or equal to `paymentamount` element of payment. Expected value is decimal.
INVOICEKEY	INVOICEKEY	Record number	Yes/Optional	Transaction record number to reverse payment from. Required if not using recordno
TARGET_ENTITY	ENTITY	Entity name	Optional	Expected value is free text (40)