Data & Analytics
Data Models
Data & Analytics
Data Models
Export any of these data tables to your preferred destination
Credit Notes
Snapshot of all credit notes.
| Field | Description | Data Type |
|---|---|---|
| id | ID of the credit note | STRING |
| invoice_id | ID of the invoice that the credit note relates to | STRING |
| invoice_number | Number of the invoice that the credit note relates to | STRING |
| customer_id | ID of the customer the credit note is for | STRING |
| customer_legal_name | Legal name of the customer the credit note is for | STRING |
| currency | Currency of the credit note | STRING |
| issue_date | Date the credit note was issued | DATE |
| credit_note_number | Number of the credit note | STRING |
| credit_note_gross_total | Gross total amount of the credit note | FLOAT |
| credit_note_total_tax | Total tax amount of the credit note | FLOAT |
| credit_note_net_total | Net total amount of the credit note | FLOAT |
| invoice_gross_total | Gross total amount of the related invoice | FLOAT |
| invoice_net_total | Net total amount of the related invoice | FLOAT |
| invoice_total_tax | Total tax amount of the related invoice | FLOAT |
| status | Status of the credit note. One of DRAFT, FINAL, VOIDED, SENT | STRING |
| memo | Additional memo or notes | STRING |
| modified_at | Last modified timestamp for this record | TIMESTAMP |
Customers
Snapshot of all customers.
| Field | Description | Data Type |
|---|---|---|
| id | ID of the customer | STRING |
| legal_name | Legal name of the customer | STRING |
| contact_name | Name of the contact person for the customer | STRING |
| Email address of the customer | STRING | |
| label | Label associated with the customer | STRING |
| country | Country of the customer | STRING |
| modified_at | Last modified timestamp for this record | TIMESTAMP |
Invoices
Snapshot of all invoices.
| Field | Description | Data Type |
|---|---|---|
| id | ID of the invoice | STRING |
| currency | Currency of the invoice | STRING |
| invoice_number | Numerical identifier of the invoice (often preceded by a prefix) | STRING |
| issue_date | Date the invoice was issued | DATE |
| due_date | Date the invoice is due | DATE |
| paid_date | Date the invoice was paid | DATE |
| days_past | Number of days past the invoice due date | INTEGER |
| memo | Additional memo or notes | STRING |
| customer_id | ID of the customer the invoice is for | STRING |
| customer_legal_name | Legal name of the customer the invoice is for | STRING |
| billing_period_start | Start date of the billing period covered by the invoice | STRING |
| billing_period_end | End date of the billing period covered by the invoice | STRING |
| gross_total | Gross total amount of the invoice | FLOAT |
| total_tax | Total tax amount of the invoice | FLOAT |
| net_total | Net total amount of the invoice | FLOAT |
| status | Status of the invoice. One of VOIDED, DRAFT, SENT, FINAL | STRING |
| payment_status | Payment status of the invoice. One of PAID, UNPAID, UNCOLLECTIBLE | STRING |
| billing_schedule_id | ID of the billing schedule the invoice is associated with | STRING |
| modified_at | Last modified timestamp for this record | TIMESTAMP |
Line Items
Snapshot of all invoice line items.
| Field | Description | Data Type |
|---|---|---|
| id | ID of the line item | STRING |
| invoice_id | ID of the invoice that the line item belongs to | STRING |
| title | Title of the line item | STRING |
| product_name | Name of the product associated with the line item | STRING |
| usage_event_type | Type of the usage event, for usage-based line items | STRING |
| pricing_type | Pricing type of the line item | STRING |
| usage_metric_name | Name of the associated usage metric | STRING |
| usage_metric_id | ID of the usage metric, for usage-based line items | STRING |
| quantity | Quantity of the line item | FLOAT |
| gross_total | Gross total amount of the line item | FLOAT |
| total_tax | Total tax amount of the line item | FLOAT |
| net_total | Net total amount of the line item | FLOAT |
| invoice_gross_total | Gross total amount of the invoice | FLOAT |
| invoice_gross_total_fraction | Fraction of the line item gross total relative to the invoice gross total | FLOAT |
| invoice_status | Status of the invoice | STRING |
| modified_at | Last modified timestamp for this record | TIMESTAMP |
Revenue
Calculated metric reporting the total revenue amount over time by customer, product and currency.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| date_month | Month the revenue is calculated for | STRING |
| customer_id | ID of the customer the revenue is calculated for | STRING |
| customer_legal_name | Legal name of the customer the revenue is calculated for | STRING |
| customer_cohort_month | Starting month of the first billing schedule for the customer the revenue is calculated for | STRING |
| currency | Currency | STRING |
| product_id | ID of the product this revenue is calculated for | STRING |
| product_name | Name of the product this revenue is calculated for | STRING |
| revenue | Total revenue amount | FLOAT |
| modified_at | Latest calculation time | TIMESTAMP |
Revenue Bridge
Categorization of revenue changes across different time periods.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| end_month | Reference month of the bridge | DATE |
| start_month | Month the bridge is compared to | DATE |
| bridge_period | Period the bridge is calculated for | STRING |
| currency | Currency of the revenue | STRING |
| component_type | Component of the bridge. One of ‘New Business’, ‘Expansion’, ‘Reactivation’, ‘Contraction’, ‘Churn’, ‘Start Revenue’, ‘End Revenue’ | STRING |
| component_value | Value of the bridge component. Delta for component breakdown and absolute value for start and end revenue | FLOAT |
| modified_at | Latest calculation time | TIMESTAMP |
Billing Schedule Prices
For each billing schedule, a snapshot of prices it contains. Includes an estimate of the total monetary value of each billing schedule.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this billing schedule and price pair | STRING |
| billing_schedule_id | ID of the billing schedule | STRING |
| billing_schedule_status | Status of the billing schedule. One of ACTIVE, COMPLETED | STRING |
| billing_schedule_start_date | UTC start date of the billing schedule | DATE |
| billing_schedule_end_date | UTC end date of the billing schedule | DATE |
| plan_name | Name of the plan associated to the billing schedule | STRING |
| plan_currency | Currency of the plan associated to the billing schedule | STRING |
| customer_id | ID of the customer associated to the billing schedule | STRING |
| customer_legal_name | Legal name of the customer associated to the billing schedule | STRING |
| billing_schedule_total_value_fixed | Fixed pricing component of the total value of the billing schedule | FLOAT |
| billing_schedule_total_value_usage_based_estimate | Usage-based pricing component of the total value of the billing schedule, estimated based on past invoices | FLOAT |
| billing_schedule_total_value_estimate | Overall estimate of the total value of the billing schedule (fixed + usage-based) | FLOAT |
| price_id | ID of the price | STRING |
| price_name | Name of the price | STRING |
| product_name | Name of the product associated to the price | STRING |
| price_billing_frequency | Frequency at which this price is billed | STRING |
| price_billing_type | Either IN_ADVANCE or IN_ARREARS | STRING |
| price_pricing_structure | Pricing model specification for this price | JSON |
| price_pricing_type | Pricing model type for this price | STRING |
| price_amount_fixed | Price amount if the pricing type is fixed (else null) | STRING |
| price_amount_usage_based_estimate | Price amount if the pricing type is usage-based (else null), estimated based on past invoices | STRING |
| price_amount_estimate | Overall price amount estimate (whether fixed or usage-based) | STRING |
| price_number_of_occurrences | Number of times this price occurs in the schedule | FLOAT |
| modified_at | Last modified timestamp for this record | TIMESTAMP |
Usage Events Counts
Daily counts of usage events ingested, by customer and event type.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| date_day | Day the metric is calculated for | STRING |
| customer_id | ID of the customer the metric is calculated for | STRING |
| customer_legal_name | Legal name of the customer the metric is calculated for | STRING |
| usage_event_type | Type of the usage event the metric is calculated for | STRING |
| usage_events_count | Calculated value of the metric | INTEGER |
| modified_at | Latest calculation time | TIMESTAMP |
Usage Metrics
All usage metrics calculated monthly, by metric and customer.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| date_month | Month the metric is calculated for | STRING |
| customer_id | ID of the customer the metric is calculated for | STRING |
| customer_legal_name | Legal name of the customer the metric is calculated for | STRING |
| usage_metric_name | Name of the usage metric | STRING |
| usage_metric_value | Calculated value of the metric | FLOAT |
| modified_at | Latest calculation time | TIMESTAMP |
Gross Invoiced Amount
Calculated metric reporting the total gross invoiced amount over time, by customer and currency.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| date_month | Month the metric is calculated for | STRING |
| customer_id | ID of the customer the metric is calculated for | STRING |
| customer_legal_name | Legal name of the customer the metric is calculated for | STRING |
| currency | Currency | STRING |
| gross_invoiced_amount | Calculated value of the metric | FLOAT |
| modified_at | Latest calculation time | TIMESTAMP |
Net Invoiced Amount
Calculated metric reporting the total net invoiced amount over time, by customer and currency.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| date_month | Month the metric is calculated for | STRING |
| customer_id | ID of the customer the metric is calculated for | STRING |
| customer_legal_name | Legal name of the customer the metric is calculated for | STRING |
| currency | Currency | STRING |
| net_invoiced_amount | Calculated value of the metric | FLOAT |
| modified_at | Latest calculation time | TIMESTAMP |
Active Schedules Count
Calculated metric reporting the number of active billing schedules over time, by customer.
| Field | Description | Data Type |
|---|---|---|
| id | Unique surrogate key ID for this calculation | STRING |
| date_month | Month the metric is calculated for | STRING |
| active_schedules_count | Calculated value of the metric | INTEGER |
| modified_at | Latest calculation time | TIMESTAMP |