v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Invoice Batch Entries

Gets one Invoice Batch Entries object from the cache.

Represents data found in Vista™ AP Transaction Entry program.

Vista views: APHB, and APLB

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

BatchIdinteger required

BatchSeqinteger required

BatchTransTypestring required

APTransinteger nullable

VendorGroupinteger required

Vendorinteger required

APRefstring nullable

Descriptionstring nullable

InvDatestring required

DiscDatestring nullable

DueDatestring required

InvTotalstring required

HoldCodestring nullable

PayControlstring nullable

PayMethodstring required

CMCointeger required

CMAcctinteger nullable

PrePaidYN'Y' | 'N' required

PrePaidMthstring nullable

PrePaidDatestring nullable

PrePaidChkstring nullable

PrePaidSeqinteger nullable

PrePaidProcYN'Y' | 'N' required

V1099YN'Y' | 'N' required

V1099Typestring nullable

V1099Boxinteger nullable

PayOverrideYN'Y' | 'N' required

PayNamestring nullable

PayAddressstring nullable

PayCitystring nullable

PayStatestring nullable

PayZipstring nullable

InvIdstring nullable

UIMthstring nullable

UISeqinteger nullable

OldVendorGroupinteger nullable

OldVendorinteger nullable

OldAPRefstring nullable

OldDescstring nullable

OldInvDatestring nullable

OldDiscDatestring nullable

OldDueDatestring nullable

OldInvTotalstring nullable

OldHoldCodestring nullable

OldPayControlstring nullable

OldPayMethodstring nullable

OldCMCointeger nullable

OldCMAcctinteger nullable

OldPrePaidYN'Y' | 'N' | 'null' nullable

OldPrePaidMthstring nullable

OldPrePaidDatestring nullable

OldPrePaidChkstring nullable

OldPrePaidSeqinteger nullable

OldPrePaidProcYN'Y' | 'N' | 'null' nullable

Old1099YN'Y' | 'N' | 'null' nullable

Old1099Typestring nullable

Old1099Boxinteger nullable

OldPayOverrideYN'Y' | 'N' | 'null' nullable

OldPayNamestring nullable

OldPayAddressstring nullable

OldPayCitystring nullable

OldPayStatestring nullable

OldPayZipstring nullable

PayAddInfostring nullable

OldPayAddInfostring nullable

DocNamestring nullable

OldDocNamestring nullable

MSCointeger nullable

MSInvstring nullable

AddendaTypeIdinteger nullable

PRCointeger nullable

Employeeinteger nullable

DLcodeinteger nullable

TaxFormCodestring nullable

TaxPeriodEndDatestring nullable

AmountTypestring nullable

Amountstring nullable

AmtType2string nullable

Amount2string nullable

AmtType3string nullable

Amount3string nullable

OldAddendaTypeIdinteger nullable

OldPRCointeger nullable

OldEmployeeinteger nullable

OldDLcodeinteger nullable

OldTaxFormCodestring nullable

OldTaxPeriodEndDatestring nullable

OldAmountTypestring nullable

OldAmountstring nullable

OldAmtType2string nullable

OldAmount2string nullable

OldAmtType3string nullable

OldAmount3string nullable

SeparatePayYN'Y' | 'N' required

OldSeparatePayYN'Y' | 'N' | 'null' nullable

ChkRev'Y' | 'N' required

PaidYN'Y' | 'N' required

Notesstring nullable

UniqueAttchIDstring nullable

AddressSeqinteger nullable

OldAddressSeqinteger nullable

KeyIDinteger required

SLKeyIDinteger nullable

PayCountrystring nullable

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