Sign in

v1

latestOpenAPI 3.0.12026-07-267912192.3 MB
Invoices

Gets one Invoices object from the cache.

Represents processed AP Invoices.

Vista view: APTH, and APTL

get/direct/subscribers/{subscriber_code}/vista/ap/2/data/invoices/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
Mthstring required
APTransinteger required
VendorGroupinteger required
Vendorinteger required
InvIdstring nullable
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
OpenYN'Y' | 'N' required
InUseMthstring nullable
InUseBatchIdinteger nullable
BatchIdinteger required
Purge'Y' | 'N' required
InPayControl'Y' | 'N' required
PayAddInfostring nullable
DocNamestring 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
SeparatePayYN'Y' | 'N' required
ChkRev'Y' | 'N' required
Notesstring nullable
UniqueAttchIDstring nullable
AddressSeqinteger nullable
KeyIDinteger required
PayCountrystring nullable
SLKeyIDinteger 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"
}