Skip to content
Pulse Docs

Account Types

The /account-types endpoint returns a list of account types that accounts can be created from.

Example Response

[
  {
    "id": "iso",
    "uniqueId": "iso",
    "name": "ISO",
    "repcode": "iso",
    "accountTypeId": "iso",
    "accountTypeTemplate": true,
    "createdBy": "test@test.com",
    "updatedBy": "test@test.com",
    "createdAt": "2024-11-13T19:04:39.762Z",
    "updatedAt": "2024-11-13T19:04:39.762Z",
    "permissionsToAccounts": [
      {
        "permissionId": 1,
        "accountId": "iso",
        "permission": {
          "id": 1,
          "permission": "readApplications"
        }
      },
      {
        "permissionId": 2,
        "accountId": "iso",
        "permission": {
          "id": 2,
          "permission": "writeApplications"
        }
      }
      // ... other permissions
    ],
    "permissions": [
      "readApplications",
      "writeApplications",
      "readMerchants",
      "writeMerchants"
      // ... other permissions
    ],
    "description": "Independent Sales Organization",
    "table_name": "isos",
    "id_field_name": "id",
    "active": true,
    "accounts": [
      {
        "id": 2,
        "uniqueId": "iso",
        "name": "ISO",
        "repcode": "iso",
        "accountTypeId": "iso",
        "accountTypeTemplate": true,
        "createdBy": "test@test.com",
        "updatedBy": "test@test.com",
        "createdAt": "2024-11-13T19:04:39.762Z",
        "updatedAt": "2024-11-13T19:04:39.762Z"
      }
    ]
  }
  // ... other accounts
]

Properties

id

  • Type: integer | string
  • Description: The unique identifier of the account. Can be an integer or a string.

uniqueId

  • Type: string
  • Description: A unique identifier for the account.

name

  • Type: string
  • Description: The name of the account.

accountTypeId

  • Type: string
  • Description: The type identifier for the account.

accountTypeTemplate

  • Type: boolean
  • Description: Indicates if the account is a template.

createdBy

  • Type: string | null
  • Description: The email address of the user who created the account; can be null if unspecified.

updatedBy

  • Type: string | null
  • Description: The email address of the user who last updated the account; can be null if unspecified.

createdAt

  • Type: string (ISO 8601 datetime)
  • Description: The timestamp of when the account was created.

updatedAt

  • Type: string (ISO 8601 datetime)
  • Description: The timestamp of the last update to the account.

permissionsToAccounts

  • Type: array of objects
  • Description: A list of permissions granted to the account.
    • permissionId: integer - The unique identifier of the permission.
    • accountId: string - The unique identifier of the account.
    • permission: object - Information about the permission.
      • id: integer - The unique identifier of the permission.
      • permission: string - The name of the permission.

permissions

  • Type: array of string
  • Description: A list of permission names granted to the account.

description

  • Type: string | null
  • Description: A description of the account; can be null if unspecified.

table_name

  • Type: string | null
  • Description: The table name associated with the account; can be null if unspecified.

id_field_name

  • Type: string | null
  • Description: The ID field name associated with the account; can be null if unspecified.

active

  • Type: boolean | null
  • Description: Indicates if the account is active; can be null if unspecified.

accounts

  • Type: array of objects | null
  • Description: A list of accounts associated with the account type; can be null if unspecified.
    • id: integer - The unique identifier of the account.
    • uniqueId: string - A unique identifier for the account.
    • name: string - The name of the account.
    • repcode: string - The repcode associated with the account.
    • accountTypeId: string - The type identifier for the account.
    • accountTypeTemplate: boolean - Indicates if the account is a template.
    • createdBy: string | null - The email address of the user who created the account.
    • updatedBy: string | null - The email address of the user who last updated the account.
    • createdAt: string (ISO 8601 datetime) - The timestamp of when the account was created.
    • updatedAt: string (ISO 8601 datetimedatetime (ISO 8601 datetime) - The timestamp of the last update to the account.