Invoices

GET /accounting/invoices

Group: Accounting › Invoices · Operation ID: invoices

Returns a list of invoices. To filter by number, customer, address, email, document number or message, use POST accounting/invoices/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
invoiceDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
dueDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastPaidDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
invoiceStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
approvalStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
deliveryStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
disputeStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
dataSource — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentTermDays — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
exchangeRate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
excludeFromTaxEngine — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
customerId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
entityId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
salesOrderId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
subtotal — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
totalTax — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
totalDutiesAndCustoms — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
totalAmount — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
totalAmountDue — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
totalCredited — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
totalLateFeeAmount — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lineDiscounts — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
oneTimeDiscount — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentsApplied — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
adjustments — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, invoiceDate, dueDate, lastPaidDate, invoiceStatus, approvalStatus, deliveryStatus, disputeStatus, dataSource, currency, customerId, entityId, salesOrderId, paymentTermDays, exchangeRate, excludeFromTaxEngine, subtotal, totalTax, totalDutiesAndCustoms, totalAmount, totalAmountDue, totalCredited, totalLateFeeAmount, lineDiscounts, oneTimeDiscount, paymentsApplied, adjustments, lastModifiedDate
Selectable: id, invoiceNumber, invoiceDate, dueDate, lastPaidDate, invoiceStatus, approvalStatus, deliveryStatus, disputeStatus, dataSource, currency, customerMessage, externalInvoiceId, invoiceEmail, purchaseOrderOverride, paymentTermDays, exchangeRate, excludeFromTaxEngine, customerId, customerName, customerNumber, entityId, entityName, salesOrderId, salesOrderNumber, subtotal, totalTax, totalDutiesAndCustoms, totalAmount, totalAmountDue, totalCredited, totalLateFeeAmount, lineDiscounts, oneTimeDiscount, paymentsApplied, adjustments, lastModifiedDate

Response

200 Success

Under data, an array of invoicesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the invoice.
`invoiceNumber`	string or null	no	The invoice number, for example 'INV-1', unique within the tenant. Absent while none has been assigned.
`invoiceDate`	string (date)	no	The date the invoice was issued. Format YYYY-MM-DD. Payment terms and the general ledger impact are both based on this date.
`dueDate`	string (date) or null	no	The date payment falls due, the invoice date plus the payment term. Format YYYY-MM-DD. Absent when no term has been resolved.
`lastPaidDate`	string (date) or null	no	The date the most recent payment was applied. Format YYYY-MM-DD. Absent on an invoice that has never been paid against.
`invoiceStatus`	string or null	no	The settlement status of the invoice. Possible values: 'unpaid', 'partiallyPaid', 'paidInFull', 'creditedInFull', 'isOverdue', 'disputed'.
`approvalStatus`	string or null	no	The finance approval status of the invoice. Possible values: 'draft', 'pendingApproval', 'approved', 'revise', 'rejected'.
`deliveryStatus`	string or null	no	How far the invoice has got in being sent to the customer. Possible values: 'created', 'toBeSent', 'delivered', 'read', 'failed'.
`disputeStatus`	string or null	no	The dispute status of the invoice, set only when payments against it are under dispute. Possible values: 'disputed', 'chargedBack'.
`dataSource`	string or null	no	The system the invoice record was imported from, for invoices that arrived through an integration or migration rather than being created in Everest. For example 'NetSuite', 'Quickbooks', 'Stripe' or 'MigrationFile'. Absent on invoices created in Everest.
`currency`	string	no	The currency of the invoice. Format ISO 4217, for example 'USD'. It applies to every amount on the record, on the header and on every line.
`customerMessage`	string or null	no	A free-form message printed on the invoice for the customer.
`externalInvoiceId`	string or null	no	The invoice's identifier in an external source system, kept for reconciliation. For identifiers owned by your other systems, prefer externalIdentifiers below.
`invoiceEmail`	string or null	no	The email address of the business contact that receives this invoice.
`purchaseOrderOverride`	string or null	no	A manually entered PO number that overrides the sales-order-derived values in purchaseOrders.
`paymentTermDays`	number or null	no	The number of days after the invoice date that payment falls due, resolved from the invoice's payment term. The term record itself is not published, only its day count.
`exchangeRate`	string (decimal) or null	no	The rate used to convert the invoice's currency to the entity's functional currency. Absent when no conversion applies.
`excludeFromTaxEngine`	boolean or null	no	Whether the invoice is left out of the tax engine. Derived from the sales order.
`customerId`	string or null	no	The customer the invoice is issued to. See id on GET accounting/customers/:id.
`customerName`	string or null	no	The display name of the customer, as it appears on the document.
`customerNumber`	string or null	no	The customer number of the customer, unique within the tenant.
`entityId`	string or null	no	The legal entity issuing the invoice. See id on GET base/entities.
`entityName`	string or null	no	The name of the issuing legal entity.
`salesOrderId`	string or null	no	The sales order the invoice was billed from. Absent on invoices created directly. See id on GET accounting/sales-orders/:id.
`salesOrderNumber`	string or null	no	The number of the source sales order. Present whenever salesOrderId is.
`subtotal`	string (decimal) or null	no	The amount before taxes and discounts, in the invoice currency. Absent when no subtotal has been computed.
`totalTax`	string (decimal) or null	no	The total tax across all lines, in the invoice currency.
`totalDutiesAndCustoms`	string (decimal) or null	no	The total duties and customs across all lines, in the invoice currency.
`totalAmount`	string (decimal) or null	no	The total invoiced, including taxes and duties, in the invoice currency.
`totalAmountDue`	string (decimal) or null	no	The amount that was due when the invoice was created, in the invoice currency.
`totalCredited`	string (decimal) or null	no	The total credited back against this invoice by credit memos, in the invoice currency.
`totalLateFeeAmount`	string (decimal) or null	no	The total late fees charged on this invoice, in the invoice currency.
`lineDiscounts`	string (decimal) or null	no	The sum of discount amounts across all invoice lines, in the invoice currency.
`oneTimeDiscount`	string (decimal) or null	no	The one-time discount applied to the invoice as a whole, in the invoice currency.
`paymentsApplied`	string (decimal) or null	no	The amount settled by payments so far, in the invoice currency.
`adjustments`	string (decimal) or null	no	The sum of small-balance write-offs and early-payment discounts recorded against this invoice, in the invoice currency.
`lastModifiedDate`	string (date-time) or null	no	The date and time the invoice record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error