Skip to main content
GET
/
organizations
/
{orgId}
/
accounts
/
{id}
Retrieve Account
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/accounts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "customFields": {},
  "name": "<string>",
  "code": "<string>",
  "address": {
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "addressLine3": "<string>",
    "addressLine4": "<string>",
    "locality": "<string>",
    "region": "<string>",
    "postCode": "<string>",
    "country": "<string>"
  },
  "emailAddress": "<string>",
  "parentAccountId": "<string>",
  "billEpoch": "2023-12-25",
  "purchaseOrderNumber": "<string>",
  "currency": "USD",
  "statementDefinitionId": "<string>",
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "autoGenerateStatementMode": "NONE",
  "creditApplicationOrder": [
    "PREPAYMENT"
  ],
  "daysBeforeBillDue": 123
}

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.

​
id
string
required

The UUID of the Account to retrieve.

Response

Returns the requested Account

Response containing an AccountResponse entity.

​
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.
​
customFields
object

User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number.

If customFields can also be defined for this entity at the Organizational level,customField values defined at individual level override values of customFields with the same name defined at Organization level.

See Working with Custom Fields in the m3ter documentation for more information.

​
name
string

Name of the Account.

​
code
string

Code of the Account. This is a unique short code used for the Account.

​
address
object

Contact address for the Account.

​
emailAddress
string

Contact email for the Account.

​
parentAccountId
string

Parent Account ID, or null if this account does not have a parent.

​
billEpoch
string<date>

Defines first bill date for Account Bills. For example, if the Plan attached to the Account is set for monthly billing frequency and you set the first bill date to be January 1st, Bills are created every month starting on that date.

Optional attribute - if not defined, then first bill date is determined by the Epoch settings at Organizational level.

​
purchaseOrderNumber
string

Purchase Order Number of the Account.

Optional attribute - allows you to set a purchase order number that comes through into invoicing. For example, your financial systems might require this as a reference for clearing payments.

​
currency
string

Account level billing currency, such as USD or GBP. Optional attribute:

  • If you define an Account currency, this will be used for bills.
  • If you do not define a currency, the billing currency defined at Organizational will be used.

Note: If you've attached a Plan to the Account that uses a different currency to the billing currency, then you must add the relevant currency conversion rate at Organization level to ensure the billing process can convert line items calculated using the Plan currency into the selected billing currency. If you don't add these conversion rates, then bills will fail for the Account.

Example:

"USD"

​
statementDefinitionId
string

The UUID of the statement definition used when Bill statements are generated for the Account. If no statement definition is specified for the Account, the statement definition specified at Organizational level is used.

Bill statements can be used as informative backing sheets to invoices. Based on the usage breakdown defined in the statement definition, generated statements give a breakdown of usage charges on Account Bills, which helps customers better understand usage charges incurred over the billing period.

See Working with Bill Statements in the m3ter documentation for more details.

​
dtCreated
string<date-time>

The DateTime when the Account was created (in ISO 8601 format).

​
dtLastModified
string<date-time>

The DateTime when the Account was last modified (in ISO 8601 format).

​
createdBy
string

The ID of the user who created the account.

​
lastModifiedBy
string

The ID of the user who last modified the Account.

​
autoGenerateStatementMode
enum<string>

Specify whether to auto-generate statements once Bills are approved or locked.

  • 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 amounts on the Account 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
​
daysBeforeBillDue
integer<int32>

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