v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Pay Batch Entries

Gets one Pay Batch Entries object from the cache.

Represents Vista™ batches for "AP Payment Posting" source type batches.

Vista views: APPB and APTB

get/direct/subscribers/{subscriber_code}/vista/ap/2/data/pay_batch_entries/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.

Cointeger required

Mthstring datetime required

Format: YYYY-MM-01.

BatchIdinteger required

BatchSeqinteger

CMCointeger

CMAcctinteger

PayMethodstring

CMRefstring nullable

CMRefSeqinteger nullable

EFTSeqinteger nullable

ChkTypestring nullable

VendorGroupinteger

Vendorinteger

Namestring nullable

Addressstring nullable

Citystring nullable

Statestring nullable

Zipstring nullable

PaidDatestring datetime nullable

Format: YYYY-MM-DD

Amountstring

Supplierinteger nullable

VoidYN'Y' | 'N'

VoidMemostring nullable

ReuseYN'Y' | 'N' | 'null' nullable

Overflow'Y' | 'N'

AddnlInfostring nullable

AddendaTypeIdinteger nullable

TaxFormCodestring nullable

Employeeinteger nullable

SeparatePayYN'Y' | 'N'

SeparatePayMthstring datetime nullable

Format: YYYY-MM-01.

SeparatePayTransinteger nullable

Jobstring nullable

JCCointeger nullable

SLstring nullable

UniqueAttchIDstring nullable

PayOverrideYN'Y' | 'N'

AddressSeqinteger nullable

KeyIDinteger required

Countrystring nullable

Descriptionstring nullable

OldCMAcctinteger nullable

OldPayMethodstring 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"
}