Banyan Technology LIVE Connect™

Get multiple invoices

GET/api/v3/Invoices

Returns a paged list of all invoices that match the provided criteria.

Request

Query Params

ClientReferenceNumber

string

optional

Filter by client reference number

ProNumber

string

optional

Filter by pro number.

BolNumber

string

optional

Filter by bol number.

LoadId

integer

optional

Filter by load id.

CreatedStartDate

string

optional

Filter by created date range start

CreatedEndDate

string

optional

Filter by created date range end

PickupStartDate

string

optional

Filter by pickup date range start

PickupEndDate

string

optional

Filter by pickup date range end

DeliveredStartDate

string

optional

Filter by delivered date range start

DeliveredEndDate

string

optional

Filter by delivered date range end

BillingStartDate

string

optional

Filter by billing date range start

BillingEndDate

string

optional

Filter by billing date range end

InvoiceStatus

string

optional

Filter by invoice status.

ExcludeExported

boolean

optional

True if exported invoices should be excluded, otherwise false.

OrderBy

string

optional

Order by field

PageSize

integer

optional

The number of items to return.

<= 50

Default:

PageNumber

integer

optional

The page number of the results.

Request samples

Responses

Success(200)

Bad Request(400)

Unauthorized(401)

Forbidden(403)

Not Found(404)

Too Many Requests(429)

HTTP Code: 200

Content Type : JSONapplication/json

$ref(#/definitions/3334589)[]

optional

#/definitions/3334589

optional

Not configured

Last modified: 2 months ago