Invoice
Type: schema
Description
Invoice model
TypeScript Definition
typescript
Invoice: {{
invoice_number?: string;
/** @description Current state of the invoice, e.g. `"printed"`. */
status?: string;
/** Format: date */
invoice_date?: string | null;
/** @description Invoice Reference Number */
irn_number?: string | null;
/** @description Acknowledgement Number */
ack_number?: string | null;
/**
* Format: date-time
* @description Acknowledgement Date
*/
ack_date?: string | null;
signed_qr_code?: string | null;
gatepass_barcode?: string | null;
/** @description Party the invoice is raised by: the seller record for marketplace seller invoices, the warehouse for single-seller stores, or `null`. */
seller_details?: components["schemas"]["AdminSellerInfo"] | components["schemas"]["Warehouse"] | null;
billing_address?: components["schemas"]["AdminOrderAddress"];
shipping_address?: components["schemas"]["AdminOrderAddress"];
subtotal?: number;
sub_total?: number;
sub_total_including_tax?: number;
shipping_amount?: number;
shipping_amount_including_tax?: number;
coupon_code?: string | null;
coupon_discount_percent?: number | null;
coupon_discount_amount?: number | null;
promotion_discount_amount?: number;
loyalty_point_redeemed?: number;
total_tax?: number;
grand_total?: number;
tax_summary?: {
tax_rate?: number;
taxable_value?: number;
igst?: number;
cgst?: number;
sgst?: number;
}[];
/** Format: date-time */
created_at?: string;
/** Format: date-time */
modified_at?: string;
};
/**
* InvoiceDetail
* @description InvoiceDetail model
*/
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["AdminSellerInfo"] | AdminSellerInfo |
components["schemas"]["Warehouse"] | Warehouse |
components["schemas"]["AdminOrderAddress"] | AdminOrderAddress |
OpenAPI Schema
json
{
"description": "Invoice model",
"type": "object",
"properties": {
"invoice_number": {
"type": "string"
},
"status": {
"description": "Current state of the invoice, e.g. `\"printed\"`.",
"type": "string"
},
"invoice_date": {
"type": [
"string",
"null"
],
"format": "date"
},
"irn_number": {
"description": "Invoice Reference Number",
"type": [
"string",
"null"
]
},
"ack_number": {
"description": "Acknowledgement Number",
"type": [
"string",
"null"
]
},
"ack_date": {
"description": "Acknowledgement Date",
"type": [
"string",
"null"
],
"format": "date-time"
},
"signed_qr_code": {
"type": [
"string",
"null"
]
},
"gatepass_barcode": {
"type": [
"string",
"null"
]
},
"seller_details": {
"description": "Party the invoice is raised by: the seller record for marketplace seller invoices, the warehouse for single-seller stores, or `null`.",
"anyOf": [
{
"$ref": "#/components/schemas/AdminSellerInfo"
},
{
"$ref": "#/components/schemas/Warehouse"
},
{
"type": "null"
}
]
},
"billing_address": {
"$ref": "#/components/schemas/AdminOrderAddress"
},
"shipping_address": {
"$ref": "#/components/schemas/AdminOrderAddress"
},
"subtotal": {
"type": "number"
},
"sub_total": {
"type": "number"
},
"sub_total_including_tax": {
"type": "number"
},
"shipping_amount": {
"type": "number"
},
"shipping_amount_including_tax": {
"type": "number"
},
"coupon_code": {
"type": [
"string",
"null"
]
},
"coupon_discount_percent": {
"type": [
"number",
"null"
]
},
"coupon_discount_amount": {
"type": [
"number",
"null"
]
},
"promotion_discount_amount": {
"type": "number"
},
"loyalty_point_redeemed": {
"type": "number"
},
"total_tax": {
"type": "number"
},
"grand_total": {
"type": "number"
},
"tax_summary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_rate": {
"type": "number"
},
"taxable_value": {
"type": "number"
},
"igst": {
"type": "number"
},
"cgst": {
"type": "number"
},
"sgst": {
"type": "number"
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"modified_at": {
"type": "string",
"format": "date-time"
}
},
"title": "Invoice",
"x-tags": [
"Shipping"
]
}Auto-generated from OpenAPI spec and TypeScript definitions