An AP payment is a transaction that records a payment against an AP bill or AP adjustment.


List AP Payments

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APPAYMENT
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
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 AP Payment

read

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

Parameters

Name Required Type Description
object Required string Use APPAYMENT
keys Required string The payment RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create Manual AP Payment (Legacy)

create_appayment

<create_appayment>
    <bankaccountid>BOFA1435</bankaccountid>
    <vendorid>1005</vendorid>
    <memo>Hello world</memo>
    <checkdate>
        <year>2016</year>
        <month>12</month>
        <day>31</day>
    </checkdate>
    <checkno>50</checkno>
    <billno>11111</billno>
    <payitems>
        <payitem>
            <glaccountno>75300</glaccountno>
            <!--<accountlabel></accountlabel>-->
            <paymentamount>1.99</paymentamount>
            <item1099></item1099>
            <departmentid></departmentid>
            <locationid></locationid>
        </payitem>
    </payitems>
</create_appayment>

Parameters

Name Required Type Description
bankaccountid Optional string Bank account ID. Required if not using chargecardid.
chargecardid Optional string Charge card ID. Required if not using bankaccountid.
vendorid Required string Vendor ID
memo Optional string Memo
paymentmethod Optional string Payment method. Use Printed Check, Cash, EFT, Charge Card, ACH, Check Delivery, Amex ACH, Amex Charge Card, WF Check, WF Domestic ACH, or WF USD Wire
checkdate Required object Payment date
batchkey Optional integer Summary record number to place this payment in.
checkno Required string Check number or payment reference number
billno Optional string Bill reference number
basepaymentamount Optional currency Base payment amount
basecurr Optional string Base currency code
currency Optional string Transaction 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.
paymentexchratetype Optional string Payment exchange rate type. (Leave blank to use Intacct Daily Rate)
payitems Required array[payitem] Lines of payment. Must have at least 1.

checkdate

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

payitem

Name Required Type Description
glaccountno Optional string GL account number. Required if not using accountlabel.
accountlabel Optional string AP account label. Required if not using glaccountno.
paymentamount Required currency Transaction amount
item1099 Optional boolean Form 1099. Use false for No, true for Yes. Vendor must be setup for 1099s.
locationid Optional string Location ID
departmentid Optional string Department ID

Reverse AP Payment

reverse_appayment

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

Parameters

Name Required Type Description
key Required integer AP payment record number to reverse
datereversed Required object Reverse date
description Optional string Memo

datereversed

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

List AP Payment Requests

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APPAYMENTREQUEST
fields Required string Comma separated list of fields on the object to list. Use * to return all fields.
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 AP Payment Request

read

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

Parameters

Name Required Type Description
object Required string Use APPAYMENTREQUEST
keys Required string The request RECORDNO to get
fields Required string Comma separated list of fields on the object to get. Use * to return all fields.

Create AP Payment Request (Legacy)

Creating an AP payment request begins the process of selecting an existing bill to be paid.

create_paymentrequest

<create_paymentrequest>
    <bankaccountid>BA1143</bankaccountid>
    <vendorid>V0001</vendorid>
    <memo>Memo</memo>
    <paymentmethod>Printed Check</paymentmethod>
    <grouppayments>true</grouppayments>
    <paymentdate>
        <year>2015</year>
        <month>06</month>
        <day>30</day>
    </paymentdate>
    <paymentoption>vendorpref</paymentoption>
    <paymentrequestitems>
        <paymentrequestitem>
            <key>123</key>
            <paymentamount>100.12</paymentamount>
            <credittoapply>8.12</credittoapply>
            <discounttoapply>1.21</discounttoapply>
        </paymentrequestitem>
    </paymentrequestitems>
    <documentnumber>10000</documentnumber>
    <paymentdescription>Memo</paymentdescription>
    <paymentcontact>Jim Smith</paymentcontact>
</create_paymentrequest>

Parameters

Name Required Type Description
bankaccountid Optional string Bank account ID. Required if not using chargecardid.
chargecardid Optional string Charge card ID. Required if not using bankaccountid.
vendorid Required string Vendor ID
memo Optional string Memo
paymentmethod Required string Payment method. Use Printed Check for Check, Cash for Cash, EFT for Record Transfer, Charge Card for Charge Card, or ACH for ACH.
grouppayments Optional boolean Group payments. Use false for No, true for Yes.
paymentdate Required object Payment date
paymentoption Optional string Merge option. Use vendor, bill, vendorpref. (Default: vendor)
paymentrequestitems Required paymentrequestitem[] Items to pay
documentnumber Optional string Document number
paymentdescription Optional string Description
paymentcontact Optional string Notification contact name

paymentdate

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

paymentrequestitem

Name Required Type Description
key Required integer Apply to record number
paymentamount Required currency Amount to apply
credittoapply Optional currency Credit to apply
discounttoapply Optional currency Discount to apply

Approve AP Payment Request (Legacy)

approve_appaymentrequest

<approve_appaymentrequest>
    <appaymentkeys>
        <appaymentkey>1234</appaymentkey>
    </appaymentkeys>
</approve_appaymentrequest>

Parameters

Name Required Type Description
appaymentkeys Required appaymentkey[] AP payment request record numbers to approve

Send AP Payment Request (Legacy)

This function requires the Vendor Payment Services subscription.

send_appaymentrequest

<send_appaymentrequest>
    <appaymentkeys>
        <appaymentkey>1234</appaymentkey>
    </appaymentkeys>
</send_appaymentrequest>

Parameters

Name Required Type Description
appaymentkeys Required appaymentkey[] AP payment request record numbers to send

Confirm AP Payment Request (Legacy)

Use this to confirm checks have been successfully printed.

confirm_appaymentrequest

<confirm_appaymentrequest>
    <appaymentkeys>
        <appaymentkey>1234</appaymentkey>
    </appaymentkeys>
</confirm_appaymentrequest>

Parameters

Name Required Type Description
appaymentkeys Required appaymentkey[] AP payment request record numbers to confirm

Void AP Payment Request (Legacy)

void_appaymentrequest

<void_appaymentrequest>
    <appaymentkeys>
        <appaymentkey>1234</appaymentkey>
    </appaymentkeys>
</void_appaymentrequest>

Parameters

Name Required Type Description
appaymentkeys Required appaymentkey[] AP payment request record numbers to confirm

Provide feedback