Vendor Payment
A vendor payment transaction posts to the general ledger as an expense and the amount of the payment is deducted from your accounts payable total. A vendor payment can be applied to one or more vendor bills. Vendor payments can help to track expenditures and total payables due.
For help working with this record in the UI, see Vendor Payments Overview.
The vendor payment record type includes the following actions from the Actions Framework:
-
New
-
Fax
-
Show activity
-
Go to register
-
GL Impact
The REST API Browser includes information about the field names and field types of the vendor payment record and about the HTTP methods, request parameters, and operations available to this record. For details, see the REST API Browser’s vendorPayment reference page.
For information about using the REST API Browser, see The REST API Browser.
Record IDs
The record ID for a vendor payment REST record is vendorPayment. Vendor payment has one subrecord, with the record ID payeeAddress.
Prerequisites
There are no prerequisites to using this record through REST web services.
Code Samples
The following examples show how to read, create, update, or delete a vendor payment:
Read:
GET {{REST_SERVICES}}/record/v1/vendorPayment/${transaction-id}
Create:
POST {{REST_SERVICES}}/record/v1/vendorPayment { "entity": { "id": "${entity-id}" }, "apply": { "items": [ { "doc": { "id": "${bill-id}" }, "apply": true, "amount": ${amount} } ] }
}
Update:
PATCH {{REST_SERVICES}}/record/v1/vendorPayment/${transaction-id}
{
"externalId" : "AAA"
}
Delete:
DELETE {{REST_SERVICES}}/record/v1/vendorPayment/${transaction-id}