Picklists - m3ter Documentation

Retrieve TransactionType

Function name: m3ter_GetTransactionType Category: READ HTTP method: GET Destination: m3ter Retrieves the TransactionType with the given UUID from the specified Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The unique identifier (UUID) of the TransactionType to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update TransactionType

Function name: m3ter_UpdateTransactionType Category: WRITE HTTP method: PUT Destination: m3ter Updates the TransactionType with the specified UUID for the specified Organization. Update details for the TransactionType should be included in the request body.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The unique identifer (UUID) of the TransactionType to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete TransactionType

Function name: m3ter_DeleteTransactionType Category: WRITE HTTP method: DELETE Destination: m3ter Deletes the TransactionType with the given UUID from the specified Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The unique identifier (UUID) of the TransactionType to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List Credit Reasons

Function name: m3ter_ListCreditReasons Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of the Credit Reason entities created for your Organization. You can filter the list returned for the call by Credit Reason ID, Credit Reason short code, or by Archive status.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids,codes,archived

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create Credit Reason

Function name: m3ter_CreateCreditReason Category: WRITE HTTP method: POST Destination: m3ter Create a new Credit Reason for your Organization. When you’ve created a Credit Reason, it becomes available as a credit type for adding Credit line items to Bills. See Credits.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List Bill Grouping Keys

Function name: m3ter_ListBillGroupingKeys Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of Bill Grouping Keys created for your Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids,codes,archived

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create BillGroupingKey

Function name: m3ter_CreateBillGroupingKey Category: WRITE HTTP method: POST Destination: m3ter Create a new Bill Grouping Key.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Currency

Function name: m3ter_GetCurrency Category: READ HTTP method: GET Destination: m3ter Retrieve the specified Currency with the given UUID. Used to obtain the details of a specified existing Currency in your Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The unique identifier (UUID) of the Currency to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update Currency

Function name: m3ter_UpdateCurrency Category: WRITE HTTP method: PUT Destination: m3ter Update a Currency with the given UUID. Used to update the attributes of the specified Currency for the specified Organization.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The unique identifier (UUID) of the Currency to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete Currency

Function name: m3ter_DeleteCurrency Category: WRITE HTTP method: DELETE Destination: m3ter Delete the Currency with the given UUID. Used to remove an existing Currency from your Organization that is no longer required.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The unique identifier (UUID) of the Currency to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List Currencies

Function name: m3ter_ListCurrencies Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of Currencies. Retrieves a list of Currencies for the specified Organization. This endpoint supports pagination and includes various query parameters to filter the Currencies based on Currency ID, and short codes.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids,codes,archived

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create Currency

Function name: m3ter_CreateCurrency Category: WRITE HTTP method: POST Destination: m3ter Creates a new Currency for the specified Organization. Used to create a Currency that your Organization will start to use.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List TransactionTypes

Function name: m3ter_ListTransactionTypes Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieves a list of TransactionType entities for the specified Organization. The list can be paginated for easier management, and supports filtering by various parameters.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids,codes,archived

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create TransactionType

Function name: m3ter_CreateTransactionType Category: WRITE HTTP method: POST Destination: m3ter Create a new TransactionType for the specified Organization. Details of the new TransactionType should be included in the request body.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve BillGroupingKey

Function name: m3ter_GetBillGroupingKey Category: READ HTTP method: GET Destination: m3ter Retrieve a Bill Grouping Key for the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Bill Grouping Key to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update BillGroupingKey

Function name: m3ter_UpdateBillGroupingKey Category: WRITE HTTP method: PUT Destination: m3ter Update a Bill Grouping Key for the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Bill Grouping Key to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete BillGroupingKey

Function name: m3ter_DeleteBillGroupingKey Category: WRITE HTTP method: DELETE Destination: m3ter Delete a Bill Grouping Key for the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Bill Grouping Key to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

List Debit Reasons

Function name: m3ter_ListDebitReasons Category: READ HTTP method: GET (paginated) Destination: m3ter Retrieve a list of the Debit Reason entities created for your Organization. You can filter the list returned for the call by Debit Reason ID, Debit Reason short code, or by Archive status.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-
`queryParams`	Query Parameters	KeyValueLookupParameter	No	Query parameters to include in the request	allowedValues: ids,codes,archived

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Create Debit Reason

Function name: m3ter_CreateDebitReason Category: WRITE HTTP method: POST Destination: m3ter Create a new Debit Reason for your Organization. When you’ve created a Debit Reason, it becomes available as a debit type for adding Debit line items to Bills. See Debits.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Credit Reason

Function name: m3ter_GetCreditReason Category: READ HTTP method: GET Destination: m3ter Retrieve the Credit Reason with the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Credit Reason to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update Credit Reason

Function name: m3ter_UpdateCreditReason Category: WRITE HTTP method: PUT Destination: m3ter Update the Credit Reason with the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Credit Reason to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete Credit Reason

Function name: m3ter_DeleteCreditReason Category: WRITE HTTP method: DELETE Destination: m3ter Delete the Credit Reason with the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Credit Reason to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Retrieve Debit Reason

Function name: m3ter_GetDebitReason Category: READ HTTP method: GET Destination: m3ter Retrieve the Debit Reason with the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Debit Reason to retrieve.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Update Debit Reason

Function name: m3ter_UpdateDebitReason Category: WRITE HTTP method: PUT Destination: m3ter Update the Debit Reason with the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Debit Reason to update.	-
`requestPath`	Request Path	StateVariableParameter	Yes	State variable containing the request.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

Delete Debit Reason

Function name: m3ter_DeleteDebitReason Category: WRITE HTTP method: DELETE Destination: m3ter Delete the Debit Reason with the given UUID.

Parameters

Name	Label	Type	Required	Description	Constraints
`integrationCredentialsId`	Credentials	M3terEntityParameter	Yes	The m3ter credentials to use.	m3terEntity: IntegrationCredentials, authType: M3TER_SIGNED_REQUEST
`id`	id	LookupParameter	Yes	The UUID of the Debit Reason to delete.	-
`statePath`	State Path	StateVariableParameter	No	State variable to store the response.	-

Exits

Exit	Description
`NEXT`	The API call succeeded.
`ERROR`	The API call failed. Error details are stored in the `m3shError` state variable.

​Retrieve TransactionType

​Parameters

​Exits

​Update TransactionType

​Parameters

​Exits

​Delete TransactionType

​Parameters

​Exits

​List Credit Reasons

​Parameters

​Exits

​Create Credit Reason

​Parameters

​Exits

​List Bill Grouping Keys

​Parameters

​Exits

​Create BillGroupingKey

​Parameters

​Exits

​Retrieve Currency

​Parameters

​Exits

​Update Currency

​Parameters

​Exits

​Delete Currency

​Parameters

​Exits

​List Currencies

​Parameters

​Exits

​Create Currency

​Parameters

​Exits

​List TransactionTypes

​Parameters

​Exits

​Create TransactionType

​Parameters

​Exits

​Retrieve BillGroupingKey

​Parameters

​Exits

​Update BillGroupingKey

​Parameters

​Exits

​Delete BillGroupingKey

​Parameters

​Exits

​List Debit Reasons

​Parameters

​Exits

​Create Debit Reason

​Parameters

​Exits

​Retrieve Credit Reason

​Parameters

​Exits

​Update Credit Reason

​Parameters

​Exits

​Delete Credit Reason

​Parameters

​Exits

​Retrieve Debit Reason

​Parameters

​Exits

​Update Debit Reason

​Parameters

​Exits

​Delete Debit Reason

​Parameters

​Exits

Retrieve TransactionType

Parameters

Exits

Update TransactionType

Parameters

Exits

Delete TransactionType

Parameters

Exits

List Credit Reasons

Parameters

Exits

Create Credit Reason

Parameters

Exits

List Bill Grouping Keys

Parameters

Exits

Create BillGroupingKey

Parameters

Exits

Retrieve Currency

Parameters

Exits

Update Currency

Parameters

Exits

Delete Currency

Parameters

Exits

List Currencies

Parameters

Exits

Create Currency

Parameters

Exits

List TransactionTypes

Parameters

Exits

Create TransactionType

Parameters

Exits

Retrieve BillGroupingKey

Parameters

Exits

Update BillGroupingKey

Parameters

Exits

Delete BillGroupingKey

Parameters

Exits

List Debit Reasons

Parameters

Exits

Create Debit Reason

Parameters

Exits

Retrieve Credit Reason

Parameters

Exits

Update Credit Reason

Parameters

Exits

Delete Credit Reason

Parameters

Exits

Retrieve Debit Reason

Parameters

Exits

Update Debit Reason

Parameters

Exits

Delete Debit Reason

Parameters

Exits