Hivebuy External API (v2)

Sections

Theme switcher

Get invoice

Header Parameters

Authorizationstring

Path Parameters

companyIdstring Required

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

idstring Required

Invoice ID.

Response

200
Object

The invoice.

Response Attributes

idstring
invoiceNumberstring | null
titlestring | null
statusstring

N new, O open, A approved, R rejected, RV revision, P pending, NI not an invoice, W wrong, 3WM three-way matched.

Enum values:
NOARRVPNIW3WM
currencystring | null

ISO 4217 code.

invoiceDatestring | null
dueDatestring | null
serviceDatestring | null
servicePeriodStartstring | null
servicePeriodEndstring | null
totalNetAmountstring | null

All amounts are decimal strings, e.g. "119.00".

totalNetAmountCurrencystring | null
totalGrossAmountstring | null
totalGrossAmountCurrencystring | null
totalAmountstring | null
totalAmountCurrencystring | null
taxstring | null
taxCurrencystring | null
shippingstring | null
shippingCurrencystring | null
discountstring | null
discountCurrencystring | null
vatstring | null

VAT percentage as decimal string.

vendorNamestring | null

Vendor name as read from the invoice document.

vendorVatIdstring | null
orderNumberstring | null
costCenterstring | null
invoicePaidboolean
invoicePaidAtstring | null
completeboolean
collectiveboolean

Whether this is a collective invoice covering several orders.

creditNotesboolean

Whether this document is a credit note.

excessiveLineItemsboolean

True when the document had more line items than are extracted automatically.

createdAtstring
updatedAtstring

Changes to nested data (line items, taxes, purchase order links) do not update this field.

taxesarray

Show child attributes

lineItemsarray

Show child attributes

invoicePurchaseOrdersarray

Show child attributes

filesarray

Show child attributes

companyobject | null

Show child attributes

supplierobject | null

Show child attributes

departmentobject | null

Show child attributes

legalEntityobject | null

Show child attributes

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

404
Object

No invoice with this ID in this company.

Response Attributes

detailstring
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