Skip to main content
POST
/
organizations
/
{orgId}
/
externalmappings
Create an External Mapping
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/externalmappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "m3terEntity": "Account",
  "m3terId": "00000000-0000-0000-0000-000000000000",
  "externalSystem": "Stripe",
  "externalTable": "Customer",
  "externalId": "cus_00000000000000",
  "version": 123,
  "integrationConfigId": "00000000-0000-0000-0000-000000000000"
}
'
{
  "id": "<string>",
  "m3terEntity": "Account",
  "m3terId": "00000000-0000-0000-0000-000000000000",
  "externalSystem": "Stripe",
  "externalTable": "Customer",
  "externalId": "cus_00000000000000",
  "version": 123,
  "dtCreated": "2023-11-07T05:31:56Z",
  "dtLastModified": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedBy": "<string>",
  "integrationConfigId": "00000000-0000-0000-0000-000000000000"
}

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

The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.

Body

application/json

Request containing an External Mapping entity.

​
m3terEntity
string
required

The name of the m3ter entity that you are creating or modifying an External Mapping for. As an example, this could be an "Account".

Minimum string length: 1
Pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
Example:

"Account"

​
m3terId
string
required

The unique identifier (UUID) of the m3ter entity.

Minimum string length: 1
Pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
Example:

"00000000-0000-0000-0000-000000000000"

​
externalSystem
string
required

The name of the external system where the entity you are mapping resides.

Minimum string length: 1
Pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
Example:

"Stripe"

​
externalTable
string
required

The name of the table in ther external system where the entity resides.

Minimum string length: 1
Pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
Example:

"Customer"

​
externalId
string
required

The unique identifier (UUID) of the entity in the external system. This UUID should already exist in the external system.

Minimum string length: 1
Pattern: ^([^[\p{Cntrl}\s]])|([^[\p{Cntrl}\s]][[^[\p{Cntrl}\s]] ]*[^[\p{Cntrl}\s]])$
Example:

"cus_00000000000000"

​
version
integer<int64>

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
​
integrationConfigId
string

UUID of the integration config to link this mapping to

Example:

"00000000-0000-0000-0000-000000000000"

Response

Returns the created External Mapping

Response containing an External Mapping entity.

​
id
string
required

The UUID of the entity.

​
m3terEntity
string
required

The name of the m3ter entity that is part of the External Mapping. For example, this could be "Account".

Minimum string length: 1
Example:

"Account"

​
m3terId
string
required

The unique identifier (UUID) of the m3ter entity.

Minimum string length: 1
Example:

"00000000-0000-0000-0000-000000000000"

​
externalSystem
string
required

The name of the external system where the entity you are mapping resides.

Minimum string length: 1
Example:

"Stripe"

​
externalTable
string
required

The name of the table in the external system where the entity resides.

Minimum string length: 1
Example:

"Customer"

​
externalId
string
required

The unique identifier (UUID) of the entity in the external system.

Minimum string length: 1
Example:

"cus_00000000000000"

​
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.
​
dtCreated
string<date-time>

The DateTime when this item was created (in ISO-8601 format).

​
dtLastModified
string<date-time>

The DateTime when this item was last modified (in ISO-8601 format).

​
createdBy
string

The ID of the user who created this item.

​
lastModifiedBy
string

The ID of the user who last modified this item.

​
integrationConfigId
string

UUID of the configuration this mapping is for

Example:

"00000000-0000-0000-0000-000000000000"