Skip to main content

CreditNote

A credit note: money owed back to a customer, from a sales return, a price adjustment or goodwill.

type CreditNote {
  appliedAmount: Float!
  createdAt: DateTime!
  createdBy: CreatedBy!
  creditNoteNumber: String!
  currency: String!
  expiryDate: DateTime
  id: ID!
  internalNotes: String
  issueDate: DateTime!
  items: [CreditNoteItem!]!
  linesLocked: Boolean!
  notes: String
  originalDocument: OriginalDocument
  originalInvoiceId: ID
  partnerId: String!
  partnerName: String!
  partnerType: String!
  reason: String!
  remainingAmount: Float!
  status: String!
  totalAmount: Float!
  type: String!
}

Fields

`CreditNote.appliedAmount` ● `Float!` non-null scalar

How much of the note has been applied to invoices.

`CreditNote.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`CreditNote.createdBy` ● `CreatedBy!` non-null object

The user who created the note.

`CreditNote.creditNoteNumber` ● `String!` non-null scalar

The credit note number, unique within the organization.

`CreditNote.currency` ● `String!` non-null scalar

ISO 4217 currency code.

`CreditNote.expiryDate` ● `DateTime` scalar

The date after which the credit can no longer be applied.

`CreditNote.id` ● `ID!` non-null scalar

The unique ID of this record.

`CreditNote.internalNotes` ● `String` scalar

Notes for staff only.

`CreditNote.issueDate` ● `DateTime!` non-null scalar

The date the note was issued.

`CreditNote.items` ● `[CreditNoteItem!]!` non-null object

The lines of the note.

`CreditNote.linesLocked` ● `Boolean!` non-null scalar

True when the lines follow what a return's inspection accepted and cannot be edited.

`CreditNote.notes` ● `String` scalar

Notes shown on the note.

`CreditNote.originalDocument` ● `OriginalDocument` object

The document the note was raised against.

`CreditNote.originalInvoiceId` ● `ID` scalar

The ID of the invoice the note is raised against.

`CreditNote.partnerId` ● `String!` non-null scalar

The ID of the partner.

`CreditNote.partnerName` ● `String!` non-null scalar

The name of the customer or vendor.

`CreditNote.partnerType` ● `String!` non-null scalar

Whether the partner is a customer or a vendor.

`CreditNote.reason` ● `String!` non-null scalar

Why the note was raised.

`CreditNote.remainingAmount` ● `Float!` non-null scalar

How much of the note is still available to apply.

`CreditNote.status` ● `String!` non-null scalar

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

`CreditNote.totalAmount` ● `Float!` non-null scalar

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

`CreditNote.type` ● `String!` non-null scalar

What the note is for: SALES_RETURN, PURCHASE_RETURN, PRICE_ADJUSTMENT, GOODWILL or OTHER.

Returned By

applyCreditNote mutation ● createCreditNote mutation ● creditNote query ● creditNotes query ● removeCreditNote mutation ● updateCreditNote mutation ● voidCreditNote mutation

Fields
Returned By