Skip to main content

Structured output invoice Schema

Type: object

Properties

  • invoiceNumber required
    • Unique identifier for the invoice
    • Type: string
  • invoiceDate required
    • Date the invoice was issued (ISO format)
    • Type: string
    • String format must be a "date"
  • dueDate
    • Payment due date (ISO format)
    • Type: string
    • String format must be a "date"
  • billingAddress required
    • Billing address details
    • Type: object
    • Properties
      • name required
        • Type: string
      • street required
        • Type: string
      • city required
        • Type: string
      • state
        • Type: string
      • postalCode required
        • Type: string
      • country required
        • Type: string
  • shippingAddress
    • Shipping address details
    • Type: object
    • Properties
      • name required
        • Type: string
      • street required
        • Type: string
      • city required
        • Type: string
      • state
        • Type: string
      • postalCode required
        • Type: string
      • country required
        • Type: string
  • items required
    • List of items included in the invoice
    • Type: array
      • Items
      • Type: object
      • Properties
        • description required
          • Description of the item
          • Type: string
        • quantity required
          • Quantity of the item
          • Type: number
          • Range: ≥ 1
        • unitPrice required
          • Price per unit of the item
          • Type: number
          • Range: ≥ 0
        • totalPrice required
          • Total price for this item
          • Type: number
          • Range: ≥ 0
  • subTotal required
    • Subtotal for all items
    • Type: number
    • Range: ≥ 0
  • tax required
    • Tax details
    • Type: object
    • Properties
      • rate required
        • Tax rate as a percentage
        • Type: number
        • Range: ≥ 0
      • amount required
        • Total tax amount
        • Type: number
        • Range: ≥ 0
  • total required
    • Total amount due (subtotal + tax)
    • Type: number
    • Range: ≥ 0
  • notes
    • Additional notes or instructions for the invoice
    • Type: string
  • status required
    • Current payment status of the invoice
    • Type: string
    • The value is restricted to the following:
      1. "Paid"
      2. "Unpaid"
      3. "Overdue"