v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Payment Histories

Gets one Payment Histories object from the cache.

Represents data found in Vista™ AP Payment History program.

Vista views: APPH, and APPD

get/direct/subscribers/{subscriber_code}/vista/ap/2/data/payment_histories/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

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

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

APCointeger required

CMCointeger required

CMAcctinteger required

PayMethodstring required

CMRefstring required

CMRefSeqinteger required

EFTSeqinteger required

VendorGroupinteger required

Vendorinteger required

Namestring nullable

Addressstring nullable

Citystring nullable

Statestring nullable

Zipstring nullable

ChkTypestring nullable

PaidMthstring required

PaidDatestring required

Amountstring required

Supplierinteger nullable

VoidYN'Y' | 'N' required

VoidMemostring nullable

InUseMthstring nullable

InUseBatchIdinteger nullable

PurgeYN'Y' | 'N' required

BatchIdinteger nullable

AddnlInfostring nullable

UniqueAttchIDstring nullable

KeyIDinteger required

Notesstring nullable

Countrystring nullable

CreditCardNumstring nullable

ExpireDatestring nullable

CVCstring nullable

ErrorCodeinteger nullable

ErrorCodeDescstring nullable

NPPayDatestring nullable

NPReferenceNumstring nullable

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

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}