Data Export Entity Schema
The schema for entities available for operational data exports are set out in the tables below.
For additional reference:
Operational data export records typically include all relevant fields for an entity returned by the API. Further details and descriptions of each field can be found in the corresponding sections of the m3ter API Reference documentation.
The Entity Relationship Diagram lays out the m3ter data entities and their relationships.
Account
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| deleted | boolean | |
| version | integer | |
| address | string | JSON object |
| autoGenerateStatementMode | string | |
| billEpoch | string | |
| code | string | |
| createdBy | string | |
| creditApplicationOrder | string | |
| currency | string | |
| emailAddress | string | |
| dtCreated | string | |
| dtLastModified | string | |
| name | string | |
| parentAccountId | string | uuid |
| purchaseOrderNumber | string | |
| statementDefinitionId | string | uuid |
AccountPlan
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| deleted | boolean | |
| version | integer | |
| accountId | string | uuid |
| billEpoch | string | |
| childBillingMode | string | |
| code | string | |
| contractId | string | |
| createdBy | string | |
| dtCreated | string | |
| dtLastModified | string | |
| endDate | string | |
| modifiedBy | string | |
| planId | string | |
| planGroupId | string | |
| productId | string | |
| startDate | string | |
Aggregation
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| name | string | |
| code | string | |
| rounding | string | |
| quantityPerUnit | integer | |
| unit | string | |
| segments | string | JSON object |
| meterId | string | |
| targetField | string | |
| aggregation | string | |
| segmentedFields | string | JSON object |
| defaultValue | integer | |
| deleted | boolean | |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
Balance
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| name | string | |
| code | string | |
| description | string | |
| accountId | string | |
| amount | float | |
| currency | string | |
| startDate | string | |
| endDate | string | |
| rolloverAmount | float | |
| rolloverEndDate | string | |
| balanceDrawDownDescription | string | |
| overageSurchargePercent | float | |
| overageDescription | string | |
| productIds | string | JSON object ( list of uuids) |
| lineItemTypes | string | JSON object |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Bill Line Item
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| productId | string | uuid |
| aggregationId | string | uuid |
| compoundAggregationId | string | uuid |
| counterId | string | uuid |
| segment | string | JSON Object |
| meterId | string | uuid |
| PlanId | string | uuid |
| PlanGroupId | string | uuid |
| commitmentId | string | uuid |
| balanceId | string | uuid |
| billId | string | uuid |
| productName | string | |
| productCode | string | |
| description | string | |
| quantity | float | |
| units | float | |
| unit | string | |
| subtotal | float | |
| currency | string | |
| conversionRate | float | |
| convertedSubtotal | float | |
| creditTypeId | string | uuid |
| lineItemType | string | |
| pricingId | string | uuid |
| bandUsage | string | JSON Object |
| servicePeriodStartDate | string | |
| servicePeriodEndDate | string | |
| referenceBillId | string | |
| referenceLineItemId | string | |
| reasonId | string | uuid |
| contractId | string | uuid |
| averageUnitPrice | float | |
| sequenceNumber | integer | |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lasyModifiedBy | string | |
| deleted | boolean | |
Bill
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| accountId | string | |
| startDateTimeUTC | string | |
| endDateTimeUTC | string | |
| billDate | string | |
| dueDate | string | |
| billingFrequency | string | |
| billingFrequencyInterval | integer | |
| timezone | string | |
| currency | string | |
| locked | boolean | |
| createdDate | string | |
| status | string | |
| lastCalculatedDate | string | |
| purchaseOrderNumber | string | |
| externalInvoiceReference | string | |
| billTotal | double | |
| dtCreated | string | |
| dtlastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Commitment
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| accountId | string | |
| billingPlanId | string | |
| productIds | string | JSON Object |
| startDate | string | |
| endDate | string | |
| currency | string | |
| amount | float | |
| amountPrePaid | float | |
| amountFirstBill | float | |
| amountSpent | float | |
| overageSurchargePercent | float | |
| separateOverageUsage | boolean | |
| billingInterval | integer | |
| billingOffset | integer | |
| commitmentFeeDescription | string | |
| commitmentUsageDescription | string | |
| overageDescription | string | |
| commitmentFeeBillInAdvance | boolean | |
| billEpoch | string | |
| contractId | string | |
| accountingProductId | string | |
| childBillingMode | string | |
| lineItemTypes | string | JSON Object |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Contract
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| accountId | string | uuid |
| name | string | |
| code | string | |
| description | string | |
| purchaseOrderNumber | string | |
| startDate | string | |
| endDate | string | |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Plan
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| name | string | |
| code | string | |
| planTemplateId | string | |
| productId | string | |
| ordinal | integer | |
| bespoke | boolean | |
| minimumSpend | float | |
| minimumSpendDescription | string | |
| accountId | string | |
| standingCharge | float | |
| standingChargeDescription | string | |
| standingChargeBillInAdvance | boolean | |
| minimumSpendBillInAdvance | boolean | |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Pricing
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | boolean | |
| code | string | |
| description | string | |
| planId | string | |
| planTemplateId | string | |
| startDate | string | |
| endDate | string | |
| minimumSpend | float | |
| minimumSpend Description | string | |
| minimumSpendBillInAdvance | boolean | |
| aggregationId | string | |
| aggregationType | string | |
| compoundAggregationId | string | |
| cumulative | boolean | |
| type | string | |
| segment | string | JSON Object |
| tiersSpanPlan | boolean | |
| dtCreated | string | |
| dtLastModified | string | |
| createdby | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Pricing Band
| Field Name | Data Type | Notes |
|---|
| id | string | uuid (primary key) |
| version | integer | |
| pricingId | string | |
| lowerLimit | float | |
| fixedPrice | float | |
| unitPrice | float | |
| type | string | |
| dtCreated | string | |
| dtLastModified | string | |
| createdBy | string | |
| lastModifiedBy | string | |
| deleted | boolean | |
Additional Support
Login to the Support portal for additional help and to send questions to our Support team.
