CANONICAL TYPE REFERENCE
IssueCreditNotePayload
Result of issueCreditNote: the new credit note, its lines, and the credited invoice.
The credit note — an invoice of kind creditNote, status draft, with creditedInvoiceId pointing at the original. Null when errors is non-empty.
The credit note's lines: the supplied lines, or a mirror of the original invoice's lines for a full credit. Null on failure.
The credited invoice after its status is set to credited — which also blocks further payments against it. Null on failure.
errors[FieldError!]!Field-level validation errors. Empty on success; when non-empty no credit note was written.
View exact SDL
"""
Result of `issueCreditNote`: the new credit note, its lines, and the credited invoice.
"""
type IssueCreditNotePayload {
"""
The credit note — an invoice of kind `creditNote`, status `draft`, with `creditedInvoiceId` pointing at the original. Null when `errors` is non-empty.
"""
creditNote: InvoiceState
"""
The credit note's lines: the supplied `lines`, or a mirror of the original invoice's lines for a full credit. Null on failure.
"""
creditNoteLines: [InvoiceLineState!]
"""
The credited invoice after its status is set to `credited` — which also blocks further payments against it. Null on failure.
"""
originalInvoice: InvoiceState
"""
Field-level validation errors. Empty on success; when non-empty no credit note was written.
"""
errors: [FieldError!]!
}One stable address across all schema views. Follow a field’s type to explore connections between domains.