IssueCreditNotePayload

Type: Object

Result of issueCreditNote: the new credit note, its lines, and the credited invoice.

Fields

Name	Type	Args	Description	Deprecated
creditNote	InvoiceState		The credit note — an invoice of kind creditNote, status draft, with creditedInvoiceId pointing at the original. Null when errors is non-empty.
creditNoteLines	[InvoiceLineState!]		The credit note's lines: the supplied lines, or a mirror of the original invoice's lines for a full credit. Null on failure.
errors	[FieldError!]!		Field-level validation errors. Empty on success; when non-empty no credit note was written.
originalInvoice	InvoiceState		The credited invoice after its status is set to credited — which also blocks further payments against it. Null on failure.

Relationships

• InvoiceState