Gentrack Integration Resources

Gentrack Connector Reference

Configurations

Config

Parameters

NameTypeDescriptionDefault ValueRequired

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Connection

The connection types that can be provided to this configuration.

x 

Response Timeout

Number

The timeout for request to the remote service.

60

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

SECONDS

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

AUTO

 

Name

String

The identifier of this element used to reference it in other components

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Connection Types

Oauth2client Credentials Connection Provider

This is the last layer of the connection provider generation gap pattern. It is what finally gets exposed as the connection provider, including all customizations made in the refinement layer.

Parameters
NameTypeDescriptionDefault ValueRequired

Default headers

Object

 

Default query parameters

Object

 

Connection Timeout

Number

The timeout for establishing connections to the remote service

30

 

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Connection Timeout

SECONDS

 

Use Persistent Connections

Boolean

If false, each connection will be closed after the first request is completed.

true

 

Max Connections

Number

The maximum number of outbound connections that will be kept open at the same time

-1

 

Connection Idle Timeout

Number

A timeout for how long a connection can remain idle before it is closed

30

 

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the connection Idle Timeout

SECONDS

 

Stream Response

Boolean

Whether or not received responses should be streamed

false

 

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response will be stored.

-1

 

Base Uri

String

Parameter base URI, each instance/tenant gets its own

https://api.crm.{deploymentPool}.gentrack.cloud/v1

 

Proxy Config

Reusable configuration element for outbound connections through a proxy. A proxy element must define a host name and a port attributes, and optionally can define a username and a password.

 

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS

HTTP

 

TLS Configuration

 

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

 

Client Id

String

The OAuth client id as registered with the service provider

x 

Client Secret

String

The OAuth client secret as registered with the service provider

x 

Token Url

String

The service provider’s token endpoint URL

https://au.id.gentrackcloud.com/v1/token

 

Scopes

String

The OAuth scopes to be requested during the dance. If not provided, it will default to those in the annotation

 

Object Store

String

A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one.

 

Associated Operations

Operations

Create Account

<gentrack:create-account>

Creates a new billing account for an existing customer or organisation. This operation makes an HTTP POST request to the /accounts endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Account Review

<gentrack:create-account-review>

Record an account as being under review and optionally suspend billing, payments, and/or credit activities. This operation makes an HTTP POST request to the /accounts/{globalReference}/review endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Contact

<gentrack:create-contact>

Request to create new contact and it’s relationships to an existing customer account hierarchy. This operation makes an HTTP POST request to the /contacts endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Customer

<gentrack:create-customer>

Creates a customer This operation makes an HTTP POST request to the /customers endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Organisation

<gentrack:create-organisation>

Create an organisation into the backend systems This operation makes an HTTP POST request to the /organisations endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Payment Arrangement

<gentrack:create-payment-arrangement>

Record an agreed schedule payment dates and amounts that a customer will make to pay off any arrears, and cover future expenditure. This operation makes an HTTP POST request to the /accounts/{globalReference}/payment-arrangements endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Payment Method

<gentrack:create-payment-method>

Request to create a new payment method for an account. If there is an existing payment method in place it may be rejected. This operation makes an HTTP POST request to the /accounts/{globalReference}/payment-methods endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Create Refund Request

<gentrack:create-refund-request>

Initiates the process of refunding an amount to the customer. The account balance should be in credit. This operation makes an HTTP POST request to the /accounts/{globalReference}/refund-request endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Customer Sync

<gentrack:customer-sync>

Orchestration for updating customer and account hierarchy relationship details This operation makes an HTTP POST request to the /customer-sync endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Delete Contact

<gentrack:delete-contact>

Request to remove an existing contact and it’s relationships to an existing customer account hierarchy. This operation makes an HTTP PUT request to the /contacts/{globalReference}/remove endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Delete Payment Arrangement

<gentrack:delete-payment-arrangement>

Cancel the specified payment arrangement associated with an account. This operation makes an HTTP DELETE request to the /payment-arrangements/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Fix Bill

<gentrack:fix-bill>

Use this to reverse or credit note an incorrectly calculated bill. This may be due to one or more meter readings being recorded incorrectly, or estimated usage outside of the expected range. Other causes may include billing to an incorrect account holder, or billing incorrect product codes. This operation makes an HTTP POST request to the /bills/{billId}/fix endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Bill Id

String

Unique identifier for the bill ID

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Account

<gentrack:get-account>

Retrieve an account from Gentrack for checking data integrity issues. This operation makes an HTTP GET request to the /accounts/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Account Balance

<gentrack:get-account-balance>

Retrieves the current balance of an account. Pending charges and credits may not yet have been applied. This operation makes an HTTP GET request to the /accounts/{globalReference}/balance endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Account Bills

<gentrack:get-account-bills>

Returns the billing history for an account. This operation makes an HTTP GET request to the /accounts/{globalReference}/bills endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

Start Date

String

Start date for filtering

 

End Date

String

End date for filtering

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Account Review

<gentrack:get-account-review>

Checks if an account has a review in place and if billing, payments, or credit activities has been suppressed. This operation makes an HTTP GET request to the /accounts/{globalReference}/review endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Account Transactions

<gentrack:get-account-transactions>

Returns the transaction history for account showing credits and debits to the account balance. This operation makes an HTTP GET request to the /accounts/{globalReference}/financial-transactions endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

Start Date

String

Start date for filtering

 

End Date

String

End date for filtering

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Bill Image

<gentrack:get-bill-image>

Download a copy of the PDF version of a bill. This operation makes an HTTP GET request to the /bills/{billId}/image endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Bill Id

String

Unique identifier for the bill ID

x 

type

String

Type of bill statement or invoice mapped from the get account bills API

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Bill Meter Readings

<gentrack:get-bill-meter-readings>

Lists the meter readings that were included on a specific bill. This operation makes an HTTP GET request to the /bills/{billId}/meter-reads endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Bill Id

String

Unique identifier for the bill ID

x 

type

String

Type of bill statement or invoice mapped from the get account bills API

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Billing Information

<gentrack:get-billing-information>

Retrieve the last billed period, and the expected next bill date. This operation makes an HTTP GET request to the /accounts/{globalReference}/billing-information endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Contact

<gentrack:get-contact>

Request to get an existing contact details This operation makes an HTTP GET request to the /contacts/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Customer

<gentrack:get-customer>

Fetches customer details This operation makes an HTTP GET request to the /customers/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier for Customer details

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

String

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Meter Readings

<gentrack:get-meter-readings>

Retrieve the list of meter readings for a service point over a date range. This operation makes an HTTP GET request to the /service-points/{servicePointId}/meter-read-history endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Service Point Id

String

Unique identifier for the service point that holds the meter information

x 

To Date

String

The end date of the meter reading range

x 

From Date

String

The start date of the meter reading range

x 

status

String

Array of reading status strings used to filter the search of our meter readings. Can contain the following Accepted, Pending, Unknown, Removed and if left blank will default to using Accepted

 

Meter Read Status Filter

String

Meter Read status could be one of the following - Accepted, Pending, Unknown, Removed

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Meter Structure

<gentrack:get-meter-structure>

Returns a list of meters and registers along with the last meter reading for the registers. This operation makes an HTTP GET request to the /service-points/{servicePointId}/structure endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Service Point Id

String

Unique identifier for the service point that holds the meter information

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Next Payment Review

<gentrack:get-next-payment-review>

Returns when the account is next scheduled to have an automated review of their ongoing payment amount completed. This operation makes an HTTP GET request to the /accounts/{globalReference}/payment-review-date endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Organisation

<gentrack:get-organisation>

Get an organisation from the backend systems This operation makes an HTTP GET request to the /organisations/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier for the organisation

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Overdue Payments

<gentrack:get-overdue-payments>

Used when an account has an overdue balance to retrieve the aged debt as a breakdown of overdue payments This operation makes an HTTP GET request to the /accounts/{globalReference}/overdue-payments endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Payment Arrangements

<gentrack:get-payment-arrangements>

Retrieve the next payment date and amount for any scheduled payments, if the billing system only schedules the next payment then only one payment will be returned This operation makes an HTTP GET request to the /accounts/{globalReference}/payment-arrangements endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Array of Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Payment Method

<gentrack:get-payment-method>

Retrieve the method of payment that the customer has selected for an account. Only one default payment method per account is supported. This operation makes an HTTP GET request to the /accounts/{globalReference}/payment-methods endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Payment Terms

<gentrack:get-payment-terms>

Outlines when and by what method the customer is expected to provide payment on their account. This operation makes an HTTP GET request to the /accounts/{globalReference}/payment-terms endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Get Suggested Payment Amount

<gentrack:get-suggested-payment-amount>

Recommends a regular payment amount for the customer that can repay both the account balance and expected expenditure over a period of time. This operation makes an HTTP GET request to the /accounts/{globalReference}/suggested-payment-amount endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

Include Debt Balance

Boolean

Flag to consolidate open bill periods

false

 

Include Fixed Payments

Boolean

Flag to consolidate open bill periods

false

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Remove Contact Relationships

<gentrack:remove-contact-relationships>

Request to remove the link between contact and the entity it is related to on the effective date This operation makes an HTTP PUT request to the /contacts/{globalReference}/relationships/remove endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Remove Organisation Relationships

<gentrack:remove-organisation-relationships>

Removes an organisation relationships in the backend systems This operation makes an HTTP PUT request to the /organisations/{globalReference}/relationships/remove endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier for the organisation

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Submit Meter Readings

<gentrack:submit-meter-readings>

Submit meter reads after validation has taken place for them to be stored. This operation makes an HTTP POST request to the /service-points/{servicePointId}/submit-meter-reads endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Service Point Id

String

Unique identifier for the service point that holds the meter information

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Unauthorize

<gentrack:unauthorize>

Deletes all the access token information of a given resource owner id so that it’s impossible to execute any operation for that user without doing the authorization dance again

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

For Configurations

Update Account

<gentrack:update-account>

Updates the details for an existing billing account. This operation makes an HTTP PUT request to the /accounts/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Account Parent

<gentrack:update-account-parent>

Changes the parent account relationship for an account. This operation makes an HTTP PUT request to the /accounts/{globalReference}/parent endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Contact

<gentrack:update-contact>

Request to get an existing contact details This operation makes an HTTP PUT request to the /contacts/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Contact Relationships

<gentrack:update-contact-relationships>

Request to create a new contact account relationship or updates an existing relationships the contact. This operation makes an HTTP PUT request to the /contacts/{globalReference}/relationships endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Customer

<gentrack:update-customer>

Updates customer details This operation makes an HTTP PUT request to the /customers/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier for Customer details

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Next Payment Review

<gentrack:update-next-payment-review>

Change the next date that an automated payment review will be done on the account. This operation makes an HTTP PUT request to the /accounts/{globalReference}/payment-review-date endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Organisation

<gentrack:update-organisation>

Updates an organisation in the backend systems This operation makes an HTTP PUT request to the /organisations/{globalReference} endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier for the organisation

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Update Organisation Relationships

<gentrack:update-organisation-relationships>

Updates an organisation relationships in the backend systems This operation makes an HTTP PUT request to the /organisations/{globalReference}/relationships endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Global Reference

String

Unique identifier for the organisation

x 

X Transaction Id

String

The transaction identifier provided in the request.

 

X Transaction Part Number

Number

The part number that identifies which part this is of a fragmented payload.

 

X Transaction Part Total

Number

The total number of parts for the transaction.

 

X Transaction Date Time

String

A timestamp that informs the backend system the effective date of this request, used to de-duplicate requests and ensures transactions are processed in order

 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Validate Meter Readings

<gentrack:validate-meter-readings>

Validate meter reads before they are submitted. The validation response is returned and displayed to the user and they can decide on whether to submit or fix the error and revalidate. This operation makes an HTTP POST request to the /service-points/{servicePointId}/validate-meter-reads endpoint

Parameters

NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x 

Service Point Id

String

Unique identifier for the service point that holds the meter information

x 

X Trace Id

String

Identifier to trace the source of the request through different systems

 

X On Behalf Of

String

Unique identifier for the user that performed the activity that resulted in this API operation. This may be used for audit purposes. When using federated identities with single sign-on this value is expected to be sourced from the central identity provider and be the same across systems.

 

Body

Any

the content to use

#[payload]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Streaming Strategy

Configure if repeatable streams should be used and their behaviour

 

Custom Query Parameters

Object

#[null]

 

Custom Headers

Object

#[null]

 

Response Timeout

Number

The timeout for request to the remote service.

 

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit which qualifies the Response Timeout}

 

Streaming Type

String

Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content.

 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Reconnection Strategy

A retry strategy in case of connectivity errors

 

Output

Type

Any

Attributes Type

For Configurations

Throws

  • GENTRACK:BAD_REQUEST  

  • GENTRACK:CLIENT_ERROR  

  • GENTRACK:CONNECTIVITY  

  • GENTRACK:INTERNAL_SERVER_ERROR  

  • GENTRACK:NOT_ACCEPTABLE  

  • GENTRACK:NOT_FOUND  

  • GENTRACK:RETRY_EXHAUSTED  

  • GENTRACK:SERVER_ERROR  

  • GENTRACK:SERVICE_UNAVAILABLE  

  • GENTRACK:TIMEOUT  

  • GENTRACK:TOO_MANY_REQUESTS  

  • GENTRACK:UNAUTHORIZED  

  • GENTRACK:UNSUPPORTED_MEDIA_TYPE  

Types

Proxy

FieldTypeDescriptionDefault ValueRequired

Host

String

Host where the proxy requests will be sent.

x

Port

Number

Port where the proxy requests will be sent.

x

Username

String

The username to authenticate against the proxy.

x

Password

String

The password to authenticate against the proxy.

x

Non Proxy Hosts

String

A list of comma separated hosts against which the proxy should not be used

x

Tls

FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

Custom Ocsp Responder

FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

Crl File

FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

Reconnection

FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy

Reconnection Strategy

The reconnection strategy to use

Reconnect

FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Count

Number

How many reconnection attempts to make

Reconnect Forever

FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often (in ms) to reconnect

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread

Expiration Policy

FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Http Response Attributes

FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

Repeatable In Memory Stream

FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Last updated on 26 Mar 2023