Credit / debit note

nutrab2b.finance.credit_noted.v2 · Finance

Purpose: Adjust an invoice for returns, price differences, short shipment or rebates.
When to send: Agreed correction.
Sender → receiver: Supplier → Buyer
Expected responses: ACK
Equivalent standards: X12: 812 · EDIFACT: INVOIC (381/383)
Scenarios using it: Short receipt settled with credit note · Currency precision (ISO 4217)

Fields and mappings

Field	Type	Req	Description	Code list / format
note_number	string	yes	Note number
invoice_type	string	yes	381 credit or 383 debit	invoice_type
invoice_number	string	yes	Original invoice
currency	string	yes	Currency	currency
reason	string	yes	Reason
lines	array<object>	yes	Lines
line_no	integer	yes	Line
line_amount	number	yes	Amount
tax_total	number	yes	Tax
total	number	yes	TotalNB-R001 NB-R011

Business rules

NB-R001 Totals mismatch, line totals, tax and charges do not add up to document total.
NB-R011 Currency precision, amount has more decimals than the currency's ISO 4217 minor units.

Example

{
  "specversion": "2.0",
  "id": "evt-credit_note-INV-9001-1",
  "type": "nutrab2b.finance.credit_noted.v2",
  "source": "urn:gln:4012345000009:erp",
  "subject": "INV-9001",
  "time": "2026-11-02T09:00:00Z",
  "datacontenttype": "application/json",
  "dataschema": "https://nutrab2b.org/schemas/2.0/CREDIT_NOTE.json",
  "sender": {
    "gln": "4012345000009"
  },
  "receiver": {
    "gln": "0614141000012"
  },
  "correlationid": "CONV-RFQ-1001",
  "idempotencykey": "CREDIT_NOTE:INV-9001:1",
  "sequence": 1,
  "env": "test",
  "data": {
    "note_number": "CN-120",
    "invoice_type": "381",
    "invoice_number": "INV-9001",
    "currency": "USD",
    "reason": "Short shipment 10 kg",
    "lines": [
      {
        "line_no": 1,
        "line_amount": 580
      }
    ],
    "tax_total": 0,
    "total": 580
  }
}

Mapping checklist

Every required field populated from your system of record
Coded fields mapped to the Bodylia OpenB2B code lists
GLN, GTIN and SSCC check digits validated
Rules above pass in the validator
Idempotency key and per-subject sequence generated
Expected responses, including rejections, handled