Skip to content

Invoice

Type: schema

Description

Invoice model

TypeScript Definition

typescript
Invoice: {{
            invoice_number?: string;
            /** Format: date-time */
            invoice_date?: string;
            /** @description Invoice Reference Number */
            irn_number?: string;
            /** @description Acknowledgement Number */
            ack_number?: string;
            /**
             * Format: date-time
             * @description Acknowledgement Date
             */
            ack_date?: string;
            signed_qr_code?: string;
            gatepass_barcode?: string;
            seller_details?: components["schemas"]["Warehouse"];
            billing_address?: components["schemas"]["CustomerAddress"];
            shipping_address?: components["schemas"]["CustomerAddress"];
            subtotal?: number;
            shipping_amount?: number;
            coupon_code?: string;
            coupon_discount_percent?: number;
            coupon_discount_amount?: 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

ReferenceResolves To
components["schemas"]["Warehouse"]Warehouse
components["schemas"]["CustomerAddress"]CustomerAddress

OpenAPI Schema

json
{
  "description": "Invoice model",
  "type": "object",
  "properties": {
    "invoice_number": {
      "type": "string"
    },
    "invoice_date": {
      "type": "string",
      "format": "date-time"
    },
    "irn_number": {
      "description": "Invoice Reference Number",
      "type": "string"
    },
    "ack_number": {
      "description": "Acknowledgement Number",
      "type": "string"
    },
    "ack_date": {
      "description": "Acknowledgement Date",
      "type": "string",
      "format": "date-time"
    },
    "signed_qr_code": {
      "type": "string"
    },
    "gatepass_barcode": {
      "type": "string"
    },
    "seller_details": {
      "$ref": "#/components/schemas/Warehouse"
    },
    "billing_address": {
      "$ref": "#/components/schemas/CustomerAddress"
    },
    "shipping_address": {
      "$ref": "#/components/schemas/CustomerAddress"
    },
    "subtotal": {
      "type": "number"
    },
    "shipping_amount": {
      "type": "number"
    },
    "coupon_code": {
      "type": "string"
    },
    "coupon_discount_percent": {
      "type": "number"
    },
    "coupon_discount_amount": {
      "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

Last updated: