Get Invoice

GET /accounting/invoices/{id}

Group: Accounting › Invoices · Operation ID: getInvoice

Returns the invoice with the given identifier. Use the invoice's id, not its invoiceNumber.

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.
id path string yes The unique identifier for the invoice to return.

Response

200 Success

Under data (getInvoiceOutput):

Field Type Required Description
id string yes The unique identifier for the invoice.
invoiceNumber string no The invoice number, for example 'INV-1', unique within the tenant. Absent while none has been assigned.
invoiceDate string (date) yes 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) 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) 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 no The settlement status of the invoice. Possible values: 'unpaid', 'partiallyPaid', 'paidInFull', 'creditedInFull', 'isOverdue', 'disputed'.
approvalStatus string no The finance approval status of the invoice. Possible values: 'draft', 'pendingApproval', 'approved', 'revise', 'rejected'.
deliveryStatus string no How far the invoice has got in being sent to the customer. Possible values: 'created', 'toBeSent', 'delivered', 'read', 'failed'.
disputeStatus string no The dispute status of the invoice, set only when payments against it are under dispute. Possible values: 'disputed', 'chargedBack'.
dataSource string 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 yes 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 no A free-form message printed on the invoice for the customer.
externalInvoiceId string no The invoice's identifier in an external source system, kept for reconciliation. For identifiers owned by your other systems, prefer externalIdentifiers below.
customerId string yes The customer the invoice is issued to. See id on GET accounting/customers/:id.
customerName string no The display name of the customer, as it appears on the document.
customerNumber string no The customer number of the customer, unique within the tenant.
entityId string yes The legal entity issuing the invoice. See id on GET base/entities.
entityName string no The name of the issuing legal entity.
salesOrderId string no The sales order the invoice was billed from. Absent on invoices created directly. See id on GET accounting/sales-orders/:id.
salesOrderNumber string no The number of the source sales order. Present whenever salesOrderId is.
billToAddress object no The bill-to address the invoice is sent to. Absent when the invoice references no bill-to record.
billToAddress.addressId string no The unique identifier for the address record. Absent when none is stored.
billToAddress.line1 string yes The first address line: street number and name, or PO box.
billToAddress.line2 string no The second address line: apartment, suite, unit, building or floor.
billToAddress.city string yes The city or locality.
billToAddress.stateProvince string no The state, province or region.
billToAddress.country string yes The country, as a name or ISO 3166-1 code.
billToAddress.zipCode string yes The postal or ZIP code.
soldToAddress object no The sold-to address the product or service was delivered to, used for tax determination. Absent when the invoice references no sold-to record.
soldToAddress.addressId string no The unique identifier for the address record. Absent when none is stored.
soldToAddress.line1 string yes The first address line: street number and name, or PO box.
soldToAddress.line2 string no The second address line: apartment, suite, unit, building or floor.
soldToAddress.city string yes The city or locality.
soldToAddress.stateProvince string no The state, province or region.
soldToAddress.country string yes The country, as a name or ISO 3166-1 code.
soldToAddress.zipCode string yes The postal or ZIP code.
invoiceEmail string no The email address of the business contact that receives this invoice.
purchaseOrders array of string no The purchase order references the customer supplied, derived from the sales order. These are the customer's own document numbers. An empty array when none were supplied.
purchaseOrderOverride string no A manually entered PO number that overrides the sales-order-derived values in purchaseOrders.
paymentTermDays number 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) no The rate used to convert the invoice's currency to the entity's functional currency. Absent when no conversion applies.
excludeFromTaxEngine boolean no Whether the invoice is left out of the tax engine. Derived from the sales order.
subtotal string (decimal) no The amount before taxes and discounts, in the invoice currency. Absent when no subtotal has been computed.
totalTax string (decimal) no The total tax across all lines, in the invoice currency.
totalDutiesAndCustoms string (decimal) no The total duties and customs across all lines, in the invoice currency.
totalAmount string (decimal) no The total invoiced, including taxes and duties, in the invoice currency.
totalAmountDue string (decimal) no The amount that was due when the invoice was created, in the invoice currency.
totalCredited string (decimal) no The total credited back against this invoice by credit memos, in the invoice currency.
totalLateFeeAmount string (decimal) no The total late fees charged on this invoice, in the invoice currency.
lineDiscounts string (decimal) no The sum of discount amounts across all invoice lines, in the invoice currency.
oneTimeDiscount string (decimal) no The one-time discount applied to the invoice as a whole, in the invoice currency.
paymentsApplied string (decimal) no The amount settled by payments so far, in the invoice currency.
adjustments string (decimal) no The sum of small-balance write-offs and early-payment discounts recorded against this invoice, in the invoice currency.
lastModifiedDate string (date-time) yes The date and time the invoice record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lines array of object no The lines of the invoice, each billing one product or free-text item. An empty array when the invoice has no lines. All line amounts are in the invoice currency.
lines[].id string yes The unique identifier for the invoice line.
lines[].invoiceLineNumber string no The sequential line number within the invoice.
lines[].description string no The line description, as shown to the customer.
lines[].lineType string no The kind of charge the line is. Possible values: 'recurring', 'oneTime', 'oneTimeDiscount', 'usageOverage', 'overage', 'payAsYouGo', 'commit', 'lateFee', 'creditCardProcessingFee', 'billableTime', 'billablePassThrough', 'billableTravelExpense'.
lines[].productId string no The billed product. Set only on lines created from a product reference, absent on free-text lines. See id on GET accounting/products/:id.
lines[].productCode string no The product code as it stood when the line was created. A snapshot, so it does not follow later changes to the product.
lines[].productDescription string no The product description as it stood when the line was created. A snapshot, as with productCode.
lines[].quantity string (decimal) no The quantity billed. A count, not an amount, so it has no currency.
lines[].unitOfMeasure string no The unit the quantity is measured in, for example 'each', 'hour' or 'gigabyte'.
lines[].unitPrice string (decimal) no The price per unit actually charged, in the invoice currency.
lines[].listPrice string (decimal) no The undiscounted list price per unit, in the invoice currency.
lines[].totalPrice string (decimal) no The line total excluding tax and duties, in the invoice currency.
lines[].discountAmount string (decimal) no The discount granted on the line, in the invoice currency.
lines[].discountPercentage string (decimal) no The discount granted on the line as a percentage. A rate, not an amount, so it has no currency.
lines[].taxAmount string (decimal) no The tax on the line, in the invoice currency.
lines[].dutiesAndCustomsAmount string (decimal) no The duties and customs charged on the line, in the invoice currency.
lines[].amount string (decimal) no The total billed for the line, including tax and duties, in the invoice currency.
lines[].totalAmountDue string (decimal) no The amount of the line still due, in the invoice currency.
lines[].taxCode string no The tax code applied to the line.
lines[].taxDate string (date) no The date the line's tax was determined on. Format YYYY-MM-DD.
lines[].serviceStartDate string (date) no The first day of the service period the line covers. Format YYYY-MM-DD.
lines[].serviceEndDate string (date) no The last day of the service period the line covers, inclusive. Format YYYY-MM-DD.
externalIdentifiers array of object no External identifiers owned by your other systems. At most one entry per fieldName. An empty array when the invoice has none.
externalIdentifiers[].fieldName string yes The configured key of the external identifier, a stable camelCase slug such as 'netsuiteInvoiceId', not the human-readable label. It must match an active external-identifier configuration for invoices.
externalIdentifiers[].value string yes The identifier as the source system stores it.
externalIdentifiers[].externalUrl string no An absolute http or https link to the object in the originating system. Absent when none is stored.

Errors

Code Status
NOT_FOUND 400

Statuses