IssueCreditNoteInput

Type: Input

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

Fields

Name	Type	Default	Description
creditNoteNumber	String!		Human-facing number for the credit-note document. Required.
invoiceId	InvoiceID!		TypeID (inv_…) of the invoice being credited. A credit note cannot itself be credited.
lines	[CreditNoteLineInput!]		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.
reason	String		Why the credit is being issued. Stored as the credit note's notes.