User Account

The Billing Service provides access to the information required to bill customers. The billing data is based on a billing model that defines the billing codes and the metrics used to count the data for each billing code.

Add a User Account

Adds the User Account

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

object (Site)

Site this user can access (including descendents)

fullName
required
string

Full name of this user

phone
string

Phone number of this user

fax
string

Fax number of this user

email
string

Email of this user which may be comma-separated list of emails

enabled
boolean

Whether the user is enabled for login or not

externalId
string

External Id used to match to an SSO-based Account

filterParameters
string

Filter parameters to limit this users access to data, e.g. specific depositor accounts

ipRestricted
boolean

Determines whether the user can only login from some IPs

validIPAddressMask
string

If IpRestricted, the comma-separated mask for IP addresses

password
string

Password for this user, which will be encrypted on the server

passwordExpirable
boolean

Does the password expire?

passwordExpirationInterval
integer <int32>

Number of days before the password expires if it is expirable

passwordMustChange
boolean

Does the password need to be reset on the next login?

monitored
boolean

Is this account monitored for activity?

maxHearbeatIntervalSeconds
integer <int32>

For monitored accounts, the maximum seconds between activity

needsNewDevice
boolean

Set to true when this user needs a new device added.

needsSecurityQuestions
boolean

Set to true when this user needs to set their security questions.

Array of objects (Role)

Roles allowed for this user

objectType
string

Type of the object as mapped to CWObjectType

owningBusUnitId
integer <int32>

Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.

systemId
integer <int32>

System identity for this configuration object.

name
string

Unique name for this configuration object.

description
string

Description for this configuration object.

lastModifiedDate
string <date-time>

Last modification date

Array of objects (CustomConfigProperty)

Custom Properties for the Configuration Object

Responses
200

Success

403

Forbidden

412

Precondition failed

500

Internal Server Error

post/cw/useraccount/userAccount
Request samples
{
  • "authBusUnit": {
    },
  • "authSite": {
    },
  • "fullName": "John Doe",
  • "phone": "(123) 456-7890",
  • "fax": "(123) 456-7890",
  • "email": "john.doe@myco.com",
  • "enabled": "true",
  • "externalId": "string",
  • "filterParameters": "depositorAccount=123456",
  • "ipRestricted": true,
  • "validIPAddressMask": "199.142.*.*,199.158.*.*",
  • "password": "string",
  • "passwordExpirable": true,
  • "passwordExpirationInterval": "90",
  • "passwordMustChange": true,
  • "monitored": true,
  • "maxHearbeatIntervalSeconds": "600",
  • "needsNewDevice": true,
  • "needsSecurityQuestions": true,
  • "roles": [
    ],
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}

Remove or Disable a user account.

Removes or disables the User Account

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

object (Site)

Site this user can access (including descendents)

fullName
required
string

Full name of this user

phone
string

Phone number of this user

fax
string

Fax number of this user

email
string

Email of this user which may be comma-separated list of emails

enabled
boolean

Whether the user is enabled for login or not

externalId
string

External Id used to match to an SSO-based Account

filterParameters
string

Filter parameters to limit this users access to data, e.g. specific depositor accounts

ipRestricted
boolean

Determines whether the user can only login from some IPs

validIPAddressMask
string

If IpRestricted, the comma-separated mask for IP addresses

password
string

Password for this user, which will be encrypted on the server

passwordExpirable
boolean

Does the password expire?

passwordExpirationInterval
integer <int32>

Number of days before the password expires if it is expirable

passwordMustChange
boolean

Does the password need to be reset on the next login?

monitored
boolean

Is this account monitored for activity?

maxHearbeatIntervalSeconds
integer <int32>

For monitored accounts, the maximum seconds between activity

needsNewDevice
boolean

Set to true when this user needs a new device added.

needsSecurityQuestions
boolean

Set to true when this user needs to set their security questions.

Array of objects (Role)

Roles allowed for this user

objectType
string

Type of the object as mapped to CWObjectType

owningBusUnitId
integer <int32>

Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.

systemId
integer <int32>

System identity for this configuration object.

name
string

Unique name for this configuration object.

description
string

Description for this configuration object.

lastModifiedDate
string <date-time>

Last modification date

Array of objects (CustomConfigProperty)

Custom Properties for the Configuration Object

Responses
200

Success

404

Not Found

412

Precondition failed

500

Internal Server Error

delete/cw/useraccount/userAccount
Request samples
{
  • "authBusUnit": {
    },
  • "authSite": {
    },
  • "fullName": "John Doe",
  • "phone": "(123) 456-7890",
  • "fax": "(123) 456-7890",
  • "email": "john.doe@myco.com",
  • "enabled": "true",
  • "externalId": "string",
  • "filterParameters": "depositorAccount=123456",
  • "ipRestricted": true,
  • "validIPAddressMask": "199.142.*.*,199.158.*.*",
  • "password": "string",
  • "passwordExpirable": true,
  • "passwordExpirationInterval": "90",
  • "passwordMustChange": true,
  • "monitored": true,
  • "maxHearbeatIntervalSeconds": "600",
  • "needsNewDevice": true,
  • "needsSecurityQuestions": true,
  • "roles": [
    ],
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}

Update a User Account

Updates the User Account, including general information and roles

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

object (Site)

Site this user can access (including descendents)

fullName
required
string

Full name of this user

phone
string

Phone number of this user

fax
string

Fax number of this user

email
string

Email of this user which may be comma-separated list of emails

enabled
boolean

Whether the user is enabled for login or not

externalId
string

External Id used to match to an SSO-based Account

filterParameters
string

Filter parameters to limit this users access to data, e.g. specific depositor accounts

ipRestricted
boolean

Determines whether the user can only login from some IPs

validIPAddressMask
string

If IpRestricted, the comma-separated mask for IP addresses

password
string

Password for this user, which will be encrypted on the server

passwordExpirable
boolean

Does the password expire?

passwordExpirationInterval
integer <int32>

Number of days before the password expires if it is expirable

passwordMustChange
boolean

Does the password need to be reset on the next login?

monitored
boolean

Is this account monitored for activity?

maxHearbeatIntervalSeconds
integer <int32>

For monitored accounts, the maximum seconds between activity

needsNewDevice
boolean

Set to true when this user needs a new device added.

needsSecurityQuestions
boolean

Set to true when this user needs to set their security questions.

Array of objects (Role)

Roles allowed for this user

objectType
string

Type of the object as mapped to CWObjectType

owningBusUnitId
integer <int32>

Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.

systemId
integer <int32>

System identity for this configuration object.

name
string

Unique name for this configuration object.

description
string

Description for this configuration object.

lastModifiedDate
string <date-time>

Last modification date

Array of objects (CustomConfigProperty)

Custom Properties for the Configuration Object

Responses
200

Success

403

Forbidden

404

Not Found

412

Precondition failed

500

Internal Server Error

put/cw/useraccount/userAccount
Request samples
{
  • "authBusUnit": {
    },
  • "authSite": {
    },
  • "fullName": "John Doe",
  • "phone": "(123) 456-7890",
  • "fax": "(123) 456-7890",
  • "email": "john.doe@myco.com",
  • "enabled": "true",
  • "externalId": "string",
  • "filterParameters": "depositorAccount=123456",
  • "ipRestricted": true,
  • "validIPAddressMask": "199.142.*.*,199.158.*.*",
  • "password": "string",
  • "passwordExpirable": true,
  • "passwordExpirationInterval": "90",
  • "passwordMustChange": true,
  • "monitored": true,
  • "maxHearbeatIntervalSeconds": "600",
  • "needsNewDevice": true,
  • "needsSecurityQuestions": true,
  • "roles": [
    ],
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}

Get User Accounts

Retrieves the user account with the given name. Returns the APIUser

SecurityJWT
Request
path Parameters
accountName
required
string
Responses
200

Success

404

Not Found

500

Internal Server Error

get/cw/useraccount/userAccount/{accountName}
Request samples 
Response samples 
{
  • "authBusUnit": {
    },
  • "authSite": {
    },
  • "fullName": "John Doe",
  • "phone": "(123) 456-7890",
  • "fax": "(123) 456-7890",
  • "email": "john.doe@myco.com",
  • "enabled": "true",
  • "externalId": "string",
  • "filterParameters": "depositorAccount=123456",
  • "ipRestricted": true,
  • "validIPAddressMask": "199.142.*.*,199.158.*.*",
  • "password": "string",
  • "passwordExpirable": true,
  • "passwordExpirationInterval": "90",
  • "passwordMustChange": true,
  • "monitored": true,
  • "maxHearbeatIntervalSeconds": "600",
  • "needsNewDevice": true,
  • "needsSecurityQuestions": true,
  • "roles": [
    ],
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
List Roles
Retrieves the roles for the given criteria. Rows are of type APIRole


SecurityJWT 
Request 
Request Body schema: 
billerBusUnitId
string
billerBusUnitId


 
object
Business Unit


 
busUnitName
string
busUnitName


 
externalBusUnitId
string
externalBusUnitId


 
object
Last Modified Date


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Sort Order


 
Responses 
200
Success


500
Internal Server Error


post/cw/useraccount/listRoles
Request samples 
{
  • "billerBusUnitId": "string",
  • "busUnitId": {
    },
  • "busUnitName": "string",
  • "externalBusUnitId": "string",
  • "lastModifiedDate": {
    },
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string"
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
List User Accounts
Retrieves the user account for the given criteria. Rows are of type APIUser


SecurityJWT 
Request 
Request Body schema: 
object
Account Login


 
adminBuId
integer <int32> 
Administrative Business Unit


 
object
Authorized Business unit


 
object
Authorized Site


 
billerBusUnitId
string
billerBusUnitId


 
busUnitId
integer <int32> 
busUnitId


 
busUnitName
string
busUnitName


 
enabled
boolean
Enabled


 
externalBusUnitId
string
externalBusUnitId


 
object
Last Modified Date


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Sort Order


 
object
User Full Name


 
Responses 
200
Success


500
Internal Server Error


post/cw/useraccount/listUserAccounts
Request samples 
{
  • "account": {
    },
  • "adminBuId": 0,
  • "authBuId": {
    },
  • "authSiteId": {
    },
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "enabled": true,
  • "externalBusUnitId": "string",
  • "lastModifiedDate": {
    },
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "userName": {
    }
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get billing data
Fetch the billing count for all billers of a given client


SecurityJWT 
Request 
Request Body schema: 
billerBusUnitId
string
Biller ID of the business unit


 
busUnitId
integer <int32> 
ID of the business Unit


 
object
Business Unit Name


 
externalBusUnitId
string
External ID of the business unit


 
objectId
integer <int32> 
Business Unit Id


 
Responses 
200
Success


500
Internal Server Error


get/cw/billing/billingData
Request samples 
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": {
    },
  • "externalBusUnitId": "string",
  • "objectId": 0
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get billing clients
Fetch all the billing clients with related business unit details


SecurityJWT 
Request 
Request Body schema: 
billerBusUnitId
string
Biller ID of the business unit


 
busUnitId
integer <int32> 
ID of the business Unit


 
object
Business Unit Name


 
externalBusUnitId
string
External ID of the business unit


 
objectId
integer <int32> 
Business Unit Id


 
Responses 
200
Success


500
Internal Server Error


get/cw/billing/clients
Request samples 
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": {
    },
  • "externalBusUnitId": "string",
  • "objectId": 0
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
➔ Next to Webhooks