DebitNote

A debit note: money a vendor owes back, for example from a purchase return.

type DebitNote {
  adjustments: Float
  amount: Float!
  appliedAmount: Float
  appliedDate: DateTime
  baseTotalAmount: Float
  createdAt: DateTime!
  currency: String
  debitNoteNumber: String!
  deletedAt: DateTime
  deletedBy: String
  dueDate: DateTime
  enteredBy: String!
  exchangeRate: Float
  id: ID!
  internalNotes: String
  issueDate: DateTime!
  notes: String
  organizationId: String!
  originalInvoiceId: String
  partnerId: String!
  partnerName: String
  remainingAmount: Float
  returnId: String
  status: String!
  taxAmount: Float!
  totalAmount: Float!
  type: String!
  updatedAt: DateTime!
  updatedBy: String!
}

Fields

DebitNote.adjustments ● Float scalar

A signed adjustment to the total, such as rounding.

DebitNote.amount ● Float! non-null scalar

The note amount before tax.

DebitNote.appliedAmount ● Float scalar

The total applied to invoices so far.

DebitNote.appliedDate ● DateTime scalar

The date the note was applied.

DebitNote.baseTotalAmount ● Float scalar

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

DebitNote.createdAt ● DateTime! non-null scalar

When the record was created.

DebitNote.currency ● String scalar

ISO 4217 currency code.

DebitNote.debitNoteNumber ● String! non-null scalar

The debit note number, unique within the organization.

DebitNote.deletedAt ● DateTime scalar

When the record was deleted. Empty while the record is live.

DebitNote.deletedBy ● String scalar

The ID of the user who deleted the record.

DebitNote.dueDate ● DateTime scalar

The date the note is due.

DebitNote.enteredBy ● String! non-null scalar

The ID of the user who created the record.

DebitNote.exchangeRate ● Float scalar

The rate frozen when the note was written: 1 unit of the note's currency in the organization's base currency.

DebitNote.id ● ID! non-null scalar

The unique ID of this record.

DebitNote.internalNotes ● String scalar

Notes for staff only.

DebitNote.issueDate ● DateTime! non-null scalar

The date the note was issued.

DebitNote.notes ● String scalar

Notes shown on the note.

DebitNote.organizationId ● String! non-null scalar

The ID of the organization the record belongs to.

DebitNote.originalInvoiceId ● String scalar

The ID of the purchase invoice the note is raised against.

DebitNote.partnerId ● String! non-null scalar

The ID of the partner.

DebitNote.partnerName ● String scalar

The name of the vendor.

DebitNote.remainingAmount ● Float scalar

The credit still available to apply.

DebitNote.returnId ● String scalar

The ID of the return the note comes from.

DebitNote.status ● String! non-null scalar

Where the note stands: PENDING, APPROVED, PARTIALLY_APPLIED, APPLIED or CANCELLED.

DebitNote.taxAmount ● Float! non-null scalar

The tax on the note.

DebitNote.totalAmount ● Float! non-null scalar

The note total including tax, in the note's currency.

DebitNote.type ● String! non-null scalar

What the note is for, for example PURCHASE_RETURN.

DebitNote.updatedAt ● DateTime! non-null scalar

When the record was last changed.

DebitNote.updatedBy ● String! non-null scalar

The ID of the user who last changed the record.

Returned By

debitNote query ● debitNotes query

Member Of

DebitNoteResponse object