CreateCreditNoteInput

A new credit note.

input CreateCreditNoteInput {
  adjustments: Float
  amount: Float!
  currency: String
  expiryDate: DateTime
  internalNotes: String
  items: [CreateCreditNoteItemInput!]!
  notes: String
  originalInvoiceId: String
  partnerId: String!
  reason: String!
  returnId: String
  taxAmount: Float
  type: String!
}

Fields

CreateCreditNoteInput.adjustments ● Float scalar

A signed adjustment to the total, such as rounding.

CreateCreditNoteInput.amount ● Float! non-null scalar

The note amount before tax.

CreateCreditNoteInput.currency ● String scalar

ISO 4217 currency code.

CreateCreditNoteInput.expiryDate ● DateTime scalar

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

CreateCreditNoteInput.internalNotes ● String scalar

Notes for staff only. They are not shown to the customer or supplier.

CreateCreditNoteInput.items ● [CreateCreditNoteItemInput!]! non-null input

The credit lines.

CreateCreditNoteInput.notes ● String scalar

Notes shown on the note.

CreateCreditNoteInput.originalInvoiceId ● String scalar

The ID of the invoice the note is raised against.

CreateCreditNoteInput.partnerId ● String! non-null scalar

The ID of the partner.

CreateCreditNoteInput.reason ● String! non-null scalar

Why the note is raised.

CreateCreditNoteInput.returnId ● String scalar

The ID of the return the note comes from.

CreateCreditNoteInput.taxAmount ● Float scalar

The tax on the note.

CreateCreditNoteInput.type ● String! non-null scalar

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

Member Of

createCreditNote mutation