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

This page documents both AP payment objects. The enhanced AP payment object, APPYMT, corresponds to Accounts Payable > Pay bills in the new user interface, Sage Intacct Action. With APPYMT, you have access to payment details for each payment entry. For example, you can apply line level credits/discounts to a payment entry through one or more payment detail objects.

The original payment objects, APPAYMENT and APPAYMENTREQUEST, correspond to Accounts Payable > Select Bills to Pay in Sage Intacct.

See the AP Payment entity relationship diagram for a high level understanding of the new payment object.


List AP Payments

readByQuery

Lists submitted payments.

<readByQuery>
    <object>APPYMT</object>
    <fields>*</fields>
    <query>STATE = 'S'</query>
    <pagesize>100</pagesize>
</readByQuery>

Parameters

Name Required Type Description
object Required string Use APPYMT.
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).

query

Name Required Type Description
STATE Optional string State. Use C for confirmed, D for Draft, A for Approved, V for voided, or S for Submitted.

Get AP Payment

read

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

Parameters

Name Required Type Description
object Required string Use APPYMT.
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 AP Payment

When creating a payment for a bill with multiple entries, if theTRX_PAYMENTAMOUNT is not for the full amount of the bill, payments are applied to line items according to the Accounts Payable configuration in the Sage Intacct system.

create

Create a printed check for a bill.

<create>
    <APPYMT>
        <FINANCIALENTITY>CHK-BA1145</FINANCIALENTITY>
        <PAYMENTMETHOD>Printed Check</PAYMENTMETHOD>
        <VENDORID>V0001</VENDORID>
        <PAYMENTDATE>08/07/2017</PAYMENTDATE>
        <APPYMTDETAILS>
            <APPYMTDETAIL>
                <RECORDKEY>90</RECORDKEY>
                <TRX_PAYMENTAMOUNT>50.00</TRX_PAYMENTAMOUNT>
            </APPYMTDETAIL>
        </APPYMTDETAILS>
    </APPYMT>
</create>

Create a record transfer for a specific line of a bill.

<create>
    <APPYMT>
        <FINANCIALENTITY>CHK-BA1145</FINANCIALENTITY>
        <PAYMENTMETHOD>EFT</PAYMENTMETHOD>
        <VENDORID>V0001</VENDORID>
        <DOCNUMBER>12345</DOCNUMBER>
        <PAYMENTDATE>08/07/2017</PAYMENTDATE>
        <APPYMTDETAILS>
            <APPYMTDETAIL>
                <RECORDKEY>90</RECORDKEY>
                <ENTRYKEY>375</ENTRYKEY>
                <TRX_PAYMENTAMOUNT>50.00</TRX_PAYMENTAMOUNT>
            </APPYMTDETAIL>
        </APPYMTDETAILS>
    </APPYMT>
</create>

Parameters

Name Required Type Description
FINANCIALENTITY Required string Financial entity from which the payment will be paid. Can be a checking account ID, a savings account ID, or a charge card ID.
PAYMENTMETHOD Required 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.
PAYMENTREQUESTMETHOD Optional string Approach for paying the bill. Use vendorpref to apply the preference for the vendor as specified in the Sage Intacct system, vendor to pay all bills from the vendor in one payment, or bill to pay each bill from the vendor as as separate payment (Default: vendorpref).
EXCH_RATE_DATE Optional string Exchange rate date in format mm/dd/yyyy (Default: payment date of the request).
EXCH_RATE_TYPE_ID Optional string Exchange rate type (Default: Intacct Daily Rate).
VENDORID Required string Vendor ID.
DOCNUMBER Optional string Document number, which can be the check number or the transaction number, depending on the payment method used.
DESCRIPTION Optional string Description of the payment.
PAYMENTDATE Required string Payment date in format mm/dd/yyyy. Parameter value is shown in WHENCREATED in subsequent read operations.
CURRENCY Required string Transaction currency code.
BASECURR Optional string Base currency code.
ACTION Optional string Use Draft to move the payment to the outbox in the system, or Submit to submit/post the payment depending on the approval workflow (Default: Submit).
APPYMTDETAILS Required array[appymtdetail] Details for the payment, including transaction payment amounts, line items, discounts, adjustments, and so forth.

appymtdetail

Name Required Type Description
RECORDKEY Required integer Bill record number.
ENTRYKEY Optional integer Bill entry record number.
ENTRYCURRENCY Optional string Transaction currency code for the entry.
POSADJKEY Optional integer Credit memo record number.
POSADJENTRYKEY Optional integer Credit memo entry record number.
TRX_PAYMENTAMOUNT Optional currency Amount of the payment. Must be the full amount of the bill (with the discount amount calculated in) in order to apply a discount
INLINEKEY Optional integer Negative bill transaction record number.
INLINEENTRYKEY Optional integer Negative bill transaction entry record number.
TRX_INLINEAMOUNT Optional currency Negative bill transaction amount.
DISCOUNTDATE Optional date Discount date. 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.
ADJUSTMENTKEY Optional integer Adjustment transaction record number.
ADJUSTMENTENTRYKEY Optional integer Adjustment transaction entry record number.
TRX_ADJUSTMENTAMOUNT Optional currency Adjustment transaction amount.
ADVANCEKEY Optional integer Advance record number.
ADVANCEENTRYKEY Optional integer Advance entry record number.
TRX_POSTEDADVANCEAMOUNT Optional currency Posted advance transaction amount

Update AP Payment

You can update a payment to change the header information (financial entity, document number, description, or creation date) or add/delete payment details.

When updating header information, you must include all the original payment details. To add a payment detail, supply all the original payment details along with the new one. To delete a payment detail, supply only the payment details for the ones you want to keep.

update

Update the date for a payment

<update>
    <APPYMT>
        <RECORDNO>103</RECORDNO>
        <WHENCREATED>08/09/2017</WHENCREATED>
        <APPYMTDETAILS>
            <APPYMTDETAIL>
                <RECORDKEY>90</RECORDKEY>
                <ENTRYKEY>375</ENTRYKEY>
                <TRX_PAYMENTAMOUNT>50.00</TRX_PAYMENTAMOUNT>
            </APPYMTDETAIL>
        </APPYMTDETAILS>
    </APPYMT>
</update>

Parameters

Name Required Type Description
RECORDNO Required integer Record number of payment.
FINANCIALENTITY Optional string Financial entity from which the payment will be paid. Can be a checking account ID, a savings account ID, or a charge card ID.
PAYMENTREQUESTMETHOD Optional string Approach for paying the bill. Use vendorpref to apply the preference for the vendor as specified in the Sage Intacct system, vendor to pay all bills from the vendor in one payment, or bill to pay each bill from the vendor as as separate payment (Default: vendorpref).
DOCNUMBER Optional string Document number.
DESCRIPTION Optional string Description of the payment.
WHENCREATED Optional string Payment date.
ACTION Optional string Use Draft to move the payment to the outbox in the Sage Intacct system, or Submit to post the payment (Default: Submit).
APPYMTDETAILS Required array[appymtdetail] Details for the payment, including line items, discounts, adjustments, and so forth.

appymtdetail

Name Required Type Description
RECORDKEY Required integer Bill record number.
ENTRYKEY Optional integer Bill entry record number.
ENTRYCURRENCY Optional string Transaction currency code for the entry.
POSADJKEY Optional integer Credit memo record number.
POSADJENTRYKEY Optional integer Credit memo entry record number.
TRX_PAYMENTAMOUNT Optional currency Amount of the payment. Must be the full amount of the bill (with the discount amount calculated in) in order to apply a discount
INLINEKEY Optional integer Negative bill transaction record number.
INLINEENTRYKEY Optional integer Negative bill transaction entry record number.
TRX_INLINEAMOUNT Optional currency Negative bill transaction amount.
DISCOUNTDATE Optional date Discount date. 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.
ADJUSTMENTKEY Optional integer Debit memo record number.
ADJUSTMENTENTRYKEY Optional integer Debit memo entry record number.
TRX_ADJUSTMENTAMOUNT Optional currency Adjustment transaction amount.
ADVANCEKEY Optional integer Advance record number.
ADVANCEENTRYKEY Optional integer Advance entry record number.
TRX_POSTEDADVANCEAMOUNT Optional currency Posted advance transaction amount.

Delete AP Payment

delete

<delete>
    <object>APPYMT</object>
    <keys>112</keys>
</delete>

Parameters

Name Required Type Description
object Required string Use APPYMT.
keys Required string The payment RECORDNO to delete.

List AP Payment Details

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APPYMTDETAIL
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 Optional 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).

query

Name Required Type Description
STATE Optional string State. Use C for posted, D for Draft, A for Approved, V for voided, or S for Submitted.

Get AP Payment Details

read

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

Parameters

Name Required Type Description
object Required string Use APPYMTDETAIL
keys Required string The payment detail 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.

List AP Payments (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APPAYMENT
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 AP Payment (Legacy)

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 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 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 (Legacy)

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 (Legacy)

readByQuery

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

Parameters

Name Required Type Description
object Required string Use APPAYMENTREQUEST
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 AP Payment Request (Legacy)

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 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 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