Read an AP adjustment

Returns one adjustment in full: header, every line, the custom attributes of each, and the current status.

Takes either the adjustment id or the externalId supplied when it was created, and at least one is required. When both are sent the lookup filters on both, so a pair naming two different adjustments matches nothing and reports not found rather than quietly preferring one of them - a caller who keys their records on their own reference is told the two disagree instead of being handed the wrong adjustment.

Lookup values come back as their configured meanings rather than the stored codes, so a caller reads back the values they sent. Only adjustments belonging to the caller's own tenant can be read; another tenant's reports as not found rather than being acknowledged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64

RecVue adjustment identifier, as returned by the create call. Supply this or externalId, or both - when both are sent they must name the same adjustment

string

The externalId supplied when the adjustment was created. Supply this or adjustmentId, or both. Matched case-sensitively, being the caller's own opaque string

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json