Sign in
External Mapping

Create an External Mapping

Creates a new External Mapping.

This endpoint enables you to create a new External Mapping for the specified Organization. You need to supply a request body with the details of the new External Mapping.

post/organizations/{orgId}/externalmappings

Path parameters

orgIdstring required

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

Request body

versioninteger

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.

Response

Returns the created External Mapping

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.
dtCreatedstring date-time

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

dtLastModifiedstring date-time

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

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

m3terEntitystring required

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

m3terIdstring required

The unique identifier (UUID) of the m3ter entity.

externalSystemstring required

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

externalTablestring required

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

externalIdstring required

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

integrationConfigIdstring

UUID of the configuration this mapping is for

Example response

{
  "m3terEntity": "Account",
  "m3terId": "00000000-0000-0000-0000-000000000000",
  "externalSystem": "Stripe",
  "externalTable": "Customer",
  "externalId": "cus_00000000000000",
  "integrationConfigId": "00000000-0000-0000-0000-000000000000"
}

Changes

Changed in 1 of the 10 revisions of this API.2

  • 9f9e5f3dbde72See the full diff
    • ▲

      the response property allOf[AbstractResponseWithAuditFields]/allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    • ▲

      the response property allOf[AbstractResponse]/version became optional for the status 200

      response-property-became-optional

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog