Skip to main content
GET
/
organizations
/
{orgId}
/
organizationconfig
Retrieve OrganizationConfig
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/organizationconfig \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "timezone": "UTC",
  "yearEpoch": "2022-01-01",
  "monthEpoch": "2022-01-01",
  "weekEpoch": "2022-01-04",
  "dayEpoch": "2022-01-01",
  "currency": "<string>",
  "currencyConversions": [
    {
      "from": "EUR",
      "to": "USD",
      "multiplier": 1.12
    }
  ],
  "daysBeforeBillDue": 123,
  "scheduledBillInterval": 123,
  "scheduledBillOffset": 123,
  "standingChargeBillInAdvance": true,
  "commitmentFeeBillInAdvance": true,
  "minimumSpendBillInAdvance": true,
  "autoApproveBillsGracePeriod": 123,
  "autoApproveBillsGracePeriodUnit": "MINUTES",
  "externalInvoiceDate": "LAST_DAY_OF_ARREARS",
  "suppressedEmptyBills": true,
  "consolidateBills": true,
  "defaultStatementDefinitionId": "<string>",
  "billPrefix": "<string>",
  "sequenceStartNumber": 123,
  "autoGenerateStatementMode": "NONE",
  "creditApplicationOrder": [
    "PREPAYMENT"
  ],
  "allowNegativeBalances": true,
  "allowOverlappingPlans": true,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.

Response

Return the Organization configuration

​
id
string
required

The UUID of the entity.

​
version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
​
timezone
string
default:UTC

The timezone for the Organization.

Example:

"UTC"

​
yearEpoch
string
default:2022-01-01

The first bill date (in ISO-8601 format) for yearly billing periods.

Example:

"2022-01-01"

​
monthEpoch
string
default:2022-01-01

The first bill date (in ISO-8601 format) for monthly billing periods.

Example:

"2022-01-01"

​
weekEpoch
string
default:2022-01-04

The first bill date (in ISO-8601 format) for weekly billing periods.

Example:

"2022-01-04"

​
dayEpoch
string
default:2022-01-01

The first bill date (in ISO-8601 format) for daily billing periods.

Example:

"2022-01-01"

​
currency
string

The currency code for the currency used in this Organization. For example: USD, GBP, or EUR.

​
currencyConversions
object[]

Currency conversion rates from Bill currency to Organization currency.

For example, if Account is billed in GBP and Organization is set to USD, Bill line items are calculated in GBP and then converted to USD using the defined rate.

​
daysBeforeBillDue
integer<int32>

The number of days after the Bill generation date shown on Bills as the due date.

​
scheduledBillInterval
number<double>

Specifies the required interval for updating bills.

  • For portions of an hour (minutes). Two options: 0.25 (15 minutes) and 0.5 (30 minutes).
  • For full hours. Eight possible values: 1, 2, 3, 4, 6, 8, 12, or 24.
  • Default. The default is 0, which disables scheduling.
​
scheduledBillOffset
integer<int32>

Offset (hours) within the scheduled interval to run the job, interpreted in the organization's timezone. For daily (24h) schedules this is the hour of day (0-23). Only supported when ScheduledBillInterval is 24 (daily) at present.

​
standingChargeBillInAdvance
boolean

Specifies whether the standing charge is billed in advance at the start of each billing period, or billed in arrears at the end of each billing period.

  • TRUE - bill in advance (start of each billing period).
  • FALSE - bill in arrears (end of each billing period).
​
commitmentFeeBillInAdvance
boolean

Specifies whether commitments (prepayments) are billed in advance at the start of each billing period, or billed in arrears at the end of each billing period.

  • TRUE - bill in advance (start of each billing period).
  • FALSE - bill in arrears (end of each billing period).
​
minimumSpendBillInAdvance
boolean

Specifies whether minimum spend amounts are billed in advance at the start of each billing period, or billed in arrears at the end of each billing period.

  • TRUE - bill in advance (start of each billing period).
  • FALSE - bill in arrears (end of each billing period).
​
autoApproveBillsGracePeriod
integer<int32>

Grace period before bills are auto-approved. Used in combination with the field autoApproveBillsGracePeriodUnit.

​
autoApproveBillsGracePeriodUnit
enum<string>
Available options:
MINUTES,
HOURS,
DAYS
​
externalInvoiceDate
enum<string>
Available options:
LAST_DAY_OF_ARREARS,
FIRST_DAY_OF_NEXT_PERIOD
​
suppressedEmptyBills
boolean

Specifies whether to supress generating bills that have no line items.

  • TRUE - prevents generating bills with no line items.
  • FALSE - bills are still generated even when they have no line items.
​
consolidateBills
boolean

Specifies whether to consolidate different billing frequencies onto the same bill.

  • TRUE - consolidate different billing frequencies onto the same bill.
  • FALSE - bills are not consolidated.
​
defaultStatementDefinitionId
string

Organization level default statementDefinitionId to be used when there is no statement definition linked to the account.

Statement definitions are used to generate bill statements, which are informative backing sheets to invoices.

​
billPrefix
string

Prefix to be used for sequential invoice numbers. This will be combined with the sequenceStartNumber.

​
sequenceStartNumber
integer<int32>

The starting number to be used for sequential invoice numbers. This will be combined with the billPrefix.

​
autoGenerateStatementMode
enum<string>

Specifies whether to auto-generate statements once Bills are approved or locked. It will not auto-generate if a bill is in pending state.

The default value is None.

  • None. Statements will not be auto-generated.
  • JSON. Statements are auto-generated in JSON format.
  • JSON and CSV. Statements are auto-generated in both JSON and CSV formats.
Available options:
NONE,
JSON,
JSON_AND_CSV
​
creditApplicationOrder
enum<string>[]

The order in which any Prepayment or Balance credit amounts on Accounts are to be drawn-down against for billing. Four options:

  • "PREPAYMENT","BALANCE". Draw-down against Prepayment credit before Balance credit.
  • "BALANCE","PREPAYMENT". Draw-down against Balance credit before Prepayment credit.
  • "PREPAYMENT". Only draw-down against Prepayment credit.
  • "BALANCE". Only draw-down against Balance credit.
Available options:
PREPAYMENT,
BALANCE
​
allowNegativeBalances
boolean

Allow balance amounts to fall below zero. This feature is enabled on request. Please get in touch with m3ter Support or your m3ter contact if you would like it enabling for your organization(s).

​
allowOverlappingPlans
boolean

Allows plans to overlap time periods for different contracts.

​
dtCreated
string<date-time>

The DateTime when the organization config was created (in ISO-8601 format).

​
dtLastModified
string<date-time>

The DateTime when the organization config was last modified (in ISO-8601 format).

​
createdBy
string

The id of the user who created this organization config.

​
lastModifiedBy
string

The id of the user who last modified this organization config.