Skip to main content

InvoiceCreditHeadroom

How much of a sales invoice has been credited and how much is left to credit.

type InvoiceCreditHeadroom {
  alreadyCredited: Float!
  creditNoteCount: Int!
  currency: String!
  invoiceId: ID!
  invoiceNumber: String!
  invoiceStatus: String!
  invoiceTotal: Float!
  remaining: Float!
}

Fields​

InvoiceCreditHeadroom.alreadyCredited ● Float! non-null scalar​

How much of the invoice has already been credited.

InvoiceCreditHeadroom.creditNoteCount ● Int! non-null scalar​

How many credit notes count against the invoice.

InvoiceCreditHeadroom.currency ● String! non-null scalar​

ISO 4217 currency code.

InvoiceCreditHeadroom.invoiceId ● ID! non-null scalar​

The ID of the invoice.

InvoiceCreditHeadroom.invoiceNumber ● String! non-null scalar​

The number of the invoice.

InvoiceCreditHeadroom.invoiceStatus ● String! non-null scalar​

The status of the invoice.

InvoiceCreditHeadroom.invoiceTotal ● Float! non-null scalar​

The invoice total, in the invoice currency.

InvoiceCreditHeadroom.remaining ● Float! non-null scalar​

How much of the invoice can still be credited.

Returned By​

invoiceCreditHeadroom query