Gets all Invoices objects from the cache.

get https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/ap/2/data/invoices/cache

Represents processed AP Invoices.

Vista view: APTH, and APTL

Path Params

subscriber_code

string

required

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

Query Params

limit

integer

Limits the number of records returned by the API, up to a maximum of 1,000. The API may return less than the limit even when more records exist. Always examine the 'next' and 'continuationToken' properties to determin if more records are available.

modifiedUTCSince

string

A string specifies a datetime against which to filter the results. When specified the result will be ordered oldest __modifiedUTC to newest. Example 2019-12-11T20:16:58.3419275Z. Optional. If unspecified, all cached objects will be returned.

continuationToken

string

A URL Encoded continuationToken value from a previous GET response. When provided, the next set of results for the original GET will be returned.

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

Response body

object

limit

integer

required

data

array of objects

required

data*

object

__ryvitKeys

array of strings

__ryvitKeys

__modifiedUTC

string

APCo

integer

required

Mth

string

required

APTrans

integer

required

VendorGroup

integer

required

Vendor

integer

required

InvId

string | null

APRef

string | null

Description

string | null

InvDate

string

required

DiscDate

string | null

DueDate

string

required

InvTotal

string

required

HoldCode

string | null

PayControl

string | null

PayMethod

string

required

length ≤ 1

CMCo

integer

required

CMAcct

integer | null

PrePaidYN

string

required

Y N

PrePaidMth

string | null

PrePaidDate

string | null

PrePaidChk

string | null

PrePaidSeq

integer | null

PrePaidProcYN

string

required

Y N

V1099YN

string

required

Y N

V1099Type

string | null

V1099Box

integer | null

PayOverrideYN

string

required

Y N

PayName

string | null

PayAddress

string | null

PayCity

string | null

PayState

string | null

PayZip

string | null

OpenYN

string

required

Y N

InUseMth

string | null

InUseBatchId

integer | null

BatchId

integer

required

Purge

string

required

Y N

InPayControl

string

required

Y N

PayAddInfo

string | null

DocName

string | null

AddendaTypeId

integer | null

PRCo

integer | null

Employee

integer | null

DLcode

integer | null

TaxFormCode

string | null

TaxPeriodEndDate

string | null

AmountType

string | null

Amount

string | null

AmtType2

string | null

Amount2

string | null

AmtType3

string | null

Amount3

string | null

SeparatePayYN

string

required

Y N

ChkRev

string

required

Y N

Notes

string | null

UniqueAttchID

string | null

AddressSeq

integer | null

KeyID

integer

required

PayCountry

string | null

SLKeyID

integer | null

__custom_fields

object

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.

Has additional fields

LineItems

array of objects

LineItems

object

APLine

integer

required

LineType

integer

required

string | null

POItem

integer | null

ItemType

integer | null

string | null

SLItem

integer | null

JCCo

integer | null

Job

string | null

PhaseGroup

integer | null

Phase

string | null

JCCType

integer | null

EMCo

integer | null

string | null

WOItem

integer | null

Equip

string | null

EMGroup

integer | null

CostCode

string | null

EMCType

integer | null

CompType

string | null

Component

string | null

INCo

integer | null

Loc

string | null

MatlGroup

integer | null

Material

string | null

GLCo

integer

required

GLAcct

string

required

length ≤ 20

Description

string | null

Units

string

required

UnitCost

string

required

ECM

string | null

VendorGroup

integer | null

Supplier

integer | null

PayType

integer

required

GrossAmt

string

required

MiscAmt

string

required

MiscYN

string

required

Y N

TaxGroup

integer | null

TaxCode

string | null

TaxType

integer | null

TaxBasis

string

required

TaxAmt

string

required

Retainage

string

required

Discount

string

required

BurUnitCost

string

required

BECM

string | null

Notes

string | null

POPayTypeYN

string

required

Y N

UniqueAttchID

string | null

PayCategory

integer | null

KeyID

integer

required

Receiver#

string | null

SLKeyID

integer | null

SMCo

integer | null

SMWorkOrder

integer | null

Scope

integer | null

SMStandardItem

string | null

POItemLine

integer | null

SMCostType

integer | null

SMJCCostType

integer | null

SMPhaseGroup

integer | null

SubjToOnCostYN

string

required

Y N

OnCostStatus

integer | null

ocApplyMth

string | null

ocApplyTrans

integer | null

ocApplyLine

integer | null

ATOCategory

string | null

ocSchemeID

string | null

ocMembershipNbr

string | null

SMPhase

string | null

SMTaxLiability

string

required

__custom_fields

object

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.

Has additional fields

string

required

continuationToken

string

required

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.xchange.trimble.com/connect/v1/direct/subscribers/subscriber_code/vista/ap/2/data/invoices/cache \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.