1 of 11

Account

Account Object

The account object represents an individual account on the Marketplace platform. This object contains the following properties:

Field

Type

Description

Example

List Accounts

Create Account

Create a new Client or Vendor Account object.

Enable Account

Enable the previously disabled Account object.

When enabled, the account status will change to Active if the account has ExternalId assigned or Enabled otherwise.

Disable Account

Disable the Account object. Disabling prevents users from signing in

Activate Account

Activate the previously enabled Account object.

Get Account

Get a single Account object by ID.

Update Account

Update the Account object.

Validate Account

Validate the Account object.

Get List of External Buyers

Gets a list of external Buyer objects that can be added to Account

Get Account Icon

List Accounts

GEThttps://api.platform.softwareone.com/public/v1/accounts/accounts

Response

Success

Body

$metaobject

dataarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "href": "text",
      "externalId": "text",
      "externalName": "text",
      "icon": "text",
      "technicalSupportEmail": "name@gmail.com",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "href": "text",
          "name": "text",
          "description": "text",
          "modules": [
            {
              "id": "text",
              "href": "text",
              "description": "text",
              "isConfigurable": false,
              "isEnabledByDefault": false,
              "paid": false,
              "name": "text",
              "accountTypes": [
                "text"
              ]
            }
          ],
          "logo": "text",
          "isDefault": false,
          "users": [
            {
              "id": "text",
              "href": "text",
              "email": "text",
              "status": "text",
              "firstName": "text",
              "lastName": "text",
              "icon": "text",
              "lastLoginAt": "2024-11-15T10:44:04.656Z",
              "name": "text",
              "accounts": []
            }
          ]
        }
      ],
      "buyers": [
        {
          "id": "text",
          "href": "text",
          "icon": "text",
          "taxId": "text",
          "name": "text",
          "sellers": [
            {
              "id": "text",
              "href": "text",
              "externalId": "text",
              "icon": "text",
              "currencies": [
                "text"
              ],
              "name": "text"
            }
          ]
        }
      ]
    }
  ]
}

Create Account

Create a new Client or Vendor Account object.

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts

Body

accountobject

Json representation of the account

ExternalIdstring

ExternalNamestring

TypeAccountType (enum)

ClientVendorOperations

StatusAccountStatus (enum)

ActiveEnabledDisabled

ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

Iconstring

IconFileIdstring

TechnicalSupportEmailstring

Websitestring

Descriptionstring

Namestring

Groupsarray of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Buyersarray of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Metadata.OmittedPropertiesarray of string

itemsstring

Referencestring

Audit.Created.Atstring (date-time)

Audit.Created.ByIdstring

Audit.Created.By.Namestring

Audit.Created.By.Iconstring

Audit.Created.By.HasIconboolean

Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Created.By.Referencestring

Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Created.By.Audit.Updated.Atstring (date-time)

Audit.Created.By.Audit.Updated.ByIdstring

Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Created.By.Idstring

Audit.Created.By.SystemIdinteger (int32)

Audit.Updated.Atstring (date-time)

Audit.Updated.ByIdstring

Audit.Updated.By.Namestring

Audit.Updated.By.Iconstring

Audit.Updated.By.HasIconboolean

Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Updated.By.Referencestring

Audit.Updated.By.Audit.Created.Atstring (date-time)

Audit.Updated.By.Audit.Created.ByIdstring

Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Updated.By.Idstring

Audit.Updated.By.SystemIdinteger (int32)

Idstring

SystemIdinteger (int32)

logostring (binary)

Response

Created

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "icon": "text",
  "technicalSupportEmail": "name@gmail.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "description": "text",
      "modules": [
        {
          "id": "text",
          "href": "text",
          "description": "text",
          "isConfigurable": false,
          "isEnabledByDefault": false,
          "paid": false,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "logo": "text",
      "isDefault": false,
      "users": [
        {
          "id": "text",
          "href": "text",
          "email": "text",
          "status": "text",
          "firstName": "text",
          "lastName": "text",
          "icon": "text",
          "lastLoginAt": "2024-11-15T10:44:04.656Z",
          "name": "text",
          "accounts": []
        }
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "href": "text",
      "icon": "text",
      "taxId": "text",
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "icon": "text",
          "currencies": [
            "text"
          ],
          "name": "text"
        }
      ]
    }
  ]
}

Enable Account

Enable the previously disabled Account object.

When enabled, the account status will change to Active if the account has ExternalId assigned or Enabled otherwise.

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/enable

Path parameters

id*string

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/enable', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "icon": "text",
  "technicalSupportEmail": "name@gmail.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "description": "text",
      "modules": [
        {
          "id": "text",
          "href": "text",
          "description": "text",
          "isConfigurable": false,
          "isEnabledByDefault": false,
          "paid": false,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "logo": "text",
      "isDefault": false,
      "users": [
        {
          "id": "text",
          "href": "text",
          "email": "text",
          "status": "text",
          "firstName": "text",
          "lastName": "text",
          "icon": "text",
          "lastLoginAt": "2024-11-15T10:44:04.656Z",
          "name": "text",
          "accounts": []
        }
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "href": "text",
      "icon": "text",
      "taxId": "text",
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "icon": "text",
          "currencies": [
            "text"
          ],
          "name": "text"
        }
      ]
    }
  ]
}

Get Account

Get a single Account object by ID.

GEThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}

Path parameters

id*string

Query parameters

selectstring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

Activate Account

Activate the previously enabled Account object.

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/activate

Path parameters

id*string

Body

idstring

auditobject

$metaobject

hrefstring

externalId*string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

GEThttps://api.platform.softwareone.com/public/v1/accounts/accounts

Response

Success

Body

$metaobject

dataarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/accounts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "text",
      "href": "text",
      "externalId": "text",
      "externalName": "text",
      "icon": "text",
      "technicalSupportEmail": "name@gmail.com",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "href": "text",
          "name": "text",
          "description": "text",
          "modules": [
            {
              "id": "text",
              "href": "text",
              "description": "text",
              "isConfigurable": false,
              "isEnabledByDefault": false,
              "paid": false,
              "name": "text",
              "accountTypes": [
                "text"
              ]
            }
          ],
          "logo": "text",
          "isDefault": false,
          "users": [
            {
              "id": "text",
              "href": "text",
              "email": "text",
              "status": "text",
              "firstName": "text",
              "lastName": "text",
              "icon": "text",
              "lastLoginAt": "2024-11-15T10:44:04.656Z",
              "name": "text",
              "accounts": []
            }
          ]
        }
      ],
      "buyers": [
        {
          "id": "text",
          "href": "text",
          "icon": "text",
          "taxId": "text",
          "name": "text",
          "sellers": [
            {
              "id": "text",
              "href": "text",
              "externalId": "text",
              "icon": "text",
              "currencies": [
                "text"
              ],
              "name": "text"
            }
          ]
        }
      ]
    }
  ]
}

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/enable

Path parameters

id*string

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/enable', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "icon": "text",
  "technicalSupportEmail": "name@gmail.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "description": "text",
      "modules": [
        {
          "id": "text",
          "href": "text",
          "description": "text",
          "isConfigurable": false,
          "isEnabledByDefault": false,
          "paid": false,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "logo": "text",
      "isDefault": false,
      "users": [
        {
          "id": "text",
          "href": "text",
          "email": "text",
          "status": "text",
          "firstName": "text",
          "lastName": "text",
          "icon": "text",
          "lastLoginAt": "2024-11-15T10:44:04.656Z",
          "name": "text",
          "accounts": []
        }
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "href": "text",
      "icon": "text",
      "taxId": "text",
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "icon": "text",
          "currencies": [
            "text"
          ],
          "name": "text"
        }
      ]
    }
  ]
}

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts

Body

accountobject

Json representation of the account

ExternalIdstring

ExternalNamestring

TypeAccountType (enum)

ClientVendorOperations

StatusAccountStatus (enum)

ActiveEnabledDisabled

ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

Iconstring

IconFileIdstring

TechnicalSupportEmailstring

Websitestring

Descriptionstring

Namestring

Groupsarray of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Buyersarray of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Metadata.OmittedPropertiesarray of string

itemsstring

Referencestring

Audit.Created.Atstring (date-time)

Audit.Created.ByIdstring

Audit.Created.By.Namestring

Audit.Created.By.Iconstring

Audit.Created.By.HasIconboolean

Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Created.By.Referencestring

Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Created.By.Audit.Updated.Atstring (date-time)

Audit.Created.By.Audit.Updated.ByIdstring

Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Created.By.Idstring

Audit.Created.By.SystemIdinteger (int32)

Audit.Updated.Atstring (date-time)

Audit.Updated.ByIdstring

Audit.Updated.By.Namestring

Audit.Updated.By.Iconstring

Audit.Updated.By.HasIconboolean

Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Updated.By.Referencestring

Audit.Updated.By.Audit.Created.Atstring (date-time)

Audit.Updated.By.Audit.Created.ByIdstring

Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Updated.By.Idstring

Audit.Updated.By.SystemIdinteger (int32)

Idstring

SystemIdinteger (int32)

logostring (binary)

Response

Created

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

const response = await fetch('https://api.platform.softwareone.com/public/v1/accounts/accounts', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "externalId": "text",
  "externalName": "text",
  "icon": "text",
  "technicalSupportEmail": "name@gmail.com",
  "website": "text",
  "description": "text",
  "name": "text",
  "groups": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "description": "text",
      "modules": [
        {
          "id": "text",
          "href": "text",
          "description": "text",
          "isConfigurable": false,
          "isEnabledByDefault": false,
          "paid": false,
          "name": "text",
          "accountTypes": [
            "text"
          ]
        }
      ],
      "logo": "text",
      "isDefault": false,
      "users": [
        {
          "id": "text",
          "href": "text",
          "email": "text",
          "status": "text",
          "firstName": "text",
          "lastName": "text",
          "icon": "text",
          "lastLoginAt": "2024-11-15T10:44:04.656Z",
          "name": "text",
          "accounts": []
        }
      ]
    }
  ],
  "buyers": [
    {
      "id": "text",
      "href": "text",
      "icon": "text",
      "taxId": "text",
      "name": "text",
      "sellers": [
        {
          "id": "text",
          "href": "text",
          "externalId": "text",
          "icon": "text",
          "currencies": [
            "text"
          ],
          "name": "text"
        }
      ]
    }
  ]
}

Disable Account

Disable the Account object. Disabling prevents users from signing in

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/disable

Path parameters

id*string

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

Account

Account Object

The account object represents an individual account on the Marketplace platform. This object contains the following properties:

Field

Type

Description

Example

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com"  
}

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com",
  "groups": [
		{
			"id": "UGR-9354-3382",
			"href": "/user-groups/UGR-9354-3382",
			"name": "Administrators",
			"description": "Manages administrative tasks and resources within an organization.",
			"logo": null,
			"isDefault": true
		}
  ],
  {
    "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "disabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "enabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "activated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
  }
}

{
  "id": "ACC-1671-0642",
  "href": "/accounts/accounts/ACC-1671-0642",
  "type": "Client",
  "status": "Enabled",
  "name": "You Are a Test Account",
  "description": "This is a test account.",
  "externalId": "WW-1001111",
  "serviceLevel": "Express",
  "address": {
    "addressLine1": "123 Main Street",
    "addressLine2": "Apt 4B",
    "postCode": "12345",
    "city": "Cityville",
    "state": "S",
    "country": "ST"
  },
  "logo": null,
  "technicalSupportEmail": "user@example.com",
  "website": "https://example.com",
  "groups": [
		{
			"id": "UGR-9354-3382",
			"href": "/user-groups/UGR-9354-3382",
			"name": "Administrators",
			"description": "Manages administrative tasks and resources within an organization.",
			"logo": null,
			"isDefault": true
		}
  ],
  {
    "created": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "updated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "disabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "enabled": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } },
    "activated": { "at": "2023-12-14T17:28:57.667Z", "by": { "id": "USR-1234-1234", "name": "John Smith" } }
  }
}

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/external-buyers

Path parameters

id*string

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string

websitenullable string

descriptionnullable string

namenullable string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

addressobject

taxIdnullable string

namenullable string

sellersnullable array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

accountobject

Request

Response

PUThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}

Path parameters

id*string

Body

accountobject

Json representation of the account

ExternalIdstring

ExternalNamestring

TypeAccountType (enum)

ClientVendorOperations

StatusAccountStatus (enum)

ActiveEnabledDisabled

ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

Iconstring

IconFileIdstring

TechnicalSupportEmailstring

Websitestring

Descriptionstring

Namestring

Groupsarray of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Buyersarray of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Metadata.OmittedPropertiesarray of string

itemsstring

Referencestring

Audit.Created.Atstring (date-time)

Audit.Created.ByIdstring

Audit.Created.By.Namestring

Audit.Created.By.Iconstring

Audit.Created.By.HasIconboolean

Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Created.By.Referencestring

Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Created.By.Audit.Updated.Atstring (date-time)

Audit.Created.By.Audit.Updated.ByIdstring

Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Created.By.Idstring

Audit.Created.By.SystemIdinteger (int32)

Audit.Updated.Atstring (date-time)

Audit.Updated.ByIdstring

Audit.Updated.By.Namestring

Audit.Updated.By.Iconstring

Audit.Updated.By.HasIconboolean

Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Updated.By.Referencestring

Audit.Updated.By.Audit.Created.Atstring (date-time)

Audit.Updated.By.Audit.Created.ByIdstring

Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Updated.By.Idstring

Audit.Updated.By.SystemIdinteger (int32)

Idstring

SystemIdinteger (int32)

logostring (binary)

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/validate

Path parameters

id*string

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string

websitenullable string

descriptionnullable string

namenullable string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

GEThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}

Path parameters

id*string

Query parameters

selectstring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/disable

Path parameters

id*string

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/validate

Path parameters

id*string

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string

websitenullable string

descriptionnullable string

namenullable string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/external-buyers

Path parameters

id*string

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string

websitenullable string

descriptionnullable string

namenullable string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

addressobject

taxIdnullable string

namenullable string

sellersnullable array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

accountobject

Request

Response

POSThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}/activate

Path parameters

id*string

Body

idstring

auditobject

$metaobject

hrefstring

externalId*string

externalNamenullable string

typeobject

statusobject

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response

PUThttps://api.platform.softwareone.com/public/v1/accounts/accounts/{id}

Path parameters

id*string

Body

accountobject

Json representation of the account

ExternalIdstring

ExternalNamestring

TypeAccountType (enum)

ClientVendorOperations

StatusAccountStatus (enum)

ActiveEnabledDisabled

ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

Iconstring

IconFileIdstring

TechnicalSupportEmailstring

Websitestring

Descriptionstring

Namestring

Groupsarray of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

Circular reference to array of UserQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

Buyersarray of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Metadata.OmittedPropertiesarray of string

itemsstring

Referencestring

Audit.Created.Atstring (date-time)

Audit.Created.ByIdstring

Audit.Created.By.Namestring

Audit.Created.By.Iconstring

Audit.Created.By.HasIconboolean

Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Created.By.Referencestring

Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Created.By.Audit.Updated.Atstring (date-time)

Audit.Created.By.Audit.Updated.ByIdstring

Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Created.By.Idstring

Audit.Created.By.SystemIdinteger (int32)

Audit.Updated.Atstring (date-time)

Audit.Updated.ByIdstring

Audit.Updated.By.Namestring

Audit.Updated.By.Iconstring

Audit.Updated.By.HasIconboolean

Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Audit.Updated.By.Referencestring

Audit.Updated.By.Audit.Created.Atstring (date-time)

Audit.Updated.By.Audit.Created.ByIdstring

Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Audit.Updated.By.Idstring

Audit.Updated.By.SystemIdinteger (int32)

Idstring

SystemIdinteger (int32)

logostring (binary)

Response

Success

Body

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

descriptionnullable string

accountobject

modulesarray of ModuleQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

descriptionstring

isConfigurableboolean

isEnabledByDefaultboolean

paidboolean

namestring

accountTypesarray of string

itemsstring

logonullable string

isDefaultboolean

usersarray of UserQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

emailstring

statusstring

phoneobject

firstNamestring

lastNamestring

iconnullable string

lastLoginAtnullable string (date-time)

settingsobject

namestring

accountsarray of AccountQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

externalNamenullable string

type*object

status*object

serviceLevelobject

addressobject

iconnullable string

technicalSupportEmailnullable string (email)

websitenullable string

descriptionnullable string

name*string

groupsnullable array of UserGroupQueryModel (object)

Circular reference to nullable array of UserGroupQueryModel (object) ↩

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

currentAccountobject

buyersnullable array of BuyerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

contactobject

externalIdsobject

statusobject

iconnullable string

address*object

taxIdnullable string

accountobject

name*string

sellers*array of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Request

Response