Hivebuy External API (v2)

Sections

Theme switcher

List invoices

Header Parameters

Authorizationstring

Query Parameters

pageinteger

Page number, starting at 1.

Minimum
1
Default value
1
pageSizeinteger

Results per page. Default 25, maximum 100.

Minimum
1
Maximum
100
Default value
25
statusstring

One or more status codes, comma-separated (?status=A,P) or repeated (?status=A&status=P). An invalid code returns 400 listing the valid values. Codes: N new, O open, A approved, R rejected, RV revision, P pending, NI not an invoice, W wrong, 3WM three-way matched.

Explode
Enum values:
NOARRVPNIW3WM
searchstring

Case-insensitive substring match on title and invoice number only.

invoiceNumberstring

Exact invoice number.

supplierNumberstring

Exact supplier number of the linked supplier.

invoiceDateFromstring

Invoice date on or after this date (YYYY-MM-DD).

invoiceDateTostring

Invoice date on or before this date (YYYY-MM-DD).

dueDateFromstring

Due date on or after this date (YYYY-MM-DD).

dueDateTostring

Due date on or before this date (YYYY-MM-DD).

updatedAtFromstring

Invoice updated at or after this ISO 8601 datetime. Send a UTC offset (2026-07-01T00:00:00Z); values without an offset are interpreted as server time. Not a complete change feed: changes to nested data do not bump updatedAt.

updatedAtTostring

Invoice updated at or before this ISO 8601 datetime.

invoicePaidboolean

Filter by payment state: true or false.

orderingstring

Sort field, prefix with - for descending. One of createdAt, invoiceDate, dueDate, updatedAt, totalAmount. Default -createdAt. Ties are broken deterministically, so paging never skips or repeats invoices.

Enum values:
createdAt-createdAtinvoiceDate-invoiceDatedueDate-dueDateupdatedAt-updatedAttotalAmount-totalAmount

Path Parameters

companyIdstring Required

Company ID. Must be one of the IDs returned by GET /api/v2/companies/.

Response

200
Object

Paginated list of invoices.

Response Attributes

totalRecordsinteger

Total matching records across all pages.

totalPagesinteger

Total pages. 0 when there are no results.

currentPageinteger

The page this response contains.

resultsarray

Show child attributes

400
Object

Invalid filter value. The body names the parameter and the accepted values.

Response Attributes

statusstring
401
Object

Missing, invalid, or expired API key, or a session credential was used instead of an API key.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

403
Object

Authenticated but not entitled: the key's user is not an active member of this company, the External API feature (or the resource's own feature) is not enabled for it, the key lacks the scope this verb needs, or a browser session was used.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

429
Object

Rate limit exceeded (60 requests per minute per API key). Retry after the number of seconds given in the message.

Response Attributes

typestring
Enum values:
validationErrorclientErrorserverError
errorsarray

Show child attributes

GET

/

Select
1

Response