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 details about this type of transaction, see Vendor Payments.
The vendor payment record is defined in the tranPurch (purchases) XSD.
Supported Operations
The following operations can be used with vendor payment records:
add | addList | delete | deleteList | get | getDeleted | getList | getSavedSearch | getSelectValue | initialize / initializeList | search | update | updateList | upsert | upsertList
You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.
Field Definitions
The SOAP Schema Browser includes definitions for all body fields, sublist fields, search filters, and search joins available to this record. For details, see the SOAP Schema Browser’s vendor payment reference page.
For information on using the SOAP Schema Browser, see SOAP Schema Browser.
The balance field is only returned when using advanced search. It is not returned when using the <Record>SearchBasic search object. In advanced search, you must set the bodyFieldsOnly preference to false. The balance field is not returned if the bodyFieldsOnly preference is set to true. For more information, see bodyFieldsOnly.
Usage Notes
Initializing Vendor Payments
You can initialize a vendor payment from an Employee, a Vendor, or a Vendor Bill.
The SOAP web services initialize operation emulates the UI workflow by prepopulating fields on transaction line items with values from a related record. For more information about this operation, see initialize / initializeList.
Applying Vendor Payments to Bills
As of the 2011.1 endpoint and later, you can use {doc, line} on the VendorPaymentApply sublist to identify the vendor bill line to which a payment should be applied. You can use the line element to uniquely identify a sublist entry when the doc element is not sufficient. The line element prevents problems with record creation due to duplicate keys.
Use the initialize operation to obtain the doc and line values from the vendor bill.
As of the 2011.1 endpoint and later, if you do not provide a value for the line element for an entry to VendorPaymentApply, you may receive the error: “Ambiguous sublist reference; multiple matches exist for key value <doc>”. Earlier endpoints do not return this error.