Tax Invoice

An issued VAT invoice for a recipient account. Use its number, period, issue date, and gross amount for reconciliation. PDF availability is separate from issuance: check download_available before requesting a temporary PDF URL through download_url.

  • id
    Type: string
    required

    Unique Tax Invoice ID. Store it to associate events and PDF downloads with this invoice.

  • issue_date
    Type: stringFormat: date
    required

    Date the Tax Invoice was issued, in YYYY-MM-DD format.

  • object
    enum
    const:  
    tax_invoice
    required

    Identifies this resource as a Tax Invoice.

  • status
    enum
    const:  
    issued
    required

    Issuance status. PDF availability is reported separately in download_available.

    values
    • issued

      The Tax Invoice has been issued and has an invoice number and issue date. Its PDF may still be preparing.

  • number
    Type: string
    required

    Issued invoice number. Keep it as a string to preserve leading zeros.

  • amount
    Type: integerFormat: int64
    required

    Gross invoice amount, including tax, as an integer at currency.scale decimal places. For example, 12000 with currency.scale: 2 represents 120.00 in currency.code. Preserve the integer value when parsing JSON.

  • currency
    Type: Tax Invoice currency
    required

    Currency code and decimal scale used to interpret the invoice amount.

    Properties: 2
  • type
    enum
    const:  
    vat_invoice
    required

    Type of Tax Invoice.

    values
    • vat_invoice

      A VAT invoice issued for the account.

  • title
    enum
    const:  
    Tax Invoice
    required

    Display title for the issued document.

  • description
    Type: string
    required

    Display text describing the invoiced period, such as Tax Invoice for August 2026.

  • period
    Type: Tax Invoice period
    required

    Invoiced date range. The start is included and the end is excluded.

    Properties: 2
  • account
    Type: string
    required

    Recipient account ID. For a connected-account request, this is the selected connected account.

  • livemode
    Type: boolean
    required

    True for an invoice in live mode; false for an invoice in test mode.

  • download_available
    Type: boolean
    required

    Whether the issued PDF is ready to download. If false, wait for tax_invoice.available before requesting a download URL.

  • download_url
    Type: string
    required

    API path for requesting a temporary PDF download link. Call it when download_available is true, then use the returned url before expires_at.