Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Payment Histories

Executes the Post Payment action for the Payment Histories data object.

Post Payment

post/direct/subscribers/{subscriber_code}/vista/ap/2/data/payment_histories/actions/post_payment

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

Cointeger required

Company. Key to ap/pay_batch_entries(Co, Mth, BatchId).

Mthstring date required

Key to ap/pay_batch_entries(Co, Mth, BatchId). Format: YYYY-MM-01.

Vendorinteger required

Key to ap/vendor(VendorGroup, Vendor) where VendorGroup is based on the Co value.

Namestring nullable

Optional. If not provided, defaults to the Vendor Name

AddnlInfostring nullable

Optional. If omitted, defaults from the specified Vendor

Addressstring nullable

Optional. If omitted, defaults from the specified Vendor

Citystring nullable

Optional. If omitted, defaults from the specified Vendor

Statestring nullable

Optional. If omitted, defaults from the specified Vendor

Zipstring nullable

Optional. If omitted, defaults from the specified Vendor

Countrystring nullable

Optional. If omitted, defaults from the specified Vendor

Supplierinteger nullable

If was a two party check, enter the second party here.

Notesstring nullable
__custom_fieldsobject

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

PaidDatestring required
CMCointeger required
CMAcctinteger nullable

Optional. If omitted, will be defaulted based on Vista defaulting behavior.

CMRefstring required
CMRefSeqinteger required

Response

Success

idstring
operationstring
statusstring