Methods

  • post - Create account [Deprecating - V1]
  • post - Create account [Phasing In - V2]
  • get - Get an account by accountId
  • get - Get an account by identifier
  • get - Get short system account list
  • get - Get current [logged in] account details
  • post - Update account by accountId [Deprecating - V1]
  • post - Update account by accountId [Phasing In - V2]
  • get - Query and filter accounts

Resource

{
    "accountId": "number",
    "accountMetabaseReporting": {},
    "accountReporting": {},
    "accountRequestInformationLog": {},
    "active": "boolean",
    "asOwner": {},
    "asUser": {},
    "atgCreditGuard": {},
    "createdAt": "string",
    "details": {
        "fax": "string",
        "name": "string",
        "reportingEmbedUrl": "string"
    },
    "fleetManagerDetails": {},
    "forwardRelations": {},
    "identifier": "string",
    "infringementApproval": {},
    "infringementNotes": {},
    "isVerified": "boolean",
    "logs": {},
    "managed": "boolean",
    "name": "string",
    "nominations": {},
    "notifications": {},
    "physicalLocation": {},
    "postalLocation": {},
    "powerOfAttorney": {},
    "previouslyNominated": {},
    "primaryContact": "string",
    "requestInformationDetails": {},
    "reverseRelations": {},
    "role": "string",
    "rpCreditGuard": {},
    "toBeNominated": {},
    "type": "string",
    "updatedAt": "string",
    "userAuditLogs": {},
    "users": {}
}

Properties

Name Type Description Additional
accountId number
accountMetabaseReporting object

AccountMetabaseReporting

accountReporting object

AccountReporting

accountRequestInformationLog object

RequestInformationLog

active boolean
asOwner object

OwnershipContract[]

asUser object

LeaseContract[]

atgCreditGuard object

CreditGuardToken

createdAt string
details object
details.fax string
details.name string
details.reportingEmbedUrl string
fleetManagerDetails object

FleetManagerDetails

forwardRelations object

AccountRelation[]

identifier string
infringementApproval object

InfringementApproval[]

infringementNotes object

RequestInformationLog

isVerified boolean
logs object

Log

managed boolean
name string
nominations object

Nomination[]

notifications object

Notification

physicalLocation object

PhysicalLocation

postalLocation object

PostalLocation

powerOfAttorney object

Document

previouslyNominated object

Nomination[]

primaryContact string
requestInformationDetails object

RequestInformationDetails

reverseRelations object

AccountRelation[]

role string

Possible values are:

  • Owner
  • User
  • Hybrid
rpCreditGuard object

CreditGuardToken

toBeNominated object

Nomination[]

type string

Possible values are:

  • Individual
  • Standard
updatedAt string
userAuditLogs object

AuditLog

users object

AccountUser[]