Saltar al contenido principal
GET
List invoices

Autorizaciones

X-API-KEY
string
header
requerido
OW-KEY
string
header
requerido

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Parámetros de consulta

offset
integer

Number of records to skip.

Rango requerido: x >= 0
limit
integer

Page size. Default 10, maximum 25.

sort_by
string

Field to sort by: createdAt, invoiceTotalAfterTax, id, workOrderId, locationId, supplierFacilityId, or buyerFacilityId. Omit for newest first.

order
enum<string>

Sort direction.

Opciones disponibles:
asc,
desc

Free-text lookup. Matches part of the work order title, or exactly one of: work order id, external work order id, invoice number, invoice id, PO number, GL code.

status
string

One invoice status, lowercase: draft, pending, approved, processing, paid, disputed, pastdue, transferred, void.

statuses
string

Several invoice statuses, lowercase (draft, pending, approved, processing, paid, disputed, pastdue, transferred, void). Comma-separated list with no spaces; matches any value listed.

workOrderDisplayStatus
enum<string>

Invoices whose work order is in this display status: Pending, Deferred, Open, InProgress, OnHold, Completed, or Cancelled.

Opciones disponibles:
Pending,
Deferred,
Open,
InProgress,
OnHold,
Completed,
Cancelled
workOrderId
integer

Invoices for one work order.

externalWorkOrderId
string

Invoices for one work order, by the external reference your system stores on it. Exact match.

invoiceNumber
string

Invoices with this supplier invoice number.

locationId
integer

Invoices for one location.

locationIds
string

Invoices for these locations. Comma-separated list with no spaces; matches any value listed.

regionIds
string

Invoices for locations in these regions. Comma-separated list with no spaces; matches any value listed.

assetId
integer

Invoices whose work order is on this asset.

assetIds
string

Invoices whose work order is on one of these assets. Comma-separated list with no spaces; matches any value listed.

problemTypeId
integer

Invoices whose work order has this problem type.

problemTypeIds
string

Invoices whose work order has one of these problem types. Comma-separated list with no spaces; matches any value listed.

woPriorityIds
string

Invoices whose work order has one of these priorities. Comma-separated list with no spaces; matches any value listed.

isPM
enum<string>

true returns only invoices for preventive maintenance work orders; false leaves them out.

Opciones disponibles:
true,
false
isCapex
enum<string>

true returns only invoices for work orders flagged as capital expenditure; false leaves them out.

Opciones disponibles:
true,
false
buyerCompanyId
integer

Invoices for one of your buyer customers. Narrows your results; it cannot widen them.

createdAtStartDate
string

Earliest creation time to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

createdAtEndDate
string

Latest creation time to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

publishedAtStartDate
string

Earliest time the invoice was published to the buyer to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

publishedAtEndDate
string

Latest time the invoice was published to the buyer to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

approvedAtStartDate
string

Earliest approval time to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

approvedAtEndDate
string

Latest approval time to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

processedAtStartDate
string

Earliest time the invoice moved to processing to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

processedAtEndDate
string

Latest time the invoice moved to processing to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

markedPaidAtStartDate
string

Earliest time the invoice was marked paid to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

markedPaidAtEndDate
string

Latest time the invoice was marked paid to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

dueAtStartDate
string

Earliest due date to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

dueAtEndDate
string

Latest due date to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

workCompletedAtStartDate
string

Earliest completion time of the invoice's work order to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

workCompletedAtEndDate
string

Latest completion time of the invoice's work order to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

timezone
string

Optional IANA time zone name, such as America/Chicago or UTC, that this route's date filters are read in. Each date filter value is a local wall-clock time in this zone. When omitted, date filters are read in UTC. Names are case-sensitive. Fixed offsets (-05:00, GMT-5, Z, Etc/GMT+5), abbreviations (CST), and unknown names are rejected with 400. On a daylight saving change day, a time in the skipped hour moves forward by the length of the gap, and a time in the repeated hour means the standard-time (second) occurrence.

Ejemplo:

"America/Chicago"

Respuesta

Successful response

type
string
requerido

Entity type label, e.g. "Invoices". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.

data
object[]
requerido
count
integer<int64>
requerido

Total number of matching records (across all pages)

status
enum<string>
requerido

"ok" on success

Opciones disponibles:
ok