FAQ for Organization
  • Welcome
  • Onboarding Guide
    • Mandatory settings
      • 1. Integrate your Telecoms
      • 2. Create Company
      • 3. Upload your SIM(s)
      • 4. Create Plan(s)
      • 5. Assign the plan to SIM(s)
    • Optional settings
      • 1. Account Settings
      • 2. User Profile
      • 3. PSP Integration
      • 4. Invoice Integration
      • 5. Create Pools
      • 6. Invite Staff
      • 7. Customize Columns
      • 8. Notifications
      • 9. Communication
  • Menu
    • Roles on the platform
    • SIMs
      • SIM Statuses
      • General Terms
      • Key Features
      • Q&A
    • Satellite
      • Terminal Statuses
      • Upload Terminals
    • Pools
    • Plans
      • Prepaid
      • Subscription
      • PAYGO
    • Companies
    • End Users
    • Automation - Rules
    • Transactions
    • Wallet
    • Webhooks
      • Terms used
      • Endpoint validation
      • Authentication
      • Webhook Payload Models
        • Account Model
        • End User Model
        • Account Address Model
        • Wallet Model
        • Plan Model
        • Pool Model
        • SIM Card Model
        • Status Model
        • User Model
        • Prepaid Refill Model
        • Date Time Model
        • Rule Model
        • Payment Model
        • Credit Card Model
      • Webhook Payload Types
        • Technical Payloads
        • Event Payloads
          • Company Events
          • Company Staff Events
          • End User Events
          • SIM Card Events
          • Payment Payloads
        • Rule Payloads
          • SIM Card Rule Payloads
          • SIM Pools Payloads
          • Wallet Payloads
  • e-SIM Store
    • Upload SIMs
    • eSIM Purchase & Activation
    • eSIM Store Activation
    • Q&A
Powered by GitBook
On this page
  1. Menu
  2. Webhooks
  3. Webhook Payload Models

Account Model

Account Model - is a base model for show platform account parameters. The fields of the Account model are presented in the table (Table 4.1), with an example below (Listing 4.1). There are the following types of this model (Table 4.2).

Table 4.1 - Fields of Account Model

№
Key
Type
Exists
Description

1

uuid

uuid v4, string

required

Main identifier of account

2

name

string

required

Public name of account

3

status

Status Model

optional

Platform Account Status

4

currency_code

string

optional

"EUR" , "USD" , etc.

5

email_for_notification

string

optional

If account has this parameter

6

vat_number

string

optional

Unique identifier of taxable person

7

address

Account Address Model

optional

If account has any of address parameters

Listing 4.1 – Example of Account Model (JSON)

{
     "uuid":                    "ff472de7-59b2-425d-96ec-9d1ff4bab684",
     "name":                    "Example Company",
     "status":                  {...//Status Model},
     "currency_code":           "EUR",
     "email_for_notification":  "email.notif@gmail.com",
     "vat_number":              "123456789",
     "address":                 {...//Account Address Model}
}

Table 4.2 - Account Type

№
Title
Description

1

Admin

Has highest rules

2

Organisation

Has more rules than Companies and End Users and manages them

3

Company

Has more rules than End Users and manages them

4

End User

Main account of user with basic rules

PreviousWebhook Payload ModelsNextEnd User Model

Last updated 8 months ago