InvoiceTenantBreakdownResponse

  • currency
    Type: string · Currency
    required
  • invoice_id
    Type: string · Invoice Id
    required
  • tenants
    Type: array object[] · Tenants
    required

    Highest amount first. Empty when no line maps to a tenant.

    • amount_cents
      Type: integer · Amount Cents
      required

      Amount attributed to this tenant, in the smallest currency unit

    • line_count
      Type: integer · Line Count
      required

      How many invoice lines rolled up into this tenant

    • tenant_entity_id
      Type: string · Tenant Entity Id
      required
    • tenant_name
      Type: string · Tenant Name
      required
  • total_cents
    Type: integer · Total Cents
    required

    Invoice total in the smallest currency unit (cents for USD)

  • unallocated_cents
    Type: integer · Unallocated Cents
    required

    Total minus everything attributable to a tenant: one-off charges, lines with no matching tenant, and invoice-level discounts, credits and tax. Can be negative when a credit exceeds the unattributed lines.