Available
Invoice schema
Generated invoice fields for submissions with and without line items.
Updated 2026-07-28
Use typeId: 0 for invoices. The response includes summary values such as invoice identity, supplier and buyer details, tax, totals, payment references, and optional item detail.
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 invoice template. |
processed_data.lineItems[].cgst_amount | number | Returned | Generated from the current invoice template. |
processed_data.lineItems[].cgst_rate | number | Returned | Generated from the current invoice template. |
processed_data.lineItems[].description | string | Returned | Generated from the current invoice template. |
processed_data.lineItems[].discount | number or 0 | Returned | Generated from the current invoice template. |
processed_data.lineItems[].hsn_sac | string hsn/sac can be written only once anywhere in invoice if all item have same hsn | Returned | Generated from the current invoice template. |
processed_data.lineItems[].igst_amount | float | Returned | Generated from the current invoice template. |
processed_data.lineItems[].igst_rate | number | Returned | Generated from the current invoice template. |
processed_data.lineItems[].quantity | float | Returned | Generated from the current invoice template. |
processed_data.lineItems[].rate | float | Returned | Generated from the current invoice template. |
processed_data.lineItems[].sgst_amount | number | Returned | Generated from the current invoice template. |
processed_data.lineItems[].sgst_rate | number | Returned | Generated from the current invoice template. |
processed_data.lineItems[].time_period | string if mentioned in description(generally in case of services), it may not be mentioned in case of services and won't be mentioned in case of goods | Returned | Generated from the current invoice template. |
processed_data.lineItems[].unit_or_per | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.PO | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.account_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.amount | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.balance_due | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.bank_name | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.batch_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.bill_to_gstin | string #billing GSTIN of buyer; this should match to_gstin when present | Returned | Generated from the current invoice template. |
processed_data.summary_data.cgst_amount | Returned | Generated from the current invoice template. | |
processed_data.summary_data.cgst_rate | Returned | Generated from the current invoice template. | |
processed_data.summary_data.currency | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.deduction_amount_payment_made | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.deduction_reason | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.delivery_note | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.dispatched_through | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.driver_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.due_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current invoice template. |
processed_data.summary_data.e_way_air_way_bill_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.expense_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current invoice template. |
processed_data.summary_data.from_gstin | string #This gstin is of issuer-- might be printed on invoice bottom footer-- don't confuse with to_gstin | Returned | Generated from the current invoice template. |
processed_data.summary_data.from_pan | string #PAN of issuer/vendor (10 chars AAAAA9999A); null if absent; do not use GSTIN as PAN | Returned | Generated from the current invoice template. |
processed_data.summary_data.ifsc | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.igst_amount | Returned | Generated from the current invoice template. | |
processed_data.summary_data.igst_rate | Returned | Generated from the current invoice template. | |
processed_data.summary_data.invoice_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.irn | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.mode_or_terms_of_payment | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.motor_vehicle_no | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.notes | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_address | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_name | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_pincode | number | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_state | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.round_off | number | Returned | Generated from the current invoice template. |
processed_data.summary_data.sgst_amount | Returned | Generated from the current invoice template. | |
processed_data.summary_data.sgst_rate | Returned | Generated from the current invoice template. | |
processed_data.summary_data.ship_to_gstin | string can be null | Returned | Generated from the current invoice template. |
processed_data.summary_data.ship_to_pincode | string can be find in consignee ship to address section | Returned | Generated from the current invoice template. |
processed_data.summary_data.ship_to_state | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.tax_amount | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.taxable_amount | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.terms_of_delivery | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.to_gstin | string #this gstin is of buyer billing address. If buyer has both billing and shipping GSTINs, use billing GSTIN here, not shipping GSTIN | Returned | Generated from the current invoice template. |
processed_data.summary_data.to_pan | string #PAN of buyer/receiver; null if absent; do not use GSTIN as PAN | Returned | Generated from the current invoice template. |
processed_data.summary_data.type | Invoice/Quotation | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_address | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_name | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_pincode | number | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_state | string | Returned | Generated from the current invoice template. |
Without line items
| Field | Type | Template | Description |
|---|---|---|---|
processed_data.summary_data.PO | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.account_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.amount | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.balance_due | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.bank_name | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.batch_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.bill_to_gstin | string #billing GSTIN of buyer; this should match to_gstin when present | Returned | Generated from the current invoice template. |
processed_data.summary_data.cgst_amount | Returned | Generated from the current invoice template. | |
processed_data.summary_data.cgst_rate | Returned | Generated from the current invoice template. | |
processed_data.summary_data.currency | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.deduction_amount_payment_made | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.deduction_reason | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.delivery_note | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.dispatched_through | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.driver_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.due_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current invoice template. |
processed_data.summary_data.e_way_air_way_bill_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.expense_date | string (ISO 8601 date format) yyyy-mm-dd | Returned | Generated from the current invoice template. |
processed_data.summary_data.from_gstin | string #This gstin is of issuer-- might be printed on invoice bottom footer-- don't confuse with to_gstin | Returned | Generated from the current invoice template. |
processed_data.summary_data.from_pan | string #PAN of issuer/vendor (10 chars AAAAA9999A); null if absent; do not use GSTIN as PAN | Returned | Generated from the current invoice template. |
processed_data.summary_data.ifsc | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.igst_amount | Returned | Generated from the current invoice template. | |
processed_data.summary_data.igst_rate | Returned | Generated from the current invoice template. | |
processed_data.summary_data.invoice_number | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.irn | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.mode_or_terms_of_payment | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.motor_vehicle_no | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.notes | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_address | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_name | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_pincode | number | Returned | Generated from the current invoice template. |
processed_data.summary_data.receiver_state | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.round_off | number | Returned | Generated from the current invoice template. |
processed_data.summary_data.sgst_amount | Returned | Generated from the current invoice template. | |
processed_data.summary_data.sgst_rate | Returned | Generated from the current invoice template. | |
processed_data.summary_data.ship_to_gstin | string can be null | Returned | Generated from the current invoice template. |
processed_data.summary_data.ship_to_pincode | string can be find in consignee ship to address section | Returned | Generated from the current invoice template. |
processed_data.summary_data.ship_to_state | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.tax_amount | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.taxable_amount | float | Returned | Generated from the current invoice template. |
processed_data.summary_data.terms_of_delivery | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.to_gstin | string #this gstin is of buyer billing address. If buyer has both billing and shipping GSTINs, use billing GSTIN here, not shipping GSTIN | Returned | Generated from the current invoice template. |
processed_data.summary_data.to_pan | string #PAN of buyer/receiver; null if absent; do not use GSTIN as PAN | Returned | Generated from the current invoice template. |
processed_data.summary_data.type | Invoice/Quotation | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_address | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_name | string | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_pincode | number | Returned | Generated from the current invoice template. |
processed_data.summary_data.vendor_state | string | Returned | Generated from the current invoice template. |