Skip to main content

Invoice

A sales invoice issued to a customer or a purchase invoice received from a supplier, with its lines, totals, status and settlement.

type Invoice {
  allocations: [PaymentAllocation!]!
  baseOutstandingAmount: Float
  baseTotalAmount: Float
  billingAddress: JSON
  createdAt: DateTime!
  currency: String
  deletedAt: DateTime
  discountAmount: Float!
  displayStatus: String!
  dueDate: DateTime!
  enteredBy: String!
  exchangeRate: Float
  id: ID!
  internalNotes: String
  invoiceDate: DateTime!
  invoiceNumber: String!
  isOverdue: Boolean!
  items: [InvoiceItem!]
  notes: String
  order: SalesOrder
  orderAdvance: InvoiceOrderAdvance
  orderId: ID
  organizationId: String!
  outstandingAmount: Float!
  paidAmount: Float!
  partner: Partner
  partnerId: String!
  paymentStatus: String!
  paymentTerms: String
  purchaseOrderId: String
  salesOrder: SalesOrder
  salesOrderId: String
  shippingAddress: JSON
  shippingAmount: Float!
  status: InvoiceStatus!
  subtotal: Float!
  supplierCode: String
  supplierDisplayName: String
  supplierEmail: String
  supplierName: String
  supplierPhone: String
  surchargeAmount: Float!
  taxAmount: Float!
  taxCalculationMethod: String
  terms: String
  totalAmount: Float!
  type: InvoiceType!
  updatedAt: DateTime!
  updatedBy: String!
  version: Int!
}

Fields​

Invoice.allocations ● [PaymentAllocation!]! non-null object​

The payment allocations applied to this invoice, including reversals.

Invoice.baseOutstandingAmount ● Float scalar​

The outstanding amount in the organization's base currency. Null on older invoices.

Invoice.baseTotalAmount ● Float scalar​

The invoice total in the organization's base currency, frozen when the invoice was written. Null on older invoices.

Invoice.billingAddress ● JSON scalar​

The billing address on the invoice.

Invoice.createdAt ● DateTime! non-null scalar​

When the record was created.

Invoice.currency ● String scalar​

Currency code of the document's amounts.

Invoice.deletedAt ● DateTime scalar​

When the record was deleted. Null while it is active.

Invoice.discountAmount ● Float! non-null scalar​

Total discount amount on the invoice.

Invoice.displayStatus ● String! non-null scalar​

One label for display: CANCELLED, VOIDED, PAID, OVERDUE, PARTIALLY_PAID, DRAFT, SENT or AWAITING_PAYMENT.

Invoice.dueDate ● DateTime! non-null scalar​

The date payment is due.

Invoice.enteredBy ● String! non-null scalar​

The ID of the user who created the record.

Invoice.exchangeRate ● Float scalar​

Exchange rate between the document currency and the organization's base currency, when they differ.

Invoice.id ● ID! non-null scalar​

Unique identifier of the record.

Invoice.internalNotes ● String scalar​

Notes for your team only; never shown to the customer.

Invoice.invoiceDate ● DateTime! non-null scalar​

The date the invoice was issued.

Invoice.invoiceNumber ● String! non-null scalar​

The human-readable invoice number, unique within the organization.

Invoice.isOverdue ● Boolean! non-null scalar​

True when the invoice has been issued (not a draft, cancelled or voided), still has an amount outstanding and is past its due date.

Invoice.items ● [InvoiceItem!] list object​

The line items on the invoice.

Invoice.notes ● String scalar​

Notes on the document, visible to the customer.

Invoice.order ● SalesOrder object​

The sales order this invoice bills, if any.

Invoice.orderAdvance ● InvoiceOrderAdvance object​

Money already received or claimed for the order this invoice came from that no invoice has absorbed yet. While it is above zero the invoice shows the full amount unpaid and a new payment would pay the order twice. Null when there is none.

Invoice.orderId ● ID scalar​

The ID of the sales order (sales invoice) or purchase order (purchase invoice) this invoice bills.

Invoice.organizationId ● String! non-null scalar​

The ID of the organization (tenant) that owns the record.

Invoice.outstandingAmount ● Float! non-null scalar​

The amount still unpaid, in the invoice currency.

The amount paid so far, in the invoice currency.

Invoice.partner ● Partner object​

The customer or supplier on the invoice.

Invoice.partnerId ● String! non-null scalar​

The ID of the customer (sales invoice) or supplier (purchase invoice).

Invoice.paymentStatus ● String! non-null scalar​

How much of the invoice has been paid: UNPAID, PARTIALLY_PAID or PAID, derived from paidAmount and totalAmount.

Invoice.paymentTerms ● String scalar​

The payment terms agreed for the invoice.

Invoice.purchaseOrderId ● String scalar​

The ID of the purchase order this invoice bills, if any.

Invoice.salesOrder ● SalesOrder object​

The sales order this invoice bills, if any.

Invoice.salesOrderId ● String scalar​

The ID of the sales order this invoice bills, if any.

Invoice.shippingAddress ● JSON scalar​

The shipping address on the invoice.

Invoice.shippingAmount ● Float! non-null scalar​

Shipping charge on the invoice.

Invoice.status ● InvoiceStatus! non-null enum​

Where the invoice is in its lifecycle: DRAFT, APPROVED, PENDING, SENT, CANCELLED or VOIDED.

Invoice.subtotal ● Float! non-null scalar​

Subtotal of the invoice lines, as calculated by the server.

Invoice.supplierCode ● String scalar​

The supplier's code, on a purchase invoice.

Invoice.supplierDisplayName ● String scalar​

The supplier's display name, on a purchase invoice.

Invoice.supplierEmail ● String scalar​

The supplier's email address, on a purchase invoice.

Invoice.supplierName ● String scalar​

The supplier's name, on a purchase invoice.

Invoice.supplierPhone ● String scalar​

The supplier's phone number, on a purchase invoice.

Invoice.surchargeAmount ● Float! non-null scalar​

Surcharge added to the invoice.

Invoice.taxAmount ● Float! non-null scalar​

Total tax on the invoice.

Invoice.taxCalculationMethod ● String scalar​

Whether line prices include tax (INCLUSIVE) or tax is added on top (EXCLUSIVE).

Invoice.terms ● String scalar​

Terms and conditions printed on the invoice.

Invoice.totalAmount ● Float! non-null scalar​

The invoice total in the invoice currency, as calculated and stored by the server.

Invoice.type ● InvoiceType! non-null enum​

SALES_INVOICE for an invoice you issue to a customer, PURCHASE_INVOICE for a bill you receive from a supplier.

Invoice.updatedAt ● DateTime! non-null scalar​

When the record was last changed.

Invoice.updatedBy ● String! non-null scalar​

The ID of the user who last changed the record.

Invoice.version ● Int! non-null scalar​

Optimistic-concurrency counter — pass back as expectedVersion on the next mutation.

Returned By​

cancelInvoice mutation ● convertQuoteToInvoice mutation ● createInvoice mutation ● deleteInvoice mutation ● duplicateInvoice mutation ● invoice query ● outstandingSalesInvoices query ● outstandingSupplierInvoices query ● updateInvoice mutation

Member Of​

InvoiceConnection object ● Quote object