Credit Note Request

Complete field reference for the CreditNoteDocument schema.

The CreditNoteDocument schema (@type = "CreditNoteDocument") is used with the Send a document from a JSON structure endpoint.

CreditNoteDocument

FieldTypeDescription
accountingCurrencystringISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
additionalIdentifiersobjectEscape-hatch for format-specific identifiers not yet mapped to a typed field. Empty if none.
Attachment[]BG-24 — Embedded supporting documents / binary attachments (e.g. a PDF rendition). Empty if none.
businessProcessTypestringBT-23 — Business process type the document belongs to.
requiredParty
buyerAccountingReferencestringBT-19 — Buyer accounting reference (e.g. accounting cost / GL account).
buyerReferencestringBT-10 — Buyer reference (e.g. cost centre); often mandatory for B2G.
contractReferencestringBT-12 — Contract reference.
creditNoteReasonCodestringBTAE-03 — Credit note reason code (jurisdiction-specific). Mandatory for PINT AE credit notes (from the 'Reasons for credit note' code list); ignored where the jurisdiction does not define it.
currencyrequiredstringISO 4217 currency code (BT-5, BT-6). Serialized in JSON as the three-letter ISO 4217 alphabetic code, which is the enum constant name, e.g. "EUR", "USD", "CHF".
Delivery
despatchAdviceReferencestringBT-16 — Despatch advice reference.
documentIdrequiredstringBT-1 — Credit note number. Unique identifier from the sender.
Allowance[]BG-20 — Document-level allowances (discounts). Empty if none.
Charge[]BG-21 — Document-level charges (fees). Empty if none.
dueDatedateBT-9 — Payment due date.
FacturXExtensions
FatturaPaExtensions
invoicedObjectIdentifierstringBT-18 — Invoiced object identifier.
issueDaterequireddateBT-2 — Credit note issue date.
requiredLineItem[]BG-25 — Credit note lines. At least one line is required.
notestringBT-22 — Note (free-text remarks).
originalInvoiceDaterequireddateBT-26 — Preceding invoice issue date (date of the original invoice).
originalInvoiceNumberrequiredstringBT-25 — Preceding invoice reference: number of the original invoice this credit note relates to.
PaymentInfo
paymentTermsTextstringBT-20 — Payment terms in free text.
PeppolExtensions
Money
projectReferencestringBT-11 — Project reference.
purchaseOrderReferencestringBT-13 — Purchase order reference.
receivingAdviceReferencestringBT-15 — Receiving advice reference.
salesOrderReferencestringBT-14 — Sales order reference.
requiredParty
requiredTaxBreakdown[]BG-23 — VAT breakdown per category/rate. At least one entry is required.
tenderOrLotReferencestringBT-17 — Tender or lot reference.
typeCoderequiredstringUN/CEFACT 1001 document type code (BT-3), e.g. 380 commercial invoice, 381 credit note, 384 corrected invoice, 386 prepayment invoice, 389 self-billed invoice. Serialized in JSON as the enum constant name (e.g. "COMMERCIAL_INVOICE", "CREDIT_NOTE"); the numeric code is exposed separately via code().
vatPointDatedateBT-7 — VAT point date: the date when VAT becomes accountable.
vatPointDateCodestringBT-8 — VAT point date code, when expressed as a code instead of a date.
XRechnungExtensions