InvoiceDetail

object

idrequired: Id
Opaque record id.
numberrequired: string or null
Null on a draft; INV/26-27/0001 once issued.
document_typerequired: "tax_invoice" | "bill_of_supply"
statusrequired: "draft" | "issued" | "part_paid" | "paid" | "cancelled"
financial_yearrequired: string or null
dealrequired: DealLink or null
contactrequired: object or null
contact.idrequired: Id
Opaque record id.
contact.namerequired: string
party_rolerequired: string or null
bill_torequired: FinanceParty
place_of_supplyrequired: string or null
ISO state code (IGST Act s.12(3): the property).
pos_basisrequired: 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.
round_offrequired: Paise
Money in paise (₹1 = 100), an exact integer.
totalrequired: Paise
Money in paise (₹1 = 100), an exact integer.
amount_receivedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
amount_tdsrequired: Paise
Money in paise (₹1 = 100), an exact integer.
amount_creditedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
balancerequired: Paise
Money in paise (₹1 = 100), an exact integer.
issued_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
due_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
days_overduerequired: integer or null
ageingrequired: "not_due" | "d1_30" | "d31_60" | "d61_90" | "d90_plus" or null
notesrequired: string or null
termsrequired: string or null
cancelled_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
cancel_reasonrequired: string or null
sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
created_byrequired: MemberRef or null
issued_byrequired: MemberRef or null
created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
updated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
capabilitiesrequired: object
capabilities.editrequired: boolean
capabilities.issuerequired: boolean
capabilities.cancelrequired: boolean
capabilities.creditrequired: boolean
capabilities.sendrequired: boolean
capabilities.allocaterequired: boolean
receiptsrequired: array of object
receipts[].idrequired: Id
Opaque record id.
receipts[].numberrequired: string
receipts[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
receipts[].tds_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
receipts[].gst_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
receipts[].excess_amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
receipts[].moderequired: string
receipts[].referencerequired: string or null
receipts[].received_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
receipts[].statusrequired: string
credit_notesrequired: array of object
credit_notes[].idrequired: Id
Opaque record id.
credit_notes[].numberrequired: string
credit_notes[].totalrequired: Paise
Money in paise (₹1 = 100), an exact integer.
credit_notes[].issued_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
credit_notes[].reasonrequired: string
credit_notes[].gst_reversedrequired: boolean
payment_linksrequired: array of object
payment_links[].idrequired: Id
Opaque record id.
payment_links[].statusrequired: string
payment_links[].amountrequired: Paise
Money in paise (₹1 = 100), an exact integer.
payment_links[].amount_paidrequired: Paise
Money in paise (₹1 = 100), an exact integer.
payment_links[].short_urlrequired: string or null
payment_links[].expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
creditablerequired: Paise
Taxable value still creditable.
gst_reversal_untilrequired: LocalDate or null
The last day a credit note may still reduce its GST (CGST s.34(2)).

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "number": "string",
  "document_type": "tax_invoice",
  "status": "draft",
  "financial_year": "string",
  "deal": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "title": "string"
  },
  "contact": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "party_role": "string",
  "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",
  "pos_basis": "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,
  "round_off": 850000000,
  "total": 850000000,
  "amount_received": 850000000,
  "amount_tds": 850000000,
  "amount_credited": 850000000,
  "balance": 850000000,
  "issued_on": "2026-10-06",
  "due_on": "2026-10-06",
  "days_overdue": 0,
  "ageing": "not_due",
  "notes": "string",
  "terms": "string",
  "cancelled_at": "2026-10-06T05:30:00.000Z",
  "cancel_reason": "string",
  "sent_at": "2026-10-06T05:30:00.000Z",
  "created_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "issued_by": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "name": "string"
  },
  "created_at": "2026-10-06T05:30:00.000Z",
  "updated_at": "2026-10-06T05:30:00.000Z",
  "capabilities": {
    "edit": true,
    "issue": true,
    "cancel": true,
    "credit": true,
    "send": true,
    "allocate": true
  },
  "receipts": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string",
      "amount": 850000000,
      "tds_amount": 850000000,
      "gst_amount": 850000000,
      "excess_amount": 850000000,
      "mode": "string",
      "reference": "string",
      "received_on": "2026-10-06",
      "status": "string"
    }
  ],
  "credit_notes": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": "string",
      "total": 850000000,
      "issued_on": "2026-10-06",
      "reason": "string",
      "gst_reversed": true
    }
  ],
  "payment_links": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "amount": 850000000,
      "amount_paid": 850000000,
      "short_url": "string",
      "expires_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "creditable": 850000000,
  "gst_reversal_until": "2026-10-06"
}

{ "id": "cmusrceel0000q7kaafxqi1om", "number": "string", "document_type": "tax_invoice", "status": "draft", "financial_year": "string", "deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "title": "string" }, "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "party_role": "string", "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", "pos_basis": "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, "round_off": 850000000, "total": 850000000, "amount_received": 850000000, "amount_tds": 850000000, "amount_credited": 850000000, "balance": 850000000, "issued_on": "2026-10-06", "due_on": "2026-10-06", "days_overdue": 0, "ageing": "not_due", "notes": "string", "terms": "string", "cancelled_at": "2026-10-06T05:30:00.000Z", "cancel_reason": "string", "sent_at": "2026-10-06T05:30:00.000Z", "created_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "issued_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "capabilities": { "edit": true, "issue": true, "cancel": true, "credit": true, "send": true, "allocate": true }, "receipts": [ { "id": "cmusrceel0000q7kaafxqi1om", "number": "string", "amount": 850000000, "tds_amount": 850000000, "gst_amount": 850000000, "excess_amount": 850000000, "mode": "string", "reference": "string", "received_on": "2026-10-06", "status": "string" } ], "credit_notes": [ { "id": "cmusrceel0000q7kaafxqi1om", "number": "string", "total": 850000000, "issued_on": "2026-10-06", "reason": "string", "gst_reversed": true } ], "payment_links": [ { "id": "cmusrceel0000q7kaafxqi1om", "status": "string", "amount": 850000000, "amount_paid": 850000000, "short_url": "string", "expires_at": "2026-10-06T05:30:00.000Z" } ], "creditable": 850000000, "gst_reversal_until": "2026-10-06" }