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


List AR Payments

This will include posted payments and advanced.

readByQuery

<readByQuery>
    <object>ARPAYMENT</object>
    <fields>*</fields>
    <query></query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use ARPAYMENT
fields Optional string Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.
query Required string SQL-like query based on fields on the object. Illegal XML characters must be properly encoded. The following SQL operators are supported: <, >, >=, <=, =, like, not like, in, not in. When doing NULL comparisons: IS NOT NULL, IS NULL. Multiple fields may be matched using the AND and OR operators. Joins are not supported. Single quotes in any operands must be escaped with a backslash - For example, the value Erik's Deli would become 'Erik\'s Deli'.
pagesize Optional integer Set a custom page size between 1 and 1000 items (Default: 100)

Get AR Payment

read

<read>
    <object>ARPAYMENT</object>
    <keys>1</keys>
    <fields>*</fields>
</read>

Parameters

Name Required Type Description
object Required string Use ARPAYMENT
keys Required string The payment RECORDNO to get
fields Optional string Comma-separated list of fields on the object to get. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value.

Create AR Payment (Legacy)

This will create an AR payment in the system. If you do not use it to apply the payment against an invoice, the AR module’s “Customer Account Type” setting will dictate how the payment is applied:

  • Open Item (most popular/default setting) - The system will create the payment as an AR Advance, leaving it unapplied
  • Balance Forward - The system will create the payment and apply it to the oldest invoices automatically

create_arpayment

<create_arpayment>
    <customerid>6</customerid>
    <paymentamount>10</paymentamount>
    <translatedamount>20</translatedamount>
    <bankaccountid>BOFA1435</bankaccountid>
    <refid>1234</refid>
    <overpaylocid></overpaylocid>
    <overpaydeptid></overpaydeptid>
    <datereceived>
        <year>2013</year>
        <month>5</month>
        <day>6</day>
    </datereceived>
    <paymentmethod>Printed Check</paymentmethod>
    <basecurr>USD</basecurr>
    <currency>CAD</currency>
    <exchratetype>Intacct Daily Rate</exchratetype>
    <arpaymentitem>
        <invoicekey>25</invoicekey>
        <amount>10</amount>
    </arpaymentitem>
</create_arpayment>

Parameters

Name Required Type Description
customerid Required string Customer ID
paymentamount Required currency Transaction amount
translatedamount Optional currency Base amount
batchkey Optional integer AR payment summary record number to add this payment to. Required if not using bankaccountid or undepfundsacct.
bankaccountid Optional string Bank account ID. Required if not using undepfundsacct or batchkey.
undepfundsacct Optional string Undeposited funds GL account. Required if not using bankaccountid or batchkey.
refid Optional string Reference number
overpaylocid Optional string Overpayment location ID
overpaydeptid Optional string Overpayment department ID
datereceived Optional object Received payment date
paymentmethod Optional string Payment method. Use Printed Check, Cash, EFT, Credit Card, Online Charge Card, or Online ACH Debit.
basecurr Optional string Base currency code
currency Optional string Payment currency code
exchratedate Optional object Exchange rate date.
exchratetype Optional string Exchange rate type. Do not use if exchrate is set. (Leave blank to use Intacct Daily Rate)
exchrate Optional currency Exchange rate value. Do not use if exchangeratetype is set.
cctype Optional string Credit card type
authcode Optional string Authorization code to use
arpaymentitem Optional object Transactions records to apply the payment to. Element may appear 0 to N times.
onlinecardpayment Optional object Online card payment fields only used if paymentmethod is Online Charge Card
onlineachpayment Optional object Online ACH payment fields only used if paymentmethod is Online ACH Debit

arpaymentitem

Name Required Type Description
invoicekey Required integer Transaction record number to apply payment to
amount Required currency Amount to apply. This must be less than or equal to paymentamount element of payment.

onlinecardpayment

Name Required Type Description
cardnum Required string Card number
expirydate Required string Expiration date
cardtype Required string Card type
securitycode Optional string Security code
usedefaultcard Optional boolean Use false for No, true for Yes.

onlineachpayment

Name Required Type Description
bankname Required string Bank name
accounttype Required string Account type
accountnumber Required string Account number
routingnumber Required string Routing number
accountholder Required string Account holder
usedefaultcard Optional boolean Use false for No, true for Yes.

Apply AR Payment (Legacy)

apply_arpayment

<apply_arpayment>
    <arpaymentkey>136</arpaymentkey>
    <paymentdate>
        <year>2013</year>
        <month>5</month>
        <day>16</day>
    </paymentdate>
    <memo>Apply AR Payment from API</memo>
    <overpaylocid></overpaylocid>
    <overpaydeptid></overpaydeptid>
    <arpaymentitems>
        <arpaymentitem>
            <invoicekey>135</invoicekey>
            <amount>10.99</amount>
        </arpaymentitem>
    </arpaymentitems>
</apply_arpayment>

Parameters

Name Required Type Description
arpaymentkey Required object Payment record to apply.
paymentdate Required object Apply payment date
memo Optional string Memo
overpaylocid Optional string Overpayment location ID
overpaydeptid Optional string Overpayment department ID
arpaymentitem Optional arpaymentitem[] Transactions records to apply the payment to.

arpaymentitem

Name Required Type Description
invoicekey Required integer Transaction record number to apply payment to
amount Required currency Amount to apply. This must be less than or equal to paymentamount element of payment.

Reverse AR Payment (Legacy)

reverse_arpayment

<reverse_arpayment key="1234">
    <datereversed>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </datereversed>
</reverse_arpayment>

Parameters

Name Required Type Description
key Required integer AR payment record number to reverse
datereversed Required object Reverse date
description Optional string Memo
nsfclosedaccount Optional string NSF closed account

datereversed

Name Required Type Description
year Required string Year yyyy
month Required string Month mm
day Required string Day dd

Provide feedback