Invoice

Represents information about an invoice.

type Invoice {
  id: ID!
  number: String
  status: InvoiceStatus
  effectiveAt: Date
  dueAt: Date
  currency: CurrencyCode
  exchangeRate: Decimal
  discount: Decimal
  subtotal: Decimal
  subtotalExcludingTax: Decimal
  tax: Decimal
  total: Decimal
  notes: String
  eInvoiceStatus: EInvoiceStatus
  eInvoiceMetadata: JSON
  isIssuer: Boolean
  client: Contact
  person: Contact
  issuer: User
  lines: [InvoiceLine]
  priceList: PriceList
  quote: Quote
  comments: [Comment!]!
  followers: [User!]
  creator: User
  createdAt: DateTimeTz!
  updatedAt: DateTimeTz!
  deletedAt: DateTimeTz
  properties(
    where: InvoicePropertiesWhereWhereConditions
    orderBy: [InvoicePropertiesOrderByOrderByClause!]
    first: Int! = 10
    after: String
  ): PropertyConnection!
  projects(
    where: InvoiceProjectsWhereWhereConditions
    orderBy: [InvoiceProjectsOrderByOrderByClause!]
    first: Int! = 10
    after: String
  ): ProjectConnection!
  tasks(
    where: InvoiceTasksWhereWhereConditions
    orderBy: [InvoiceTasksOrderByOrderByClause!]
    first: Int! = 10
    after: String
  ): TaskConnection!
  letters(
    where: InvoiceLettersWhereWhereConditions
    orderBy: [InvoiceLettersOrderByOrderByClause!]
    first: Int! = 10
    after: String
  ): LetterConnection!
  contracts(
    where: InvoiceContractsWhereWhereConditions
    orderBy: [InvoiceContractsOrderByOrderByClause!]
    first: Int! = 10
    after: String
  ): ContractConnection!
  files(
    where: InvoiceFilesWhereWhereConditions
    orderBy: [InvoiceFilesOrderByOrderByClause!]
    first: Int! = 10
    after: String
  ): FileConnection!
}

Fields​

Invoice.id ● ID! non-null scalar​

Invoice's unique identifier.

Invoice.number ● String scalar​

The invoice's number.

Invoice.status ● InvoiceStatus enum​

The invoice's status.

Invoice.effectiveAt ● Date scalar​

Starting date of the invoice.

Invoice.dueAt ● Date scalar​

Due date of the invoice.

Invoice.currency ● CurrencyCode enum​

The invoice's currency.

Invoice.exchangeRate ● Decimal scalar​

The invoice's currency exchange rate.

Invoice.discount ● Decimal scalar​

The invoice's discount percentage.

Invoice.subtotal ● Decimal scalar​

Total of all items on the invoice before any invoice level discount or exclusive tax is applied.

Invoice.subtotalExcludingTax ● Decimal scalar​

The subtotal of the invoice before any invoice level discount or tax.

Invoice.tax ● Decimal scalar​

The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.

Invoice.total ● Decimal scalar​

Total after discounts and taxes.

Invoice.notes ● String scalar​

The invoice's notes.

Invoice.eInvoiceStatus ● EInvoiceStatus enum​

The invoice's e-invoice status.

Invoice.eInvoiceMetadata ● JSON scalar​

The invoice's e-invoice metadata.

Invoice.isIssuer ● Boolean scalar​

Determine whether the current user is this invoice's issuer.

Invoice.client ● Contact object​

The invoice's client.

Invoice.person ● Contact object​

The invoice's client related person.

Invoice.issuer ● User object​

The invoice's issuer.

Invoice.lines ● [InvoiceLine] list object​

The individual line items that make up the invoice.

Invoice.priceList ● PriceList object​

The invoice's price list.

Invoice.quote ● Quote object​

The invoice's quote.

Invoice.comments ● [Comment!]! non-null object​

The invoice's comments.

Invoice.followers ● [User!] list object​

The invoice's followers.

Invoice.creator ● User object​

The user who created this invoice.

Invoice.createdAt ● DateTimeTz! non-null scalar​

The date and time when the invoice was created.

Invoice.updatedAt ● DateTimeTz! non-null scalar​

The date and time when the invoice was last updated.

Invoice.deletedAt ● DateTimeTz scalar​

The date and time when the invoice was deleted.

Invoice.properties ● PropertyConnection! non-null object​

A list of properties associated with the invoice.

Invoice.properties.where ● InvoicePropertiesWhereWhereConditions input​

Invoice.properties.orderBy ● [InvoicePropertiesOrderByOrderByClause!] list input​

Invoice.properties.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Invoice.properties.after ● String scalar​

A cursor after which elements are returned.

Invoice.projects ● ProjectConnection! non-null object​

A list of projects associated with the invoice.

Invoice.projects.where ● InvoiceProjectsWhereWhereConditions input​

Invoice.projects.orderBy ● [InvoiceProjectsOrderByOrderByClause!] list input​

Invoice.projects.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Invoice.projects.after ● String scalar​

A cursor after which elements are returned.

Invoice.tasks ● TaskConnection! non-null object​

The invoice's tasks.

Invoice.tasks.where ● InvoiceTasksWhereWhereConditions input​

Invoice.tasks.orderBy ● [InvoiceTasksOrderByOrderByClause!] list input​

Invoice.tasks.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Invoice.tasks.after ● String scalar​

A cursor after which elements are returned.

Invoice.letters ● LetterConnection! non-null object​

A list of letters associated with the invoice.

Invoice.letters.where ● InvoiceLettersWhereWhereConditions input​

Invoice.letters.orderBy ● [InvoiceLettersOrderByOrderByClause!] list input​

Invoice.letters.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Invoice.letters.after ● String scalar​

A cursor after which elements are returned.

Invoice.contracts ● ContractConnection! non-null object​

A list of contracts associated with the invoice.

Invoice.contracts.where ● InvoiceContractsWhereWhereConditions input​

Invoice.contracts.orderBy ● [InvoiceContractsOrderByOrderByClause!] list input​

Invoice.contracts.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Invoice.contracts.after ● String scalar​

A cursor after which elements are returned.

Invoice.files ● FileConnection! non-null object​

The invoice's files.

Invoice.files.where ● InvoiceFilesWhereWhereConditions input​

Invoice.files.orderBy ● [InvoiceFilesOrderByOrderByClause!] list input​

Invoice.files.first ● Int! non-null scalar​

Limits number of fetched items. Maximum allowed value: 50.

Invoice.files.after ● String scalar​

A cursor after which elements are returned.

Returned By​

createInvoice mutation ● createInvoiceFromQuote mutation ● deleteInvoice mutation ● duplicateInvoice mutation ● finalizeInvoice mutation ● invoice query ● markInvoiceAsPaid mutation ● markInvoiceAsPartiallyPaid mutation ● markInvoiceAsUncollectible mutation ● restoreInvoice mutation ● updateInvoice mutation ● voidInvoice mutation

Member Of​

InvoiceEdge object ● Reading object