Knowledge Base

How-To

Sage Intacct Data Target Requirements

AR Payments - Sage Intacct Data Target Requirements

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:

AR Payment Apply
AR Payment Item Apply
AR Payment Create Standard
AR Payment Create Legacy

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
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
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
ACTION	ACTION		Optional	Use `Draft` to receive a payment that is not yet finalized, or `Submit` to post a confirmed payment. (Default: `Submit`).
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	TRX_AMOUNTTOPAY	Transaction amount due	Optional	Header level amount. For payment involving multi-currency, this is the total transaction payment amount. (Amount is ignored if the payment is not cross currency.) Expected value is decimal.
BASEAMOUNTTOPAY	AMOUNTTOPAY	Amount due	Optional	Header level amount. For payment involving multi-currency, this is the translated payment base amount. (Amount is ignored if the payment is not cross currency.) 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
NEGATIVEINVOICEAMOUNT	TRX_NEGATIVEINVOICEAMOUNT	Negative invoice transaction amount	Optional	Negative invoice amount to apply to the payment. Expected value is decimal
NEGATIVEINVOICEENTRYKEY	NEGATIVEINVOICEENTRYKEY	Negative invoice transaction entry record number	Optional	Record number of a negative invoice line to apply to the payment. Expected value is integer
NEGATIVEINVOICEKEY	NEGATIVEINVOICEKEY	Negative invoice transaction record number	Optional	Record number of a negative invoice to apply to the payment. Expected value is integer
OVERPAYMENTAMOUNT	OVERPAYMENTAMOUNT	Overpayment base amount	Optional	Overpayment amount recorded by the payment. Expected value is decimal
OVERPAYMENTDEPARTMENTID	OVERPAYMENTDEPARTMENTID	Department ID	Optional	Department ID in which to receive an overpayment. Expected value is free text
OVERPAYMENTKEY	OVERPAYMENTKEY	Overpayment record number	Optional	Record number of an overpayment to apply to the payment. To find available overpayments, use `readByQuery` on ARPYMT. Expected value is integer
OVERPAYMENTLOCATIONID	OVERPAYMENTLOCATIONID	Location ID	Optional	Location ID in which to receive an overpayment. Expected value is free text
PAYERNAME	PAYERNAME	Payer name	Optional	Name of the payer who is paying invoices on behalf of multiple customers. Required to receive payments for multiple customers in a single request. The payer name and the corresponding payment ID are displayed in AR Sales and other reports to identify multiple payments made in a single request. Expected value is free text (100)
PAYMENTAMOUNT	TRX_PAYMENTAMOUNT	Payment transaction amount	Optional	Line level amount of the cash payment. Must be the full amount of the invoice or debit memo (with the discount amount calculated in) in order to apply a discount using the DISCOUNTDATE parameter. 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
POSTEDOVERPAYMENTAMOUNT	TRX_POSTEDOVERPAYMENTAMOUNT	Posted overpayment base amount	Optional	Overpayment credit amount to apply to the payment. 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
TOTALDISCOUNTTOAPPLY	TRX_TOTALDISCOUNTTOAPPLY	Total amount of discount to apply	Optional	Custom discounts must be enabled in the AR configuration. Do not use if DISCOUNTDATE is set.
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
WHENPAID	WHENPAID	Payment date	Optional	Date when the invoice is fully paid in the `mm/dd/yyyy` format.
ONLINECARDPAYMENT		Object		Online card payment fields only used if `paymentmethod` is `Online Charge Card`
CARDNUM	CARDNUM	Card number	Riquired	Card number
CARDTYPE	CARDTYPE	Card type	Riquired	Card type
EXPIRYDATE	EXPIRYDATE	Expiration date	Riquired	Expiration date in the `mm/dd/yyyy` format.
SECURITYCODE	SECURITYCODE	Security code	Optional	Security code
USEDEFAULTCARD	USEDEFAULTCARD	Use default card	Optional	Use `false` for No, `true` for Yes.

AR Payment Create Legacy

DataBlend Query Object (SDK)

Sage Intacct Object (API)

Sage Intacct UI Name

Required

Notes

AMOUNT

Base amount

Yes

Expected value is decimal

AUTHCODE

Authorization code

Optional

Expected value is free text

BANKACCOUNTID

Bank account ID

Yes/Optional

Required if not using undepfundsacct or batchkey.

BASECURR

Base currency

Yes/Optional

Required if multi currency. Expected value is free text (3)

BATCHKEY

Summary key

Optional

AR payment summary record number to add this payment to. Required if not using bankaccountid or undepfundsacct. Expected value is integer

CCTYPE

Credit card type

Optional

Expected value is free text

CURRENCY

Payment currency

Yes/Optional

Required if multi currency. Expected value is free text (3)

CUSTOMERID

Customer ID

Yes

Expected value is free text (21)

DATERECEIVED

Received payment date

Optional

Object

EXCHRATE

Exchange rate value

Yes/Optional

Required if multi currency. Do not use if exchangeratetype is set.

EXCHRATEDATE

Exchange rate date

Yes/Optional

Required if multi currency

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

Transaction record number

Yes

Transaction record number to apply payment to. Expected value is integer

OVERPAYDEPTID

Overpayment department ID

Optional

Expected value is free text

OVERPAYLOCID

Overpayment location ID

Optional

Expected value is free text

PAYMENTAMOUNT

Transaction amount

Yes

Expected value is decimal

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

Base amount

Optional

Expected value is decimal

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.

ONLINEACHPAYMENT

Object

Online ACH payment fields only used if paymentmethod is Online ACH Debit

ACCOUNTHOLDER

Account holder

Riquired

Account holder

ACCOUNTNUMBER

Account number

Riquired

Account number

ACCOUNTTYPE

Account type

Riquired

Account type

BANKNAME

Bank name

Riquired

Bank name

ROUTINNUMBER

Routing number

Riquired

Routing number

ONLINECARDPAYMENT

Object

Online card payment fields only used if paymentmethod is Online Charge Card

CARDNUM

Card number

Riquired

Card number

CARDTYPE

Card type

Riquired

Card type

EXPIRYDATE

Expiration date

Riquired

Expiration date in the mm/dd/yyyy format.

SECURITYCODE

Security code

Optional

Security code

USEDEFAULTCARD

Use default card

Optional

Use false for No, true for Yes.