CreditNote

object

idrequired: Id
Opaque record id.
numberrequired: string
financial_yearrequired: string
invoicerequired: object
invoice.idrequired: Id
Opaque record id.
invoice.numberrequired: string or null
invoice.issued_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
dealrequired: DealLink or null
contactrequired: object or null
contact.idrequired: Id
Opaque record id.
contact.namerequired: string
reasonrequired: string
reason_noterequired: string or null
gst_reversedrequired: boolean
False: a commercial credit (no GST reduced).
bill_torequired: FinanceParty
place_of_supplyrequired: string or null
supply_regimerequired: "intra" | "inter" | "none"
gst_rate_bpsrequired: integer
linesrequired: array of FinanceLine
subtotalrequired: Paise
Money in paise (₹1 = 100), an exact integer.
cgstrequired: Paise
Money in paise (₹1 = 100), an exact integer.
sgstrequired: Paise
Money in paise (₹1 = 100), an exact integer.
igstrequired: Paise
Money in paise (₹1 = 100), an exact integer.
totalrequired: Paise
Money in paise (₹1 = 100), an exact integer.
issued_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
issued_byrequired: MemberRef or null
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "number": "string",
  "financial_year": "string",
  "invoice": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "number": "string",
    "issued_on": "2026-10-06"
  },
  "deal": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "title": "string"
  },
  "contact": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "reason": "string",
  "reason_note": "string",
  "gst_reversed": true,
  "bill_to": {
    "legal_name": "string",
    "gstin": "string",
    "pan": "string",
    "address": "string",
    "city": "string",
    "state": "string",
    "pincode": "string",
    "email": "string",
    "phone": "string"
  },
  "place_of_supply": "string",
  "supply_regime": "intra",
  "gst_rate_bps": 0,
  "lines": [
    {
      "index": 0,
      "description": "string",
      "sac": "string",
      "side": "string",
      "taxable": 850000000,
      "cgst": 850000000,
      "sgst": 850000000,
      "igst": 850000000,
      "total": 850000000
    }
  ],
  "subtotal": 850000000,
  "cgst": 850000000,
  "sgst": 850000000,
  "igst": 850000000,
  "total": 850000000,
  "issued_on": "2026-10-06",
  "issued_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "created_at": "2026-10-06T05:30:00.000Z"
}

{ "id": "cmusrceel0000q7kaafxqi1om", "number": "string", "financial_year": "string", "invoice": { "id": "cmusrceel0000q7kaafxqi1om", "number": "string", "issued_on": "2026-10-06" }, "deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "title": "string" }, "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "reason": "string", "reason_note": "string", "gst_reversed": true, "bill_to": { "legal_name": "string", "gstin": "string", "pan": "string", "address": "string", "city": "string", "state": "string", "pincode": "string", "email": "string", "phone": "string" }, "place_of_supply": "string", "supply_regime": "intra", "gst_rate_bps": 0, "lines": [ { "index": 0, "description": "string", "sac": "string", "side": "string", "taxable": 850000000, "cgst": 850000000, "sgst": 850000000, "igst": 850000000, "total": 850000000 } ], "subtotal": 850000000, "cgst": 850000000, "sgst": 850000000, "igst": 850000000, "total": 850000000, "issued_on": "2026-10-06", "issued_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z" }