Retrieve OrganizationConfig
Retrieve the Organization-wide configuration details.
Path parameters
UUID of the organization. The Organization represents your company as a direct customer of the m3ter service.
Response
Return the Organization configuration
The UUID of the entity.
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.
The timezone for the Organization.
The first bill date (in ISO-8601 format) for yearly billing periods.
The first bill date (in ISO-8601 format) for monthly billing periods.
The first bill date (in ISO-8601 format) for weekly billing periods.
The first bill date (in ISO-8601 format) for daily billing periods.
The currency code for the currency used in this Organization. For example: USD, GBP, or EUR.
The number of days after the Bill generation date shown on Bills as the due date.
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.
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).
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).
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).
Grace period before bills are auto-approved. Used in combination with the field autoApproveBillsGracePeriodUnit.
Time unit of grace period before bills are auto-approved. Used in combination with the field autoApproveBillsGracePeriod.
The date to use for the invoice date.
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.
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.
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.
Prefix to be used for sequential invoice numbers. This will be combined with the sequenceStartNumber.
The starting number to be used for sequential invoice numbers. This will be combined with the billPrefix.
Specify 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.
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.
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).
Allows plans to overlap time periods for different contracts.
The DateTime when the organization config was created (in ISO-8601 format).
The DateTime when the organization config was last modified (in ISO-8601 format).
The id of the user who created this organization config.
The id of the user who last modified this organization config.
Example response
{
"timezone": "UTC",
"yearEpoch": "2022-01-01",
"monthEpoch": "2022-01-01",
"weekEpoch": "2022-01-04",
"dayEpoch": "2022-01-01",
"currencyConversions": [
{
"from": "EUR",
"to": "USD",
"multiplier": 1.12
}
]
}