Available
Debit note schema
Generated debit-note fields for submissions with and without line items.
Updated 2026-07-28
Use typeId: 3 for debit notes and vendor-credit adjustments. The schema includes debit-note identity, related documents, parties, taxes, amounts, and adjustment items.
Missing template fields are returned as null at scalar leaves; missing arrays and objects are normalized to empty containers.
With line items
| Field | Type | Template | Description |
|---|---|---|---|
processed_data.lineItems[].amount | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].cgst_amount | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].cgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].description | string | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].discount | number or 0 | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].hsn_sac | string hsn/sac can be written only once anywhere in debit note if all item have same hsn | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].igst_amount | float | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].igst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].quantity | float | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].rate | float | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].sgst_amount | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].sgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].unit_or_per | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].bill_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].bill_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].bill_number | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].payment_amount | float #Amount applied from this bill as credit | Returned | Generated from the current debit-note template. |
processed_data.summary_data.cgst_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.cgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.credits_remaining | float #Credits remaining after this debit note | Returned | Generated from the current debit-note template. |
processed_data.summary_data.credits_used | float #Credits used amount, can be negative | Returned | Generated from the current debit-note template. |
processed_data.summary_data.currency | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.debit_note_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current debit-note template. |
processed_data.summary_data.debit_note_number | string #Note# field from document | Returned | Generated from the current debit-note template. |
processed_data.summary_data.from_gstin | string #This gstin is of issuer (debit note creator)-- might be printed on debit note bottom footer-- don't confuse with to_gstin | Returned | Generated from the current debit-note template. |
processed_data.summary_data.grn_number | string #GRN No reference if mentioned | Returned | Generated from the current debit-note template. |
processed_data.summary_data.igst_amount | float #Total IGST amount (sum of all IGST rates if multiple) | Returned | Generated from the current debit-note template. |
processed_data.summary_data.igst_rate | number #Primary IGST rate if single rate, or highest rate if multiple rates exist | Returned | Generated from the current debit-note template. |
processed_data.summary_data.invoice_number | string #Invoice No reference if mentioned, can be empty | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_address | string #Address of company issuing the debit note | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_name | string #Name of company issuing the debit note | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_pincode | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_state | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.notes | string #Includes any notes like 'Please refer attached Debit note created for your perusal' | Returned | Generated from the current debit-note template. |
processed_data.summary_data.po_number | string #PO No reference if mentioned | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_address | string #Full address of receiver if different from vendor | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_name | string #Name of receiver if different from vendor | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_pincode | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_state | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.reference_number | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.round_off | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.sgst_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.sgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.sub_total | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.to_gstin | string #this gstin is of buyer/vendor (recipient of debit note) | Returned | Generated from the current debit-note template. |
processed_data.summary_data.total_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.type | Debit Note/Debit Note Cum Vendor Credits | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_address | string #Full address of vendor/recipient | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_name | string #Name of vendor/recipient | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_pincode | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_state | string | Returned | Generated from the current debit-note template. |
Without line items
| Field | Type | Template | Description |
|---|---|---|---|
processed_data.lineItems[].amount | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].cgst_amount | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].cgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].description | string | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].discount | number or 0 | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].hsn_sac | string hsn/sac can be written only once anywhere in debit note if all item have same hsn | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].igst_amount | float | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].igst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].quantity | float | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].rate | float | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].sgst_amount | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].sgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.lineItems[].unit_or_per | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].bill_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].bill_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].bill_number | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.applied_bills[].payment_amount | float #Amount applied from this bill as credit | Returned | Generated from the current debit-note template. |
processed_data.summary_data.cgst_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.cgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.credits_remaining | float #Credits remaining after this debit note | Returned | Generated from the current debit-note template. |
processed_data.summary_data.credits_used | float #Credits used amount, can be negative | Returned | Generated from the current debit-note template. |
processed_data.summary_data.currency | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.debit_note_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current debit-note template. |
processed_data.summary_data.debit_note_number | string #Note# field from document | Returned | Generated from the current debit-note template. |
processed_data.summary_data.from_gstin | string #This gstin is of issuer (debit note creator)-- might be printed on debit note bottom footer-- don't confuse with to_gstin | Returned | Generated from the current debit-note template. |
processed_data.summary_data.grn_number | string #GRN No reference if mentioned | Returned | Generated from the current debit-note template. |
processed_data.summary_data.igst_amount | float #Total IGST amount (sum of all IGST rates if multiple) | Returned | Generated from the current debit-note template. |
processed_data.summary_data.igst_rate | number #Primary IGST rate if single rate, or highest rate if multiple rates exist | Returned | Generated from the current debit-note template. |
processed_data.summary_data.invoice_number | string #Invoice No reference if mentioned, can be empty | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_address | string #Address of company issuing the debit note | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_name | string #Name of company issuing the debit note | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_pincode | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.issuer_state | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.notes | string #Includes any notes like 'Please refer attached Debit note created for your perusal' | Returned | Generated from the current debit-note template. |
processed_data.summary_data.po_number | string #PO No reference if mentioned | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_address | string #Full address of receiver if different from vendor | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_name | string #Name of receiver if different from vendor | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_pincode | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.receiver_state | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.reference_number | string | Returned | Generated from the current debit-note template. |
processed_data.summary_data.round_off | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.sgst_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.sgst_rate | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.sub_total | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.to_gstin | string #this gstin is of buyer/vendor (recipient of debit note) | Returned | Generated from the current debit-note template. |
processed_data.summary_data.total_amount | float | Returned | Generated from the current debit-note template. |
processed_data.summary_data.type | Debit Note/Debit Note Cum Vendor Credits | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_address | string #Full address of vendor/recipient | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_name | string #Name of vendor/recipient | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_pincode | number | Returned | Generated from the current debit-note template. |
processed_data.summary_data.vendor_state | string | Returned | Generated from the current debit-note template. |