Skip to main content

CreditNoteSummary

Totals for the credit note list.

type CreditNoteSummary {
  appliedNotes: Float!
  appliedValue: Float!
  byType: [CreditNoteTypeBreakdown!]!
  draftNotes: Float!
  expiredNotes: Float!
  issuedNotes: Float!
  remainingValue: Float!
  totalNotes: Float!
  totalValue: Float!
}

Fields​

CreditNoteSummary.appliedNotes ● Float! non-null scalar​

How many are applied.

CreditNoteSummary.appliedValue ● Float! non-null scalar​

The part of that value already applied.

CreditNoteSummary.byType ● [CreditNoteTypeBreakdown!]! non-null object​

The same figures split by credit note type.

CreditNoteSummary.draftNotes ● Float! non-null scalar​

How many are drafts.

CreditNoteSummary.expiredNotes ● Float! non-null scalar​

How many have expired.

CreditNoteSummary.issuedNotes ● Float! non-null scalar​

How many are issued.

CreditNoteSummary.remainingValue ● Float! non-null scalar​

The part of that value still available to apply.

CreditNoteSummary.totalNotes ● Float! non-null scalar​

How many credit notes match.

CreditNoteSummary.totalValue ● Float! non-null scalar​

The total value of the notes.

Returned By​

creditNoteSummary query