M3m3ter-com
OrganizationConfig

Retrieve OrganizationConfig

Changed on

Retrieve the Organization-wide configuration details.

get/organizations/{orgId}/organizationconfig

Request

Path parameters

orgIdstring required

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

Response

Return the Organization configuration

idstring required

The UUID of the entity.

versioninteger

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.
timezonestring

The timezone for the Organization.

yearEpochstring

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

monthEpochstring

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

weekEpochstring

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

dayEpochstring

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

currencystring

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

daysBeforeBillDueinteger

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

scheduledBillIntervalnumber 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.
scheduledBillOffsetinteger

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.

standingChargeBillInAdvanceboolean

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).
commitmentFeeBillInAdvanceboolean

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).
minimumSpendBillInAdvanceboolean

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).
autoApproveBillsGracePeriodinteger

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

autoApproveBillsGracePeriodUnit'MINUTES' | 'HOURS' | 'DAYS'

Time unit of grace period before bills are auto-approved. Used in combination with the field autoApproveBillsGracePeriod.

externalInvoiceDate'LAST_DAY_OF_ARREARS' | 'FIRST_DAY_OF_NEXT_PERIOD'

The date to use for the invoice date.

suppressedEmptyBillsboolean

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.
consolidateBillsboolean

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.
defaultStatementDefinitionIdstring

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.

billPrefixstring

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

sequenceStartNumberinteger

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

autoGenerateStatementMode'NONE' | 'JSON' | 'JSON_AND_CSV'

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.
creditApplicationOrderBillCreditType[]

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.
allowNegativeBalancesboolean
allowOverlappingPlansboolean

Specifies whether or not multiple plans for the same Product can be active on an Account at the same time:

  • TRUE - multiple overlapping plans for the same product can be attached to the same Account.
  • FALSE - multiple overlapping plans for the same product cannot be attached to the same Account.(Default)
useUnifiedDrawdownsboolean

Specifies whether or not the Unified Balance Drawdown mode is used for drawn-downs at billing against Balances and Commitments credit on Accounts:

  • If true, enabled.
  • If false, not enabled.
dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

The id of the user who created this organization config.

lastModifiedBystring

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
    }
  ]
}

Changes

  • 85c514abc692Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      response property allOf[subschema #2]/allowNegativeBalances deprecated

  • ac93d1a9e6d9Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status