← API reference
CANONICAL TYPE REFERENCE

IssueCreditNoteInput

Input for issueCreditNote: credits an invoice in full, or in part when explicit lines are supplied.

TypeID (inv_…) of the invoice being credited. A credit note cannot itself be credited.

Human-facing number for the credit-note document. Required.

reasonString

Why the credit is being issued. Stored as the credit note's notes.

Lines to credit, for a partial credit. When omitted or empty, every line of the original invoice is mirrored and the full invoice amount is credited.

View exact SDL
"""
Input for `issueCreditNote`: credits an invoice in full, or in part when explicit lines are supplied.
"""
input IssueCreditNoteInput {
  """
  TypeID (`inv_…`) of the invoice being credited. A credit note cannot itself be credited.
  """
  invoiceId: InvoiceID!
  """Human-facing number for the credit-note document. Required."""
  creditNoteNumber: String!
  """Why the credit is being issued. Stored as the credit note's notes."""
  reason: String
  """
  Lines to credit, for a partial credit. When omitted or empty, every line of the original invoice is mirrored and the full invoice amount is credited.
  """
  lines: [CreditNoteLineInput!]
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.