Stored Value Service

Creates and manages stores and prepaid registers to enable customers to fund a register and then draw down on the balance through usage consumption.

For more information, please search through the Gotransverse online documentation:

Terms of Service: Public use
Request Content-Types: application/json
Response Content-Types: application/json
Version: 2.16.0.1

Authentication

api_key_header

An authorization key that is assigned to perform an action in the system. Passed in the form of a X-Api-Key header that is attached to the call. e.g 325509ed604449279d4587c5e35e3235

type
apiKey
name
X-Api-Key
in
header

Store Management

GET /store

Gets a list of stores within the stored value service.

page_size: integer
in query

The page size for the listing. Defaults to 25, maximum value of 100

page_number: integer
in query

The page number for the listing. Defaults to 1.

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "name": "string",
    "description": "string",
    "tenant_id": "integer (int64)",
    "external_customer_name": "string",
    "external_environment_id": "string",
    "enable_backdate": "boolean"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store

Creates a new store within the stored value service

undefined

Request Content-Types: application/json
Request Example
{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "tenant_id": "integer (int64)",
  "external_customer_name": "string",
  "external_environment_id": "string",
  "enable_backdate": "boolean"
}

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "tenant_id": "integer (int64)",
  "external_customer_name": "string",
  "external_environment_id": "string",
  "enable_backdate": "boolean"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}

Retrieves a store by its uuid

store-id: string
in path

The uuid for the store

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "tenant_id": "integer (int64)",
  "external_customer_name": "string",
  "external_environment_id": "string",
  "enable_backdate": "boolean"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /store/{store-id}

Updates a store

undefined

store-id: string
in path

The uuid for the store

Request Content-Types: application/json
Request Example
{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "tenant_id": "integer (int64)",
  "external_customer_name": "string",
  "external_environment_id": "string",
  "enable_backdate": "boolean"
}

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "tenant_id": "integer (int64)",
  "external_customer_name": "string",
  "external_environment_id": "string",
  "enable_backdate": "boolean"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

DELETE /store/{store-id}

Deletes a store by its uuid

store-id: string
in path

The uuid for the store

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "level": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

Store Configuration Management

POST /store/{store-id}/config

Creates a store configuration

KeyValue
store-id: string
in path

The uuid for the store

Request Content-Types: application/json
Request Example
[
  {
    "key": "string",
    "value": "string"
  }
]
200 OK

Success

type
401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "key": "string",
    "value": "string"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/config

Retrieves a store configuration by store uuid

store-id: string
in path

The uuid for the store

200 OK

Success

type
401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "key": "string",
    "value": "string"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /store/{store-id}/config

Updates existing store configuration

KeyValue
store-id: string
in path

The uuid for the store

Request Content-Types: application/json
Request Example
[
  {
    "key": "string",
    "value": "string"
  }
]
200 OK

Success

type
401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "key": "string",
    "value": "string"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/config/{key-id}

Retrieves a key-value pair from store configuration by store uuid and key

store-id: string
in path

The uuid for the store

key-id: string
in path

The key from store configuration

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "key": "string",
  "value": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

DELETE /store/{store-id}/config/{key-id}

Deletes existing store key-value pair from store configuration

store-id: string
in path

The uuid for the store

key-id: string
in path

The key from store configuration

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "level": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Store History

GET /store/{store-id}/history

Retrieves a store's history by its uuid

store-id: string
in path

The uuid for the store

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "entity_id": "integer (int64)",
    "entity_type": "string",
    "event_date": "string (date-time)",
    "change_type": "string",
    "description": "string",
    "user_name": "string"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/history

Retrieves a register's history by its uuid

store-id: string
in path

The uuid for the store

register-id: string
in path

The uuid for the register

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "entity_id": "integer (int64)",
    "entity_type": "string",
    "event_date": "string (date-time)",
    "change_type": "string",
    "description": "string",
    "user_name": "string"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

Register Management

GET /store/{store-id}/transaction-date-range

Gets the earliest transaction date (contribution or consumption) on a store

store-id: string
in path

The uuid for the store

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "min_transaction_date": "string (date-time)",
  "max_transaction_date": "string (date-time)"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/test-connection

Tests a connection to the stored value server

store-id: string
in path

The uuid for the store

200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register

Creates a new balance register

store-id: string
in path

The uuid of the store that is creating the register.

Request Content-Types: application/json
Request Example
{
  "uuid": "string",
  "name": "string",
  "granted_unit_of_measure": "string",
  "currency": "string",
  "description": "string",
  "external_account_id": "string",
  "external_account_number": "string",
  "external_account_name": "string",
  "external_company_name": "string",
  "external_category": "string",
  "overdraft_amount": "number",
  "auto_contribution_enabled": "boolean",
  "auto_contribution_threshold": "number",
  "auto_contribution_amount": "number",
  "auto_contribution_granted_value": "number",
  "auto_contribution_product_eid": "integer (int64)",
  "balance_level_yellow": "number",
  "balance_level_orange": "number",
  "balance_level_red": "number",
  "register_type": "string",
  "timezone_name": "string"
}

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "name": "string",
  "granted_unit_of_measure": "string",
  "currency": "string",
  "description": "string",
  "external_account_id": "string",
  "external_account_number": "string",
  "external_account_name": "string",
  "external_company_name": "string",
  "external_category": "string",
  "overdraft_amount": "number",
  "auto_contribution_enabled": "boolean",
  "auto_contribution_threshold": "number",
  "auto_contribution_amount": "number",
  "auto_contribution_granted_value": "number",
  "auto_contribution_product_eid": "integer (int64)",
  "balance_level_yellow": "number",
  "balance_level_orange": "number",
  "balance_level_red": "number",
  "register_type": "string",
  "timezone_name": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}

Retrieves a stored value register

store-id: string
in path

The uuid of the store that owns the register.

register-id: string
in path

The uuid of the register being retrieved

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "name": "string",
  "granted_unit_of_measure": "string",
  "currency": "string",
  "description": "string",
  "external_account_id": "string",
  "external_account_number": "string",
  "external_account_name": "string",
  "external_company_name": "string",
  "external_category": "string",
  "overdraft_amount": "number",
  "auto_contribution_enabled": "boolean",
  "auto_contribution_threshold": "number",
  "auto_contribution_amount": "number",
  "auto_contribution_granted_value": "number",
  "auto_contribution_product_eid": "integer (int64)",
  "balance_level_yellow": "number",
  "balance_level_orange": "number",
  "balance_level_red": "number",
  "register_type": "string",
  "timezone_name": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /store/{store-id}/register/{register-id}

Updates a balance register

store-id: string
in path

The uuid of the store that is updating the register.

register-id: string
in path

The uuid of the register being updated

Request Content-Types: application/json
Request Example
{
  "uuid": "string",
  "name": "string",
  "granted_unit_of_measure": "string",
  "currency": "string",
  "description": "string",
  "external_account_id": "string",
  "external_account_number": "string",
  "external_account_name": "string",
  "external_company_name": "string",
  "external_category": "string",
  "overdraft_amount": "number",
  "auto_contribution_enabled": "boolean",
  "auto_contribution_threshold": "number",
  "auto_contribution_amount": "number",
  "auto_contribution_granted_value": "number",
  "auto_contribution_product_eid": "integer (int64)",
  "balance_level_yellow": "number",
  "balance_level_orange": "number",
  "balance_level_red": "number",
  "register_type": "string",
  "timezone_name": "string"
}

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "name": "string",
  "granted_unit_of_measure": "string",
  "currency": "string",
  "description": "string",
  "external_account_id": "string",
  "external_account_number": "string",
  "external_account_name": "string",
  "external_company_name": "string",
  "external_category": "string",
  "overdraft_amount": "number",
  "auto_contribution_enabled": "boolean",
  "auto_contribution_threshold": "number",
  "auto_contribution_amount": "number",
  "auto_contribution_granted_value": "number",
  "auto_contribution_product_eid": "integer (int64)",
  "balance_level_yellow": "number",
  "balance_level_orange": "number",
  "balance_level_red": "number",
  "register_type": "string",
  "timezone_name": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/external-account-id/{external-id}

Gets list of stored value registers by external account id and register type

store-id: string
in path

The uuid of the store that owns the register.

external-id: string
in path

The external account id associated with the register

register_type: string
in query

The register type filtering parameter

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "name": "string",
    "granted_unit_of_measure": "string",
    "currency": "string",
    "description": "string",
    "external_account_id": "string",
    "external_account_number": "string",
    "external_account_name": "string",
    "external_company_name": "string",
    "external_category": "string",
    "overdraft_amount": "number",
    "auto_contribution_enabled": "boolean",
    "auto_contribution_threshold": "number",
    "auto_contribution_amount": "number",
    "auto_contribution_granted_value": "number",
    "auto_contribution_product_eid": "integer (int64)",
    "balance_level_yellow": "number",
    "balance_level_orange": "number",
    "balance_level_red": "number",
    "register_type": "string",
    "timezone_name": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/external-account-id/{external-id}/register-type/{register-type}

Gets list of stored value registers by external account id and register type

store-id: string
in path

The uuid of the store that owns the register.

external-id: string
in path

The external account id associated with the register

register-type: string
in path

The register type

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "name": "string",
    "granted_unit_of_measure": "string",
    "currency": "string",
    "description": "string",
    "external_account_id": "string",
    "external_account_number": "string",
    "external_account_name": "string",
    "external_company_name": "string",
    "external_category": "string",
    "overdraft_amount": "number",
    "auto_contribution_enabled": "boolean",
    "auto_contribution_threshold": "number",
    "auto_contribution_amount": "number",
    "auto_contribution_granted_value": "number",
    "auto_contribution_product_eid": "integer (int64)",
    "balance_level_yellow": "number",
    "balance_level_orange": "number",
    "balance_level_red": "number",
    "register_type": "string",
    "timezone_name": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/external-account-number/{external-number}/register-type/{register-type}

Gets list of stored value registers by external account id and register type

store-id: string
in path

The uuid of the store that owns the register.

external-number: string
in path

The external account number associated with the register

register-type: string
in path

The register type

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "name": "string",
    "granted_unit_of_measure": "string",
    "currency": "string",
    "description": "string",
    "external_account_id": "string",
    "external_account_number": "string",
    "external_account_name": "string",
    "external_company_name": "string",
    "external_category": "string",
    "overdraft_amount": "number",
    "auto_contribution_enabled": "boolean",
    "auto_contribution_threshold": "number",
    "auto_contribution_amount": "number",
    "auto_contribution_granted_value": "number",
    "auto_contribution_product_eid": "integer (int64)",
    "balance_level_yellow": "number",
    "balance_level_orange": "number",
    "balance_level_red": "number",
    "register_type": "string",
    "timezone_name": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/external-account-number/{external-number}/balance

Gets the current balance of one or more registers by external account number

store-id: string
in path

The uuid of the store that owns the register.

external-number: string
in path

The external account id associated with the register

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "register": {
      "uuid": "string",
      "name": "string",
      "granted_unit_of_measure": "string",
      "currency": "string",
      "description": "string",
      "external_account_id": "string",
      "external_account_number": "string",
      "external_account_name": "string",
      "external_company_name": "string",
      "external_category": "string",
      "overdraft_amount": "number",
      "auto_contribution_enabled": "boolean",
      "auto_contribution_threshold": "number",
      "auto_contribution_amount": "number",
      "auto_contribution_granted_value": "number",
      "auto_contribution_product_eid": "integer (int64)",
      "balance_level_yellow": "number",
      "balance_level_orange": "number",
      "balance_level_red": "number",
      "register_type": "string",
      "timezone_name": "string"
    },
    "register_category": "string",
    "balance_amount": "number",
    "balance_count": "integer (int32)",
    "balance_level": "string",
    "consumption_balance_amount": "number",
    "consumption_balance_count": "integer (int32)",
    "contribution_balance_amount": "number",
    "contribution_balance_count": "integer (int32)",
    "max_effective_date": "string (date-time)"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/external-account-id/{external-id}/balance

Gets the current balance of one or more registers by external account id

store-id: string
in path

The uuid of the store that owns the register.

external-id: string
in path

The external account id associated with the register

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "register": {
      "uuid": "string",
      "name": "string",
      "granted_unit_of_measure": "string",
      "currency": "string",
      "description": "string",
      "external_account_id": "string",
      "external_account_number": "string",
      "external_account_name": "string",
      "external_company_name": "string",
      "external_category": "string",
      "overdraft_amount": "number",
      "auto_contribution_enabled": "boolean",
      "auto_contribution_threshold": "number",
      "auto_contribution_amount": "number",
      "auto_contribution_granted_value": "number",
      "auto_contribution_product_eid": "integer (int64)",
      "balance_level_yellow": "number",
      "balance_level_orange": "number",
      "balance_level_red": "number",
      "register_type": "string",
      "timezone_name": "string"
    },
    "register_category": "string",
    "balance_amount": "number",
    "balance_count": "integer (int32)",
    "balance_level": "string",
    "consumption_balance_amount": "number",
    "consumption_balance_count": "integer (int32)",
    "contribution_balance_amount": "number",
    "contribution_balance_count": "integer (int32)",
    "max_effective_date": "string (date-time)"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/balance

Gets the current balance of a register

store-id: string
in path

The uuid of the store that owns the register.

register-id: string
in path

The uuid of the register

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "register": {
    "uuid": "string",
    "name": "string",
    "granted_unit_of_measure": "string",
    "currency": "string",
    "description": "string",
    "external_account_id": "string",
    "external_account_number": "string",
    "external_account_name": "string",
    "external_company_name": "string",
    "external_category": "string",
    "overdraft_amount": "number",
    "auto_contribution_enabled": "boolean",
    "auto_contribution_threshold": "number",
    "auto_contribution_amount": "number",
    "auto_contribution_granted_value": "number",
    "auto_contribution_product_eid": "integer (int64)",
    "balance_level_yellow": "number",
    "balance_level_orange": "number",
    "balance_level_red": "number",
    "register_type": "string",
    "timezone_name": "string"
  },
  "register_category": "string",
  "balance_amount": "number",
  "balance_count": "integer (int32)",
  "balance_level": "string",
  "consumption_balance_amount": "number",
  "consumption_balance_count": "integer (int32)",
  "contribution_balance_amount": "number",
  "contribution_balance_count": "integer (int32)",
  "max_effective_date": "string (date-time)"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/contribute

Adds one or more contribution transactions to a register

The contribution transactions to post to the register

StoredValueContribution
store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

Request Content-Types: application/json
Request Example
[
  {
    "order_granted_value": "number",
    "ordered_amount": "number",
    "list_granted_value": "number",
    "list_amount": "number",
    "source_id": "string",
    "source_type": "string",
    "source_description": "string",
    "effective_date": "string (date-time)",
    "expire_date": "string (date-time)"
  }
]
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/consume

Adds one or more consumption transactions to a register

The consumption transactions to post to the register

StoredValueConsumption
store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

Request Content-Types: application/json
Request Example
[
  {
    "consumed_value": "number",
    "source_id": "string",
    "source_type": "string",
    "source_description": "string",
    "source_category": "string",
    "effective_date": "string (date-time)",
    "external_id": "string"
  }
]
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/negative-contribution

Sends a negative contribution request to SVS.

The negative contribution transactions to post to the register

StoredValueContribution
store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

Request Content-Types: application/json
Request Example
[
  {
    "order_granted_value": "number",
    "ordered_amount": "number",
    "list_granted_value": "number",
    "list_amount": "number",
    "source_id": "string",
    "source_type": "string",
    "source_description": "string",
    "effective_date": "string (date-time)",
    "expire_date": "string (date-time)"
  }
]
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

412 Precondition Failed

Precondition failure

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "level": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/validate-contribution

Sends validate contribution request to SVS.

The contribution transactions to validate

StoredValueContribution
store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

Request Content-Types: application/json
Request Example
[
  {
    "order_granted_value": "number",
    "ordered_amount": "number",
    "list_granted_value": "number",
    "list_amount": "number",
    "source_id": "string",
    "source_type": "string",
    "source_description": "string",
    "effective_date": "string (date-time)",
    "expire_date": "string (date-time)"
  }
]
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

412 Precondition Failed

Precondition failure

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "level": "string",
  "message": "string"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (412 Precondition Failed)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/allocate

Forces an allocation on a register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

X-Limit: int64 5000
in header

Amount of reccords for processing in one batch during allocation. Defaults to 5000.

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "register": {
    "uuid": "string",
    "name": "string",
    "granted_unit_of_measure": "string",
    "currency": "string",
    "description": "string",
    "external_account_id": "string",
    "external_account_number": "string",
    "external_account_name": "string",
    "external_company_name": "string",
    "external_category": "string",
    "overdraft_amount": "number",
    "auto_contribution_enabled": "boolean",
    "auto_contribution_threshold": "number",
    "auto_contribution_amount": "number",
    "auto_contribution_granted_value": "number",
    "auto_contribution_product_eid": "integer (int64)",
    "balance_level_yellow": "number",
    "balance_level_orange": "number",
    "balance_level_red": "number",
    "register_type": "string",
    "timezone_name": "string"
  },
  "register_category": "string",
  "balance_amount": "number",
  "balance_count": "integer (int32)",
  "balance_level": "string",
  "consumption_balance_amount": "number",
  "consumption_balance_count": "integer (int32)",
  "contribution_balance_amount": "number",
  "contribution_balance_count": "integer (int32)",
  "max_effective_date": "string (date-time)"
}
Response Headers (200 OK)
X-Processed-Reccords

Count of processed records during allocation.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/transactions

Gets a paged, filtered, sorted list of transactions for a register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

sort: string txn_id, txn_date, source_type, source_id txn_id
in query

The sort field to sort on

sort_direction: string asc, desc desc
in query

The direction of the sort

txn_id: integer (int64)
in query

The txn_id to filter on

txn_date: string (date-time)
in query

A date to filter on

txn_source_id: string
in query

A source id to filter on

txn_source_type: string
in query

The source_type of the transaction.

txn_direction: string CONTRIBUTION, CONSUMPTION
in query

The direction of the transaction.

page_size: integer
in query

The page size for the listing. Defaults to 25, maximum value of 100

page_number: integer
in query

The page number for the listing. Defaults to 1.

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "amount": "number",
    "direction": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/daily-transactions

Gets a paged, filtered, sorted list of aggregated daily transactions for a register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

page_size: integer
in query

The page size for the listing. Defaults to 25, maximum value of 100

page_number: integer
in query

The page number for the listing. Defaults to 1.

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "total_amount": "number",
    "register_uom": "string",
    "currency": "string",
    "direction": "string",
    "count": "integer (int64)",
    "year": "integer (int32)",
    "month": "integer (int32)",
    "day": "integer (int32)",
    "timezone_offset": "string"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/auto-contributions

Adds one or more auto-contribution transactions to a register

The auto contribution transactions to post to the register

AutoContribution
store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

Request Content-Types: application/json
Request Example
[
  {
    "uuid": "string",
    "amount": "number"
  }
]
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/auto-contributions

Gets a paged, filtered, sorted list of auto contribution transactions for a register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

sort: string auto_contribution_id auto_contribution_id
in query

The sort field to sort on

sort_direction: string asc, desc asc
in query

The direction of the sort

page_size: integer
in query

The page size for the listing. Defaults to 25, maximum value of 100

page_number: integer
in query

The page number for the listing. Defaults to 1.

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "amount": "number"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

POST /store/{store-id}/register/{register-id}/auto-contribution/{auto-contribution-id}/status

Adds a new status to an auto contribution transaction

The auto contribution status to post to the auto contribution

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

auto-contribution-id: string
in path

The uuid of the auto contribution

Request Content-Types: application/json
Request Example
{
  "uuid": "string",
  "status": "string",
  "status_date": "string (date-time)",
  "status_details": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
200 OK

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/auto-contribution/{auto-contribution-id}

Gets an auto contribution transaction with statuses for specified store and register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

auto-contribution-id: string
in path

The uuid of the auto contribution

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "uuid": "string",
  "amount": "number",
  "statuses": [
    {
      "uuid": "string",
      "status": "string",
      "status_date": "string (date-time)",
      "status_details": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register-balance-lag

Retrieves the current balance lag for all registers in a given store

store-id: string
in path

The uuid for the store

page_number: integer x ≥ 1 1
in query

Find records from this page of results, using the page_size to define the size of the pages.

page_size: integer 1 ≤ x ≤ 500 500
in query

The number of results per page to return (max 500)

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "uuid": "string",
    "name": "string",
    "max_contribution_date": "string (date-time)",
    "max_consumption_date": "string (date-time)",
    "max_balance_date": "string (date-time)",
    "age_seconds": "number"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/expiring-contributions

Gets a paged, filtered, sorted list of expiring contributions for a register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

sort: string expiring_date, remaining_balance, contribution_date expiring_date
in query

The sort field to sort on

sort_direction: string asc, desc asc
in query

The direction of the sort

expired: boolean
in query

Filter for either expired contribution or not

remaining_balance_gt: number
in query

Filter for remaining balance greater than specified value

page_size: integer
in query

The page size for the listing. Defaults to 25, maximum value of 100

page_number: integer
in query

The page number for the listing. Defaults to 1.

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "order_granted_value": "number",
    "ordered_amount": "number",
    "list_granted_value": "number",
    "list_amount": "number",
    "source_id": "string",
    "source_type": "string",
    "source_description": "string",
    "expire_date": "string (date-time)",
    "contribution_date": "string (date-time)",
    "balance_remaining": "number"
  }
]
Response Headers (200 OK)
X-Total-Count

The total results for the particular query. Used to drive paging requests.

integer (int64)
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/register/{register-id}/expiring-contributions/{contribution-id}

Gets an expiring contribution transaction for specified store and register

store-id: string
in path

The uuid of the store that owns the register

register-id: string
in path

The uuid of the register

contribution-id: string
in path

The id of the expiring contribution

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "order_granted_value": "number",
  "ordered_amount": "number",
  "list_granted_value": "number",
  "list_amount": "number",
  "source_id": "string",
  "source_type": "string",
  "source_description": "string",
  "expire_date": "string (date-time)",
  "contribution_date": "string (date-time)",
  "balance_remaining": "number"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

PUT /store/{store-id}/register/{register-id}/expiring-contributions/{contribution-id}

Updates an expiring contribution transaction

store-id: string
in path

The uuid of the store.

register-id: string
in path

The uuid of the register

contribution-id: string
in path

The id of the expiring contribution being updated

Request Content-Types: application/json
Request Example
{
  "expire_date": "string (date-time)"
}

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "order_granted_value": "number",
  "ordered_amount": "number",
  "list_granted_value": "number",
  "list_amount": "number",
  "source_id": "string",
  "source_type": "string",
  "source_description": "string",
  "expire_date": "string (date-time)",
  "contribution_date": "string (date-time)",
  "balance_remaining": "number"
}
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Data Export

GET /store/{store-id}/registers/export/daily-consumptions-by-source

Retrieves a list of daily weighted consumptions for a given store

store-id: string
in path

The uuid for the store

time_zone: string Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/North, Australia/NSW, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/East-Saskatchewan, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, CET, Chile/Continental, Chile/EasterIsland, CST6CDT, Cuba, EET, Egypt, Eire, EST, EST5EDT, Etc/GMT, Etc/Greenwich, Etc/UCT, Etc/Universal, Etc/UTC, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT0, Greenwich, Hongkong, HST, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, MST, MST7MDT, Navajo, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, PRC, PST8PDT, ROC, ROK, Singapore, Turkey, UCT, Universal, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, W-SU, WET, Zulu
in query

The name of the timezone.

from_date: string (date)
in query

The from date to export in YYYY-MM-DD format

to_date: string (date)
in query

The to date to export in YYYY-MM-DD format

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "allocation_type": "string",
    "register_id": "integer (int64)",
    "register_type": "string",
    "register_currency": "string",
    "register_uom": "string",
    "register_account_id": "integer (int64)",
    "register_account_number": "string",
    "source_id": "string",
    "source_type": "string",
    "source_category": "string",
    "daily_consumption_value": "number",
    "daily_weighted_order_consumption_amount": "number",
    "daily_weighted_list_consumption_amount": "number",
    "daily_consumption_count": "integer (int64)",
    "as_of_date": "string (date-time)"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/registers/export/daily-consumption-balances-by-source

Retrieves daily register consumption balances as of date midnight on a given date

store-id: string
in path

The uuid for the store

time_zone: string Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/North, Australia/NSW, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/East-Saskatchewan, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, CET, Chile/Continental, Chile/EasterIsland, CST6CDT, Cuba, EET, Egypt, Eire, EST, EST5EDT, Etc/GMT, Etc/Greenwich, Etc/UCT, Etc/Universal, Etc/UTC, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT0, Greenwich, Hongkong, HST, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, MST, MST7MDT, Navajo, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, PRC, PST8PDT, ROC, ROK, Singapore, Turkey, UCT, Universal, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, W-SU, WET, Zulu
in query

The name of the timezone.

as_of_date: string (date)
in query

The as of date to return records for. YYYY-MM-DD format

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "allocation_type": "string",
    "register_id": "integer (int64)",
    "register_type": "string",
    "register_currency": "string",
    "register_uom": "string",
    "register_account_id": "integer (int64)",
    "register_account_number": "string",
    "register_category": "string",
    "source_id": "string",
    "source_type": "string",
    "source_category": "string",
    "balance_amount": "number",
    "balance_count": "integer (int32)",
    "as_of_date": "string (date-time)"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

GET /store/{store-id}/registers/export/daily-balances

Retrieves balances by register as of a given date

store-id: string
in path

The uuid for the store

time_zone: string Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/North, Australia/NSW, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/East-Saskatchewan, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, CET, Chile/Continental, Chile/EasterIsland, CST6CDT, Cuba, EET, Egypt, Eire, EST, EST5EDT, Etc/GMT, Etc/Greenwich, Etc/UCT, Etc/Universal, Etc/UTC, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT0, Greenwich, Hongkong, HST, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, MST, MST7MDT, Navajo, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, PRC, PST8PDT, ROC, ROK, Singapore, Turkey, UCT, Universal, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, W-SU, WET, Zulu
in query

The name of the timezone.

as_of_date: string (date)
in query

The as of date to return records for. YYYY-MM-DD format

Success

401 Unauthorized

Authentication failed

403 Forbidden

Access denied

404 Not Found

Entity not found

422 Unprocessable Entity

Validation failure

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "uuid": "string",
    "register_id": "integer (int64)",
    "register_type": "string",
    "register_currency": "string",
    "register_uom": "string",
    "register_account_id": "integer (int64)",
    "register_account_number": "string",
    "register_category": "string",
    "balance_amount": "number",
    "balance_count": "integer (int32)",
    "consumption_balance_amount": "number",
    "consumption_balance_count": "integer (int32)",
    "contribution_balance_amount": "number",
    "contribution_balance_count": "integer (int32)",
    "unallocated_consumption_balance_amount": "number",
    "as_of_date": "string (date-time)"
  }
]
Response Example (401 Unauthorized)
{
  "code": "string",
  "message": "string"
}
Response Example (403 Forbidden)
{
  "code": "string",
  "message": "string"
}
Response Example (404 Not Found)
{
  "code": "string",
  "message": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "string",
  "message": "string"
}

Schema Definitions

StoredValueStore: object

uuid: string

The globally unique identifier for the store. Can be generated external to the service. If not sent in, a uuid will be generated and returned.

name: string

An optional name for this store.

description: string

An optional description for this store.

tenant_id: integer (int64)

An external id for this store. If used with TRACT, this is the tenant_id of the associated customer.

external_customer_name: string

An external customer name for this store. If used within TRACT, this is the customer name used for global configuration.

external_environment_id: string

An external environment id for this store. If used within TRACT, this is the environment uuid used for global configuration.

enable_backdate: boolean

A flag to indicate that effective_date should be used to set created_on dates. Do not enable this setting unless you know what you are doing.

Example
{
  "uuid": "string",
  "name": "string",
  "description": "string",
  "tenant_id": "integer (int64)",
  "external_customer_name": "string",
  "external_environment_id": "string",
  "enable_backdate": "boolean"
}

Error: object

code: string

A code for the specific error. Used to help in determining possible root causes of an error.

message: string

A message providing additional detail for an error.

Example
{
  "code": "string",
  "message": "string"
}

Message: object

level: string INFO, WARN, DEBUG

A level for the specific message.

message: string

A message providing additional detail for message.

Example
{
  "level": "string",
  "message": "string"
}

KeyValue: object

A simple key-value pair.

key: string

A unique key for this pair.

value: string

A value for this pair.

Example
{
  "key": "string",
  "value": "string"
}

StoredValueAuditEvent: object

An audit record of an event within the system indicating that something has happened to an underlying entity.

id: integer (int64)

The id of the audit event. Auto-generated by system on creation of event.

entity_id: integer (int64)

The id of the entity being changed.

entity_type: string STORE, BRAND, REGISTER

An indicator of what type of entity group was affected by the event.

  • STORE - An entity within the Store management function was affected
  • BRAND - An entity within the Brand management function was affected
  • REGISTER - An entity within the Register management function was affected
event_date: string (date-time)

The time the event occurred.

change_type: string INSERT, UPDATE, DELETE

The type of change performed on the entity.

description: string

A description of what is getting changed.

user_name: string

The name of the user making the change.

Example
{
  "id": "integer (int64)",
  "entity_id": "integer (int64)",
  "entity_type": "string",
  "event_date": "string (date-time)",
  "change_type": "string",
  "description": "string",
  "user_name": "string"
}

StoreDateRange: object

min_transaction_date: string (date-time)
max_transaction_date: string (date-time)
Example
{
  "min_transaction_date": "string (date-time)",
  "max_transaction_date": "string (date-time)"
}

ExportRegisterWeightedConsumptionBySource: object

A flattened record for a register's weighted consumption amounts for a given day by source

uuid: string

A unique identifier for this record.

allocation_type: string allocated, unallocated
register_id: integer (int64)

The internal register id for the register.

register_type: string

The register type per the initial register setup.

register_currency: CurrencyEnum
register_uom: string

The register's unit of measure

register_account_id: integer (int64)

The register's external account id.

register_account_number: string

The register's external account number.

source_id: string

The service_id that is consuming from the balance.

source_type: string

The type of transaction consuming from the balance.

source_category: string

The category of the transaction consuming from the balance.

daily_consumption_value: number

The total value of consumptions for the register for the day

daily_weighted_order_consumption_amount: number

The total weighted conumption based upon the orderd amount of the contributions consumed against.

daily_weighted_list_consumption_amount: number

The total weighted consumption based upon the listed amount of the contributions consumed against.

daily_consumption_count: integer (int64)

The total count of consumptions for the register for the day.

as_of_date: string (date-time)

The allocation date based upon the business entity's timezone in YYYY-MM-DD format.

Example
{
  "uuid": "string",
  "allocation_type": "string",
  "register_id": "integer (int64)",
  "register_type": "string",
  "register_currency": "string",
  "register_uom": "string",
  "register_account_id": "integer (int64)",
  "register_account_number": "string",
  "source_id": "string",
  "source_type": "string",
  "source_category": "string",
  "daily_consumption_value": "number",
  "daily_weighted_order_consumption_amount": "number",
  "daily_weighted_list_consumption_amount": "number",
  "daily_consumption_count": "integer (int64)",
  "as_of_date": "string (date-time)"
}

ExportRegisterConsumptionBalanceBySource: object

A flattened record for a register's balance at the end of a given day by source

uuid: string

A unique identifier for this record.

allocation_type: string allocated, unallocated
register_id: integer (int64)

The internal register id for the register.

register_type: string

The register type per the initial register setup.

register_currency: CurrencyEnum
register_uom: string

The register's unit of measure

register_account_id: integer (int64)

The register's external account id.

register_account_number: string

The register's external account number.

register_category: string

The category of the register associated with this balance

source_id: string

The service_id that is consuming from the balance.

source_type: string

The type of transaction consuming from the balance.

source_category: string

The category of the transaction consuming from the balance.

balance_amount: number

The total amount of the balance on the register

balance_count: integer (int32)

The total number of transactions on the register

as_of_date: string (date-time)

The unallocated date based upon the business entity's timezone in YYYY-MM-DD format.

Example
{
  "uuid": "string",
  "allocation_type": "string",
  "register_id": "integer (int64)",
  "register_type": "string",
  "register_currency": "string",
  "register_uom": "string",
  "register_account_id": "integer (int64)",
  "register_account_number": "string",
  "register_category": "string",
  "source_id": "string",
  "source_type": "string",
  "source_category": "string",
  "balance_amount": "number",
  "balance_count": "integer (int32)",
  "as_of_date": "string (date-time)"
}

ExportRegisterBalance: object

A flattened record for a register's balance at the end of a given day

uuid: string

A unique identifier for this record.

register_id: integer (int64)

The internal register id for the register.

register_type: string

The register type per the initial register setup.

register_currency: CurrencyEnum
register_uom: string

The register's unit of measure

register_account_id: integer (int64)

The register's external account id.

register_account_number: string

The register's external account number.

register_category: string

The category of the register associated with this balance

balance_amount: number

The total amount of the balance on the register

balance_count: integer (int32)

The total number of transactions on the register

consumption_balance_amount: number

The total amount of the consumption balance on the register

consumption_balance_count: integer (int32)

The total number of consumption transactions on the register

contribution_balance_amount: number

The total amount of the contribution balance on the register

contribution_balance_count: integer (int32)

The total number of contribution transactions on the register

unallocated_consumption_balance_amount: number

The total amount of unallocated consumption on the register

as_of_date: string (date-time)

The unallocated date based upon the business entity's timezone in YYYY-MM-DD format.

Example
{
  "uuid": "string",
  "register_id": "integer (int64)",
  "register_type": "string",
  "register_currency": "string",
  "register_uom": "string",
  "register_account_id": "integer (int64)",
  "register_account_number": "string",
  "register_category": "string",
  "balance_amount": "number",
  "balance_count": "integer (int32)",
  "consumption_balance_amount": "number",
  "consumption_balance_count": "integer (int32)",
  "contribution_balance_amount": "number",
  "contribution_balance_count": "integer (int32)",
  "unallocated_consumption_balance_amount": "number",
  "as_of_date": "string (date-time)"
}

StoredValueRegister: object

An object to track a set of transactions around for stored value.

uuid: string

The globally unique identifier for the register. Generated by service if not passed in.

name: string

An optional name for this register.

granted_unit_of_measure: string MONEY, POINTS, COUNT

The unit of measure for which the register is tracking value. Can only be updated if there are no transactions for this register.

currency: CurrencyEnum
description: string

An optional description for this register.

external_account_id: string

An optional external account id for this register for cross referencing purposes.

external_account_number: string

An optional external account number for this register for cross referencing purposes.

external_account_name: string

An optional external account name for this register for cross referencing purposes.

external_company_name: string

An optional external company name for this register for cross referencing purposes.

external_category: string

An optional external category for this register for cross referencing purposes.

overdraft_amount: number

An optional amount this register can be overdrawn.

auto_contribution_enabled: boolean

Indicates if automatic contribution is enabled for this register.

auto_contribution_threshold: number

A balance level at which to trigger an automatic contribution.

auto_contribution_amount: number

The amount to add on an automatic contribution.

auto_contribution_granted_value: number

The granted value to add on an automatic contribution.

auto_contribution_product_eid: integer (int64)
balance_level_yellow: number

The threshold at which the register balance is considered to be in "yellow" condition.

balance_level_orange: number

The threshold at which the register balance is considered to be in "orange" condition. Must be lower than "yellow" value.

balance_level_red: number

The threshold at which the register balance is considered to be in "red" condition. Must be lower than "orange" value.

register_type: string

The type of this register. Used to differentiate between multiple registers that might be on a given external account.

timezone_name: Timezone
Example
{
  "uuid": "string",
  "name": "string",
  "granted_unit_of_measure": "string",
  "currency": "string",
  "description": "string",
  "external_account_id": "string",
  "external_account_number": "string",
  "external_account_name": "string",
  "external_company_name": "string",
  "external_category": "string",
  "overdraft_amount": "number",
  "auto_contribution_enabled": "boolean",
  "auto_contribution_threshold": "number",
  "auto_contribution_amount": "number",
  "auto_contribution_granted_value": "number",
  "auto_contribution_product_eid": "integer (int64)",
  "balance_level_yellow": "number",
  "balance_level_orange": "number",
  "balance_level_red": "number",
  "register_type": "string",
  "timezone_name": "string"
}

RegisterBalance: object

register: StoredValueRegister
register_category: string

The category of the register associated with this balance

balance_amount: number

The total amount of the balance on the register

balance_count: integer (int32)

The total number of transactions on the register

balance_level: string GREEN, YELLOW, ORANGE, RED

The level of the balance.

consumption_balance_amount: number

The total amount of the consumption balance on the register

consumption_balance_count: integer (int32)

The total number of consumption transactions on the register

contribution_balance_amount: number

The total amount of the contribution balance on the register

contribution_balance_count: integer (int32)

The total number of contribution transactions on the register

max_effective_date: string (date-time)

The maximum effective date of the balance

Example
{
  "register": {
    "uuid": "string",
    "name": "string",
    "granted_unit_of_measure": "string",
    "currency": "string",
    "description": "string",
    "external_account_id": "string",
    "external_account_number": "string",
    "external_account_name": "string",
    "external_company_name": "string",
    "external_category": "string",
    "overdraft_amount": "number",
    "auto_contribution_enabled": "boolean",
    "auto_contribution_threshold": "number",
    "auto_contribution_amount": "number",
    "auto_contribution_granted_value": "number",
    "auto_contribution_product_eid": "integer (int64)",
    "balance_level_yellow": "number",
    "balance_level_orange": "number",
    "balance_level_red": "number",
    "register_type": "string",
    "timezone_name": "string"
  },
  "register_category": "string",
  "balance_amount": "number",
  "balance_count": "integer (int32)",
  "balance_level": "string",
  "consumption_balance_amount": "number",
  "consumption_balance_count": "integer (int32)",
  "contribution_balance_amount": "number",
  "contribution_balance_count": "integer (int32)",
  "max_effective_date": "string (date-time)"
}

StoredValueContribution: object

order_granted_value: number

The granted value of contribution. Draw downs occur off of this value. Can be negative.

ordered_amount: number

The ordered (or "invoiced" or "sold") amount of contribution. Can be negative. Can be different (usually less) than the granted_amount.

list_granted_value: number

The list of the granted value of contribution.

list_amount: number

The original (or "list price" or "msrp") amount of the contribution. Can be negative.

source_id: string

A source id for this transaction.

source_type: string

The type of record that this source correpsonds to.

source_description: string

A source description for this transaction.

effective_date: string (date-time)

The date this transaction is effective. Can be in the past.

expire_date: string (date-time)

The expiration date of this transaction.

Example
{
  "order_granted_value": "number",
  "ordered_amount": "number",
  "list_granted_value": "number",
  "list_amount": "number",
  "source_id": "string",
  "source_type": "string",
  "source_description": "string",
  "effective_date": "string (date-time)",
  "expire_date": "string (date-time)"
}

StoredValueConsumption: object

consumed_value: number

The consumed value of this transaction.

source_id: string

A source id for this transaction.

source_type: string

The type of record that this source correpsonds to.

source_description: string

A source description for this transaction.

source_category: string

A source category for this transaction.

effective_date: string (date-time)

The date this transaction is effective. Can be in the past.

external_id: string

The id of the original event that is associated with this consumption.

Example
{
  "consumed_value": "number",
  "source_id": "string",
  "source_type": "string",
  "source_description": "string",
  "source_category": "string",
  "effective_date": "string (date-time)",
  "external_id": "string"
}

StoredValueTransaction: object

amount: number

The value of contribution or drawdown.

direction: string CONTRIBUTION, CONSUMPTION
Example
{
  "amount": "number",
  "direction": "string"
}

StoredValueDailyTransaction: object

total_amount: number

The total amount of the transactions that makes up this daily aggregate. Can be negative.

register_uom: string

The unit of measure for register

currency: CurrencyEnum
direction: string CONTRIBUTION, CONSUMPTION
count: integer (int64)

The total number of transactions that make up this daily aggregate.

year: integer (int32)

The year portion of the date for this aggregate

month: integer (int32)

The month portion of the date for this aggregate. Values from 1 to 12.

day: integer (int32)

The day portion of the date for this aggregate. Values from 1 to 31.

timezone_offset: string

The timezone offset of the dates included in this aggregate. E.g. UTC-0400 is GMT-4.

Example
{
  "total_amount": "number",
  "register_uom": "string",
  "currency": "string",
  "direction": "string",
  "count": "integer (int64)",
  "year": "integer (int32)",
  "month": "integer (int32)",
  "day": "integer (int32)",
  "timezone_offset": "string"
}

AutoContribution: object

uuid: string

The globally unique identifier for the auto contribution. Can be generated external to the service. If not sent in, a uuid will be generated and returned.

amount: number

The ordered amount of contribution.

Example
{
  "uuid": "string",
  "amount": "number"
}

AutoContributionStatus: object

uuid: string

The globally unique identifier for the auto contribution status. Can be generated external to the service. If not sent in, a uuid will be generated and returned.

status: string PROCESSING, ERROR, COMPLETE

The status of auto contribution

status_date: string (date-time)

The date this status is effective.

status_details: KeyValue
KeyValue
Example
{
  "uuid": "string",
  "status": "string",
  "status_date": "string (date-time)",
  "status_details": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

DetailedAutoContribution: object

uuid: string

The globally unique identifier for the auto contribution. Can be generated external to the service. If not sent in, a uuid will be generated and returned.

amount: number

The ordered amount of contribution.

statuses: AutoContributionStatus
AutoContributionStatus
Example
{
  "uuid": "string",
  "amount": "number",
  "statuses": [
    {
      "uuid": "string",
      "status": "string",
      "status_date": "string (date-time)",
      "status_details": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ]
}

RegisterBalanceLag: object

id: integer (int64)

The id of the register. Auto-generated by system on creation of register.

uuid: string

The globally unique identifier for the register. Generated by service if not passed in.

name: string

An optional name for this register.

max_contribution_date: string (date-time)
max_consumption_date: string (date-time)
max_balance_date: string (date-time)
age_seconds: number
Example
{
  "id": "integer (int64)",
  "uuid": "string",
  "name": "string",
  "max_contribution_date": "string (date-time)",
  "max_consumption_date": "string (date-time)",
  "max_balance_date": "string (date-time)",
  "age_seconds": "number"
}

ExpiringContribution: object

id: integer (int64)

The id of the contribution transaction. Auto-generated by system on creation of transaction.

order_granted_value: number

The granted value of contribution. Draw downs occur off of this value. Can be negative.

ordered_amount: number

The ordered (or "invoiced" or "sold") amount of contribution. Can be negative. Can be different (usually less) than the granted_amount.

list_granted_value: number

The list of the granted value of contribution.

list_amount: number

The original (or "list price" or "msrp") amount of the contribution. Can be negative.

source_id: string

A source id for this transaction.

source_type: string

The type of record that this source correpsonds to.

source_description: string

A source description for this transaction.

expire_date: string | null (date-time)

The expiration date of this transaction.

contribution_date: string (date-time)

The date of contribution. Can be in the past.

balance_remaining: number

Expiring contribution's balance remaining.

Example
{
  "id": "integer (int64)",
  "order_granted_value": "number",
  "ordered_amount": "number",
  "list_granted_value": "number",
  "list_amount": "number",
  "source_id": "string",
  "source_type": "string",
  "source_description": "string",
  "expire_date": "string (date-time)",
  "contribution_date": "string (date-time)",
  "balance_remaining": "number"
}

CurrencyEnum: string

The currency code based upon ISO 4217

string USD, GBP, EUR, SEK, NOK, DKK, CAD, AUD, ZAR, NZD, MXN, INR, JPY, SAR, QAR, EGP, AED, BHD, KWD, OMR, HKD, CHF, BRL, PLN, CNY, ILS, COP, PEN, RUB, SGD, IDR, MYR, KRW, TWD, PKR, ARS, CLP, CRC, CZK, HUF, ISK, PHP, RON, THB, TRY, BWP, NGN USD

Timezone: string

A timezone name per the official tz database.

string Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa, Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, Africa/Blantyre, Africa/Brazzaville, Africa/Bujumbura, Africa/Cairo, Africa/Casablanca, Africa/Ceuta, Africa/Conakry, Africa/Dakar, Africa/Dar_es_Salaam, Africa/Djibouti, Africa/Douala, Africa/El_Aaiun, Africa/Freetown, Africa/Gaborone, Africa/Harare, Africa/Johannesburg, Africa/Juba, Africa/Kampala, Africa/Khartoum, Africa/Kigali, Africa/Kinshasa, Africa/Lagos, Africa/Libreville, Africa/Lome, Africa/Luanda, Africa/Lubumbashi, Africa/Lusaka, Africa/Malabo, Africa/Maputo, Africa/Maseru, Africa/Mbabane, Africa/Mogadishu, Africa/Monrovia, Africa/Nairobi, Africa/Ndjamena, Africa/Niamey, Africa/Nouakchott, Africa/Ouagadougou, Africa/Porto-Novo, Africa/Sao_Tome, Africa/Timbuktu, Africa/Tripoli, Africa/Tunis, Africa/Windhoek, America/Adak, America/Anchorage, America/Anguilla, America/Antigua, America/Araguaina, America/Argentina/Buenos_Aires, America/Argentina/Catamarca, America/Argentina/ComodRivadavia, America/Argentina/Cordoba, America/Argentina/Jujuy, America/Argentina/La_Rioja, America/Argentina/Mendoza, America/Argentina/Rio_Gallegos, America/Argentina/Salta, America/Argentina/San_Juan, America/Argentina/San_Luis, America/Argentina/Tucuman, America/Argentina/Ushuaia, America/Aruba, America/Asuncion, America/Atikokan, America/Atka, America/Bahia, America/Bahia_Banderas, America/Barbados, America/Belem, America/Belize, America/Blanc-Sablon, America/Boa_Vista, America/Bogota, America/Boise, America/Buenos_Aires, America/Cambridge_Bay, America/Campo_Grande, America/Cancun, America/Caracas, America/Catamarca, America/Cayenne, America/Cayman, America/Chicago, America/Chihuahua, America/Coral_Harbour, America/Cordoba, America/Costa_Rica, America/Creston, America/Cuiaba, America/Curacao, America/Danmarkshavn, America/Dawson, America/Dawson_Creek, America/Denver, America/Detroit, America/Dominica, America/Edmonton, America/Eirunepe, America/El_Salvador, America/Ensenada, America/Fort_Nelson, America/Fort_Wayne, America/Fortaleza, America/Glace_Bay, America/Godthab, America/Goose_Bay, America/Grand_Turk, America/Grenada, America/Guadeloupe, America/Guatemala, America/Guayaquil, America/Guyana, America/Halifax, America/Havana, America/Hermosillo, America/Indiana/Indianapolis, America/Indiana/Knox, America/Indiana/Marengo, America/Indiana/Petersburg, America/Indiana/Tell_City, America/Indiana/Vevay, America/Indiana/Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, America/Louisville, America/Lower_Princes, America/Maceio, America/Managua, America/Manaus, America/Marigot, America/Martinique, America/Matamoros, America/Mazatlan, America/Mendoza, America/Menominee, America/Merida, America/Metlakatla, America/Mexico_City, America/Miquelon, America/Moncton, America/Monterrey, America/Montevideo, America/Montreal, America/Montserrat, America/Nassau, America/New_York, America/Nipigon, America/Nome, America/Noronha, America/North_Dakota/Beulah, America/North_Dakota/Center, America/North_Dakota/New_Salem, America/Ojinaga, America/Panama, America/Pangnirtung, America/Paramaribo, America/Phoenix, America/Port-au-Prince, America/Port_of_Spain, America/Porto_Acre, America/Porto_Velho, America/Puerto_Rico, America/Punta_Arenas, America/Rainy_River, America/Rankin_Inlet, America/Recife, America/Regina, America/Resolute, America/Rio_Branco, America/Rosario, America/Santa_Isabel, America/Santarem, America/Santiago, America/Santo_Domingo, America/Sao_Paulo, America/Scoresbysund, America/Shiprock, America/Sitka, America/St_Barthelemy, America/St_Johns, America/St_Kitts, America/St_Lucia, America/St_Thomas, America/St_Vincent, America/Swift_Current, America/Tegucigalpa, America/Thule, America/Thunder_Bay, America/Tijuana, America/Toronto, America/Tortola, America/Vancouver, America/Virgin, America/Whitehorse, America/Winnipeg, America/Yakutat, America/Yellowknife, Antarctica/Casey, Antarctica/Davis, Antarctica/DumontDUrville, Antarctica/Macquarie, Antarctica/Mawson, Antarctica/McMurdo, Antarctica/Palmer, Antarctica/Rothera, Antarctica/South_Pole, Antarctica/Syowa, Antarctica/Troll, Antarctica/Vostok, Arctic/Longyearbyen, Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe, Asia/Ashgabat, Asia/Ashkhabad, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku, Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei, Asia/Calcutta, Asia/Chita, Asia/Choibalsan, Asia/Chongqing, Asia/Chungking, Asia/Colombo, Asia/Dacca, Asia/Damascus, Asia/Dhaka, Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Harbin, Asia/Hebron, Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Istanbul, Asia/Jakarta, Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Kashgar, Asia/Kathmandu, Asia/Katmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macao, Asia/Macau, Asia/Magadan, Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk, Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak, Asia/Pyongyang, Asia/Qatar, Asia/Qyzylorda, Asia/Rangoon, Asia/Riyadh, Asia/Saigon, Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tel_Aviv, Asia/Thimbu, Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ujung_Pandang, Asia/Ulaanbaatar, Asia/Ulan_Bator, Asia/Urumqi, Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Bermuda, Atlantic/Canary, Atlantic/Cape_Verde, Atlantic/Faeroe, Atlantic/Faroe, Atlantic/Jan_Mayen, Atlantic/Madeira, Atlantic/Reykjavik, Atlantic/South_Georgia, Atlantic/St_Helena, Atlantic/Stanley, Australia/ACT, Australia/Adelaide, Australia/Brisbane, Australia/Broken_Hill, Australia/Canberra, Australia/Currie, Australia/Darwin, Australia/Eucla, Australia/Hobart, Australia/LHI, Australia/Lindeman, Australia/Lord_Howe, Australia/Melbourne, Australia/North, Australia/NSW, Australia/Perth, Australia/Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, Canada/Atlantic, Canada/Central, Canada/East-Saskatchewan, Canada/Eastern, Canada/Mountain, Canada/Newfoundland, Canada/Pacific, Canada/Saskatchewan, Canada/Yukon, CET, Chile/Continental, Chile/EasterIsland, CST6CDT, Cuba, EET, Egypt, Eire, EST, EST5EDT, Etc/GMT, Etc/Greenwich, Etc/UCT, Etc/Universal, Etc/UTC, Etc/Zulu, Europe/Amsterdam, Europe/Andorra, Europe/Astrakhan, Europe/Athens, Europe/Belfast, Europe/Belgrade, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Busingen, Europe/Chisinau, Europe/Copenhagen, Europe/Dublin, Europe/Gibraltar, Europe/Guernsey, Europe/Helsinki, Europe/Isle_of_Man, Europe/Istanbul, Europe/Jersey, Europe/Kaliningrad, Europe/Kiev, Europe/Kirov, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Mariehamn, Europe/Minsk, Europe/Monaco, Europe/Moscow, Europe/Nicosia, Europe/Oslo, Europe/Paris, Europe/Podgorica, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/San_Marino, Europe/Sarajevo, Europe/Saratov, Europe/Simferopol, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Tirane, Europe/Tiraspol, Europe/Ulyanovsk, Europe/Uzhgorod, Europe/Vaduz, Europe/Vatican, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Europe/Zaporozhye, Europe/Zurich, GB, GB-Eire, GMT, GMT0, Greenwich, Hongkong, HST, Iceland, Indian/Antananarivo, Indian/Chagos, Indian/Christmas, Indian/Cocos, Indian/Comoro, Indian/Kerguelen, Indian/Mahe, Indian/Maldives, Indian/Mauritius, Indian/Mayotte, Indian/Reunion, Iran, Israel, Jamaica, Japan, Kwajalein, Libya, MET, Mexico/BajaNorte, Mexico/BajaSur, Mexico/General, MST, MST7MDT, Navajo, NZ, NZ-CHAT, Pacific/Apia, Pacific/Auckland, Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter, Pacific/Efate, Pacific/Enderbury, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti, Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Johnston, Pacific/Kiritimati, Pacific/Kosrae, Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway, Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei, Pacific/Ponape, Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Samoa, Pacific/Tahiti, Pacific/Tarawa, Pacific/Tongatapu, Pacific/Truk, Pacific/Wake, Pacific/Wallis, Pacific/Yap, Poland, Portugal, PRC, PST8PDT, ROC, ROK, Singapore, Turkey, UCT, Universal, US/Alaska, US/Aleutian, US/Arizona, US/Central, US/East-Indiana, US/Eastern, US/Hawaii, US/Indiana-Starke, US/Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, W-SU, WET, Zulu America/Chicago