1 of 9

Buyer

Buyer Object

The buyer object represents an individual buyer in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary buyer identifier.

Example: "BUY-1234-1234"

href

string

Relative reference to object on API.

Example: "/v1/accounts/buyers/BUY-1234-1234"

status

string

Status: Enabled, Active, Disabled, Deleted

name

string

Buyer's name.

Example: "Stark Industries"

icon

string

Relative path to buyer’s logo.

Example: "/static/accounts/BUY-1234-1234/logo.png"

externalIds

BuyerExternalIdsObject

External identifier.

Example:

address

object

Address of the buyer.

Example:

taxId

string

Buyer's tax ID.

Example: "12-34567890"

account

Buyer’s account object.

sellers

contact

object

Contact person details.

Example:

audit

object

Possible audit events: Created, Updated, Disabled, Enabled, Activated.

Example:

Example

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "will.smith@adastraflex.com",
		"phone": null
	},
	"externalIds": {
		"erpCompanyContact": "WW-CON-123456",
		"erpCustomer": "WW-SCU-123456"
    },
	"status": "Active",
	"icon": null,
	"address": {
		"addressLine1": "PO Box 31",
		"addressLine2": "Victory Road",
		"postCode": "DE24 8BJ",
		"city": "Derby",
		"state": "Derbs",
		"country": "UK"
	},
	"taxId": "VAT1",
	"name": "Stark Industries"
}

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "will.smith@adastraflex.com",
		"phone": null,
		"user": {
			"id": "USR-0000-0001",
			"href": "/users/USR-0000-0001",
			"icon": null,
			"invited": "2024-02-03T11:34:15.381Z",
			"joined": "2024-02-04T12:34:15.381Z",
			"lastLogin": "2024-02-05T13:34:15.381Z",
			"name": "Will Smith"
		}
	},
    "externalIds": {
		"erpCompanyContact": "WW-CON-123456",
		"erpCustomer": "WW-SCU-123456"
    },
	"status": "Active",
	"icon": null,
	"address": {
		"addressLine1": "PO Box 31",
		"addressLine2": "Victory Road",
		"postCode": "DE24 8BJ",
		"city": "Derby",
		"state": "Derbs",
		"country": "UK"
	},
	"taxId": "VAT1",
	"account": {
		"id": "ACC-5563-4382",
		"href": "/accounts/accounts/ACC-5563-4382",
		"type": "Client",
		"status": "Active",
		"icon": null,
		"name": "AdAstraflexx"
	},
	"name": "Stark Industries",
	"sellers": [
		{
			"id": "SEL-1299-2079",
			"href": "/accounts/sellers/SEL-1299-2079",
			"externalId": "SWO_CH",
			"name": "SoftwareOne AG"
		}
	],
	"audit": {
		"created": {
			"at": "2023-12-14T13:44:20.896Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		},
		"updated": {
			"at": "2024-01-06T19:04:16.692Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		}
	}
}

List Buyers

Get the Buyers collection.

Create Buyer

Create a new Buyer object for the client account.

Enable Buyer

Enable a previously disabled Buyer object.

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

Disable Buyer

Disable the Buyer object. Disabled buyers cannot be used in transactions.

Get Buyer

Get a single Buyer object by ID.

Update Buyer

Update the Buyer object. You can only update the logo and contact fields only.

Delete Buyer

Delete the Buyer object.

Validate Buyer

Validate a Buyer object.

Enable Buyer

Enable a previously disabled Buyer object.

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

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

Path parameters

id*string

Response

Success

Body

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/buyers/{id}/enable', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "icon": "text",
  "taxId": "text",
  "name": "text",
  "sellers": [
    {
      "id": "text",
      "href": "text",
      "externalId": "text",
      "icon": "text",
      "currencies": [
        "text"
      ],
      "name": "text"
    }
  ]
}

Create Buyer

Create a new Buyer object for the client account.

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

Body

buyerobject

Json representation of the buyer

ExternalIds.ErpCompanyContactstring

ExternalIds.ErpCustomerstring

ExternalIds.AccountExternalIdstring

StatusBuyerStatus (enum)

ActiveEnabledDisabledDeletedUnassignedConflict

Iconstring

IconFileIdstring

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

TaxIdstring

Account.ExternalIdstring

Account.ExternalNamestring

Account.TypeAccountType (enum)

ClientVendorOperations

Account.StatusAccountStatus (enum)

ActiveEnabledDisabled

Account.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Account.Address.AddressLine1string

Account.Address.AddressLine2string

Account.Address.PostCodestring

Account.Address.Citystring

Account.Address.Statestring

Account.Address.Countrystring

Account.Iconstring

Account.IconFileIdstring

Account.TechnicalSupportEmailstring

Account.Websitestring

Account.Descriptionstring

Account.Namestring

Account.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

Account.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

Account.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Referencestring

Account.Audit.Created.Atstring (date-time)

Account.Audit.Created.ByIdstring

Account.Audit.Created.By.Namestring

Account.Audit.Created.By.Iconstring

Account.Audit.Created.By.HasIconboolean

Account.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Created.By.Referencestring

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

atnullable string (date-time)

byobject

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

Account.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Account.Audit.Created.By.Idstring

Account.Audit.Created.By.SystemIdinteger (int32)

Account.Audit.Updated.Atstring (date-time)

Account.Audit.Updated.ByIdstring

Account.Audit.Updated.By.Namestring

Account.Audit.Updated.By.Iconstring

Account.Audit.Updated.By.HasIconboolean

Account.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Updated.By.Referencestring

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

Account.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

atnullable string (date-time)

byobject

Account.Audit.Updated.By.Idstring

Account.Audit.Updated.By.SystemIdinteger (int32)

Account.Idstring

Account.SystemIdinteger (int32)

Namestring

Sellersarray of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Contact.Namestring

Contact.FirstNamestring

Contact.LastNamestring

Contact.Emailstring

Contact.Phone.Prefixstring

Contact.Phone.Numberstring

Contact.User.Emailstring

Contact.User.Statusstring

Contact.User.Phone.Prefixstring

Contact.User.Phone.Numberstring

Contact.User.FirstNamestring

Contact.User.LastNamestring

Contact.User.Iconstring

Contact.User.IconFileIdstring

Contact.User.LastLoginAtstring (date-time)

Contact.User.Settings.CultureCodestring

Contact.User.Settings.LanguageCodestring

Contact.User.Namestring

Contact.User.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)

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

Contact.User.CurrentAccount.ExternalIdstring

Contact.User.CurrentAccount.ExternalNamestring

Contact.User.CurrentAccount.TypeAccountType (enum)

ClientVendorOperations

Contact.User.CurrentAccount.StatusAccountStatus (enum)

ActiveEnabledDisabled

Contact.User.CurrentAccount.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Contact.User.CurrentAccount.Address.AddressLine1string

Contact.User.CurrentAccount.Address.AddressLine2string

Contact.User.CurrentAccount.Address.PostCodestring

Contact.User.CurrentAccount.Address.Citystring

Contact.User.CurrentAccount.Address.Statestring

Contact.User.CurrentAccount.Address.Countrystring

Contact.User.CurrentAccount.Iconstring

Contact.User.CurrentAccount.IconFileIdstring

Contact.User.CurrentAccount.TechnicalSupportEmailstring

Contact.User.CurrentAccount.Websitestring

Contact.User.CurrentAccount.Descriptionstring

Contact.User.CurrentAccount.Namestring

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Referencestring

Contact.User.CurrentAccount.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Namestring

Contact.User.CurrentAccount.Audit.Created.By.Iconstring

Contact.User.CurrentAccount.Audit.Created.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Created.By.Referencestring

Contact.User.CurrentAccount.Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Created.By.Idstring

Contact.User.CurrentAccount.Audit.Created.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Namestring

Contact.User.CurrentAccount.Audit.Updated.By.Iconstring

Contact.User.CurrentAccount.Audit.Updated.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Updated.By.Referencestring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Updated.By.Idstring

Contact.User.CurrentAccount.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Idstring

Contact.User.CurrentAccount.SystemIdinteger (int32)

Contact.User.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Referencestring

Contact.User.Audit.InvitationAcceptedAtstring (date-time)

Contact.User.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Namestring

Contact.User.Audit.Created.By.Iconstring

Contact.User.Audit.Created.By.HasIconboolean

Contact.User.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Created.By.Referencestring

Contact.User.Audit.Created.By.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.By.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

Contact.User.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Created.By.Idstring

Contact.User.Audit.Created.By.SystemIdinteger (int32)

Contact.User.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Namestring

Contact.User.Audit.Updated.By.Iconstring

Contact.User.Audit.Updated.By.HasIconboolean

Contact.User.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Updated.By.Referencestring

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

Contact.User.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.By.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Idstring

Contact.User.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.Idstring

Contact.User.SystemIdinteger (int32)

Contact.Typestring

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

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/buyers', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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/buyers

Body

buyerobject

Json representation of the buyer

ExternalIds.ErpCompanyContactstring

ExternalIds.ErpCustomerstring

ExternalIds.AccountExternalIdstring

StatusBuyerStatus (enum)

ActiveEnabledDisabledDeletedUnassignedConflict

Iconstring

IconFileIdstring

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

TaxIdstring

Account.ExternalIdstring

Account.ExternalNamestring

Account.TypeAccountType (enum)

ClientVendorOperations

Account.StatusAccountStatus (enum)

ActiveEnabledDisabled

Account.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Account.Address.AddressLine1string

Account.Address.AddressLine2string

Account.Address.PostCodestring

Account.Address.Citystring

Account.Address.Statestring

Account.Address.Countrystring

Account.Iconstring

Account.IconFileIdstring

Account.TechnicalSupportEmailstring

Account.Websitestring

Account.Descriptionstring

Account.Namestring

Account.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

Account.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

Account.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Referencestring

Account.Audit.Created.Atstring (date-time)

Account.Audit.Created.ByIdstring

Account.Audit.Created.By.Namestring

Account.Audit.Created.By.Iconstring

Account.Audit.Created.By.HasIconboolean

Account.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Created.By.Referencestring

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

atnullable string (date-time)

byobject

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

Account.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Account.Audit.Created.By.Idstring

Account.Audit.Created.By.SystemIdinteger (int32)

Account.Audit.Updated.Atstring (date-time)

Account.Audit.Updated.ByIdstring

Account.Audit.Updated.By.Namestring

Account.Audit.Updated.By.Iconstring

Account.Audit.Updated.By.HasIconboolean

Account.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Updated.By.Referencestring

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

Account.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

atnullable string (date-time)

byobject

Account.Audit.Updated.By.Idstring

Account.Audit.Updated.By.SystemIdinteger (int32)

Account.Idstring

Account.SystemIdinteger (int32)

Namestring

Sellersarray of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Contact.Namestring

Contact.FirstNamestring

Contact.LastNamestring

Contact.Emailstring

Contact.Phone.Prefixstring

Contact.Phone.Numberstring

Contact.User.Emailstring

Contact.User.Statusstring

Contact.User.Phone.Prefixstring

Contact.User.Phone.Numberstring

Contact.User.FirstNamestring

Contact.User.LastNamestring

Contact.User.Iconstring

Contact.User.IconFileIdstring

Contact.User.LastLoginAtstring (date-time)

Contact.User.Settings.CultureCodestring

Contact.User.Settings.LanguageCodestring

Contact.User.Namestring

Contact.User.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)

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

Contact.User.CurrentAccount.ExternalIdstring

Contact.User.CurrentAccount.ExternalNamestring

Contact.User.CurrentAccount.TypeAccountType (enum)

ClientVendorOperations

Contact.User.CurrentAccount.StatusAccountStatus (enum)

ActiveEnabledDisabled

Contact.User.CurrentAccount.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Contact.User.CurrentAccount.Address.AddressLine1string

Contact.User.CurrentAccount.Address.AddressLine2string

Contact.User.CurrentAccount.Address.PostCodestring

Contact.User.CurrentAccount.Address.Citystring

Contact.User.CurrentAccount.Address.Statestring

Contact.User.CurrentAccount.Address.Countrystring

Contact.User.CurrentAccount.Iconstring

Contact.User.CurrentAccount.IconFileIdstring

Contact.User.CurrentAccount.TechnicalSupportEmailstring

Contact.User.CurrentAccount.Websitestring

Contact.User.CurrentAccount.Descriptionstring

Contact.User.CurrentAccount.Namestring

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Referencestring

Contact.User.CurrentAccount.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Namestring

Contact.User.CurrentAccount.Audit.Created.By.Iconstring

Contact.User.CurrentAccount.Audit.Created.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Created.By.Referencestring

Contact.User.CurrentAccount.Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Created.By.Idstring

Contact.User.CurrentAccount.Audit.Created.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Namestring

Contact.User.CurrentAccount.Audit.Updated.By.Iconstring

Contact.User.CurrentAccount.Audit.Updated.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Updated.By.Referencestring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Updated.By.Idstring

Contact.User.CurrentAccount.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Idstring

Contact.User.CurrentAccount.SystemIdinteger (int32)

Contact.User.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Referencestring

Contact.User.Audit.InvitationAcceptedAtstring (date-time)

Contact.User.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Namestring

Contact.User.Audit.Created.By.Iconstring

Contact.User.Audit.Created.By.HasIconboolean

Contact.User.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Created.By.Referencestring

Contact.User.Audit.Created.By.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.By.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

Contact.User.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Created.By.Idstring

Contact.User.Audit.Created.By.SystemIdinteger (int32)

Contact.User.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Namestring

Contact.User.Audit.Updated.By.Iconstring

Contact.User.Audit.Updated.By.HasIconboolean

Contact.User.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Updated.By.Referencestring

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

Contact.User.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.By.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Idstring

Contact.User.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.Idstring

Contact.User.SystemIdinteger (int32)

Contact.Typestring

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

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/buyers', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "href": "text",
  "icon": "text",
  "taxId": "text",
  "name": "text",
  "sellers": [
    {
      "id": "text",
      "href": "text",
      "externalId": "text",
      "icon": "text",
      "currencies": [
        "text"
      ],
      "name": "text"
    }
  ]
}

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

Path parameters

id*string

Body

buyerobject

Json representation of the buyer

ExternalIds.ErpCompanyContactstring

ExternalIds.ErpCustomerstring

ExternalIds.AccountExternalIdstring

StatusBuyerStatus (enum)

ActiveEnabledDisabledDeletedUnassignedConflict

Iconstring

IconFileIdstring

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

TaxIdstring

Account.ExternalIdstring

Account.ExternalNamestring

Account.TypeAccountType (enum)

ClientVendorOperations

Account.StatusAccountStatus (enum)

ActiveEnabledDisabled

Account.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Account.Address.AddressLine1string

Account.Address.AddressLine2string

Account.Address.PostCodestring

Account.Address.Citystring

Account.Address.Statestring

Account.Address.Countrystring

Account.Iconstring

Account.IconFileIdstring

Account.TechnicalSupportEmailstring

Account.Websitestring

Account.Descriptionstring

Account.Namestring

Account.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

Account.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

Account.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Referencestring

Account.Audit.Created.Atstring (date-time)

Account.Audit.Created.ByIdstring

Account.Audit.Created.By.Namestring

Account.Audit.Created.By.Iconstring

Account.Audit.Created.By.HasIconboolean

Account.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Created.By.Referencestring

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

atnullable string (date-time)

byobject

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

Account.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Account.Audit.Created.By.Idstring

Account.Audit.Created.By.SystemIdinteger (int32)

Account.Audit.Updated.Atstring (date-time)

Account.Audit.Updated.ByIdstring

Account.Audit.Updated.By.Namestring

Account.Audit.Updated.By.Iconstring

Account.Audit.Updated.By.HasIconboolean

Account.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Updated.By.Referencestring

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

Account.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

atnullable string (date-time)

byobject

Account.Audit.Updated.By.Idstring

Account.Audit.Updated.By.SystemIdinteger (int32)

Account.Idstring

Account.SystemIdinteger (int32)

Namestring

Sellersarray of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Contact.Namestring

Contact.FirstNamestring

Contact.LastNamestring

Contact.Emailstring

Contact.Phone.Prefixstring

Contact.Phone.Numberstring

Contact.User.Emailstring

Contact.User.Statusstring

Contact.User.Phone.Prefixstring

Contact.User.Phone.Numberstring

Contact.User.FirstNamestring

Contact.User.LastNamestring

Contact.User.Iconstring

Contact.User.IconFileIdstring

Contact.User.LastLoginAtstring (date-time)

Contact.User.Settings.CultureCodestring

Contact.User.Settings.LanguageCodestring

Contact.User.Namestring

Contact.User.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)

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

Contact.User.CurrentAccount.ExternalIdstring

Contact.User.CurrentAccount.ExternalNamestring

Contact.User.CurrentAccount.TypeAccountType (enum)

ClientVendorOperations

Contact.User.CurrentAccount.StatusAccountStatus (enum)

ActiveEnabledDisabled

Contact.User.CurrentAccount.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Contact.User.CurrentAccount.Address.AddressLine1string

Contact.User.CurrentAccount.Address.AddressLine2string

Contact.User.CurrentAccount.Address.PostCodestring

Contact.User.CurrentAccount.Address.Citystring

Contact.User.CurrentAccount.Address.Statestring

Contact.User.CurrentAccount.Address.Countrystring

Contact.User.CurrentAccount.Iconstring

Contact.User.CurrentAccount.IconFileIdstring

Contact.User.CurrentAccount.TechnicalSupportEmailstring

Contact.User.CurrentAccount.Websitestring

Contact.User.CurrentAccount.Descriptionstring

Contact.User.CurrentAccount.Namestring

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Referencestring

Contact.User.CurrentAccount.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Namestring

Contact.User.CurrentAccount.Audit.Created.By.Iconstring

Contact.User.CurrentAccount.Audit.Created.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Created.By.Referencestring

Contact.User.CurrentAccount.Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Created.By.Idstring

Contact.User.CurrentAccount.Audit.Created.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Namestring

Contact.User.CurrentAccount.Audit.Updated.By.Iconstring

Contact.User.CurrentAccount.Audit.Updated.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Updated.By.Referencestring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Updated.By.Idstring

Contact.User.CurrentAccount.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Idstring

Contact.User.CurrentAccount.SystemIdinteger (int32)

Contact.User.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Referencestring

Contact.User.Audit.InvitationAcceptedAtstring (date-time)

Contact.User.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Namestring

Contact.User.Audit.Created.By.Iconstring

Contact.User.Audit.Created.By.HasIconboolean

Contact.User.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Created.By.Referencestring

Contact.User.Audit.Created.By.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.By.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

Contact.User.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Created.By.Idstring

Contact.User.Audit.Created.By.SystemIdinteger (int32)

Contact.User.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Namestring

Contact.User.Audit.Updated.By.Iconstring

Contact.User.Audit.Updated.By.HasIconboolean

Contact.User.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Updated.By.Referencestring

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

Contact.User.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.By.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Idstring

Contact.User.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.Idstring

Contact.User.SystemIdinteger (int32)

Contact.Typestring

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

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

Buyer

Buyer Object

The buyer object represents an individual buyer in the Marketplace platform. This object contains the following properties:

Field

Type

Description

id

string

Primary buyer identifier.

Example: "BUY-1234-1234"

href

string

Relative reference to object on API.

Example: "/v1/accounts/buyers/BUY-1234-1234"

status

string

Status: Enabled, Active, Disabled, Deleted

name

string

Buyer's name.

Example: "Stark Industries"

icon

string

Relative path to buyer’s logo.

Example: "/static/accounts/BUY-1234-1234/logo.png"

externalIds

BuyerExternalIdsObject

External identifier.

Example:

{
 "erpCompanyContact": "WW-CON-123456",
 "erpCustomer": "WW-SCU-123456"
}

address

object

Address of the buyer.

Example:

{
  "addressLine1": "123 Main Street",
  "addressLine2": "Apt 4B",
  "postCode": "12345",
  "city": "Cityville",
  "state": "S",
  "country": "ST"
}

taxId

string

Buyer's tax ID.

Example: "12-34567890"

account

Buyer’s account object.

sellers

contact

object

Contact person details.

Example:

{
	"name": "Will Smith",
	"firstName": "Will",
	"lastName": "Smith",
	"email": "will.smith@adastraflex.com",
	"phone": null,
	"user": {
		"id": "USR-0000-0001",
		"href": "/users/USR-0000-0001",
		"icon": null,
		"name": "Will Smith"
	}
}

audit

object

Possible audit events: Created, Updated, Disabled, Enabled, Activated.

Example:

{
  "created": { "at": "...", "by": { } },
  "updated": { "at": "...", "by": { } },
  "disabled": { "at": "...", "by": { } },
  "enabled": { "at": "...", "by": { } },
  "activated": { "at": "...", "by": { } },
  "deleted": { "at": "...", "by": { } }
}

Example

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "will.smith@adastraflex.com",
		"phone": null
	},
	"externalIds": {
		"erpCompanyContact": "WW-CON-123456",
		"erpCustomer": "WW-SCU-123456"
    },
	"status": "Active",
	"icon": null,
	"address": {
		"addressLine1": "PO Box 31",
		"addressLine2": "Victory Road",
		"postCode": "DE24 8BJ",
		"city": "Derby",
		"state": "Derbs",
		"country": "UK"
	},
	"taxId": "VAT1",
	"name": "Stark Industries"
}

{
	"id": "BUY-3911-2313",
	"href": "/accounts/buyers/BUY-3911-2313",
	"contact": {
		"name": "Will Smith",
		"firstName": "Will",
		"lastName": "Smith",
		"email": "will.smith@adastraflex.com",
		"phone": null,
		"user": {
			"id": "USR-0000-0001",
			"href": "/users/USR-0000-0001",
			"icon": null,
			"invited": "2024-02-03T11:34:15.381Z",
			"joined": "2024-02-04T12:34:15.381Z",
			"lastLogin": "2024-02-05T13:34:15.381Z",
			"name": "Will Smith"
		}
	},
    "externalIds": {
		"erpCompanyContact": "WW-CON-123456",
		"erpCustomer": "WW-SCU-123456"
    },
	"status": "Active",
	"icon": null,
	"address": {
		"addressLine1": "PO Box 31",
		"addressLine2": "Victory Road",
		"postCode": "DE24 8BJ",
		"city": "Derby",
		"state": "Derbs",
		"country": "UK"
	},
	"taxId": "VAT1",
	"account": {
		"id": "ACC-5563-4382",
		"href": "/accounts/accounts/ACC-5563-4382",
		"type": "Client",
		"status": "Active",
		"icon": null,
		"name": "AdAstraflexx"
	},
	"name": "Stark Industries",
	"sellers": [
		{
			"id": "SEL-1299-2079",
			"href": "/accounts/sellers/SEL-1299-2079",
			"externalId": "SWO_CH",
			"name": "SoftwareOne AG"
		}
	],
	"audit": {
		"created": {
			"at": "2023-12-14T13:44:20.896Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		},
		"updated": {
			"at": "2024-01-06T19:04:16.692Z",
			"by": {
				"id": "USR-0000-0001",
				"href": "/users/USR-0000-0001",
				"icon": null,
				"invited": "2024-02-03T11:34:15.383Z",
				"joined": "2024-02-04T12:34:15.383Z",
				"lastLogin": null,
				"name": "Will Smith"
			}
		}
	}
}

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

Path parameters

id*string

Body

buyerobject

Json representation of the buyer

ExternalIds.ErpCompanyContactstring

ExternalIds.ErpCustomerstring

ExternalIds.AccountExternalIdstring

StatusBuyerStatus (enum)

ActiveEnabledDisabledDeletedUnassignedConflict

Iconstring

IconFileIdstring

Address.AddressLine1string

Address.AddressLine2string

Address.PostCodestring

Address.Citystring

Address.Statestring

Address.Countrystring

TaxIdstring

Account.ExternalIdstring

Account.ExternalNamestring

Account.TypeAccountType (enum)

ClientVendorOperations

Account.StatusAccountStatus (enum)

ActiveEnabledDisabled

Account.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Account.Address.AddressLine1string

Account.Address.AddressLine2string

Account.Address.PostCodestring

Account.Address.Citystring

Account.Address.Statestring

Account.Address.Countrystring

Account.Iconstring

Account.IconFileIdstring

Account.TechnicalSupportEmailstring

Account.Websitestring

Account.Descriptionstring

Account.Namestring

Account.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

Account.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

Account.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Referencestring

Account.Audit.Created.Atstring (date-time)

Account.Audit.Created.ByIdstring

Account.Audit.Created.By.Namestring

Account.Audit.Created.By.Iconstring

Account.Audit.Created.By.HasIconboolean

Account.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Created.By.Referencestring

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

atnullable string (date-time)

byobject

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

Account.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Account.Audit.Created.By.Idstring

Account.Audit.Created.By.SystemIdinteger (int32)

Account.Audit.Updated.Atstring (date-time)

Account.Audit.Updated.ByIdstring

Account.Audit.Updated.By.Namestring

Account.Audit.Updated.By.Iconstring

Account.Audit.Updated.By.HasIconboolean

Account.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Account.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Account.Audit.Updated.By.Referencestring

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

Account.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

atnullable string (date-time)

byobject

Account.Audit.Updated.By.Idstring

Account.Audit.Updated.By.SystemIdinteger (int32)

Account.Idstring

Account.SystemIdinteger (int32)

Namestring

Sellersarray of SellerQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

externalIdnullable string

statusobject

iconnullable string

currenciesnullable array of string

itemsstring

addressobject

namestring

Contact.Namestring

Contact.FirstNamestring

Contact.LastNamestring

Contact.Emailstring

Contact.Phone.Prefixstring

Contact.Phone.Numberstring

Contact.User.Emailstring

Contact.User.Statusstring

Contact.User.Phone.Prefixstring

Contact.User.Phone.Numberstring

Contact.User.FirstNamestring

Contact.User.LastNamestring

Contact.User.Iconstring

Contact.User.IconFileIdstring

Contact.User.LastLoginAtstring (date-time)

Contact.User.Settings.CultureCodestring

Contact.User.Settings.LanguageCodestring

Contact.User.Namestring

Contact.User.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)

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

Contact.User.CurrentAccount.ExternalIdstring

Contact.User.CurrentAccount.ExternalNamestring

Contact.User.CurrentAccount.TypeAccountType (enum)

ClientVendorOperations

Contact.User.CurrentAccount.StatusAccountStatus (enum)

ActiveEnabledDisabled

Contact.User.CurrentAccount.ServiceLevelAccountServiceLevel (enum)

ExpressEliteDscFocusRunnersStrategicsNotApplicable

Contact.User.CurrentAccount.Address.AddressLine1string

Contact.User.CurrentAccount.Address.AddressLine2string

Contact.User.CurrentAccount.Address.PostCodestring

Contact.User.CurrentAccount.Address.Citystring

Contact.User.CurrentAccount.Address.Statestring

Contact.User.CurrentAccount.Address.Countrystring

Contact.User.CurrentAccount.Iconstring

Contact.User.CurrentAccount.IconFileIdstring

Contact.User.CurrentAccount.TechnicalSupportEmailstring

Contact.User.CurrentAccount.Websitestring

Contact.User.CurrentAccount.Descriptionstring

Contact.User.CurrentAccount.Namestring

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.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

Contact.User.CurrentAccount.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Referencestring

Contact.User.CurrentAccount.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Namestring

Contact.User.CurrentAccount.Audit.Created.By.Iconstring

Contact.User.CurrentAccount.Audit.Created.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Created.By.Referencestring

Contact.User.CurrentAccount.Audit.Created.By.Audit.CreatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Created.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Created.By.Idstring

Contact.User.CurrentAccount.Audit.Created.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Audit.Updated.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Namestring

Contact.User.CurrentAccount.Audit.Updated.By.Iconstring

Contact.User.CurrentAccount.Audit.Updated.By.HasIconboolean

Contact.User.CurrentAccount.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.CurrentAccount.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.CurrentAccount.Audit.Updated.By.Referencestring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.Atstring (date-time)

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdstring

Contact.User.CurrentAccount.Audit.Updated.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.CurrentAccount.Audit.Updated.By.Audit.UpdatedQueryModelEvent (object)

atnullable string (date-time)

byobject

Contact.User.CurrentAccount.Audit.Updated.By.Idstring

Contact.User.CurrentAccount.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.CurrentAccount.Idstring

Contact.User.CurrentAccount.SystemIdinteger (int32)

Contact.User.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Referencestring

Contact.User.Audit.InvitationAcceptedAtstring (date-time)

Contact.User.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Namestring

Contact.User.Audit.Created.By.Iconstring

Contact.User.Audit.Created.By.HasIconboolean

Contact.User.Audit.Created.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Created.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Created.By.Referencestring

Contact.User.Audit.Created.By.Audit.Created.Atstring (date-time)

Contact.User.Audit.Created.By.Audit.Created.ByIdstring

Contact.User.Audit.Created.By.Audit.Created.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

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

Contact.User.Audit.Created.By.Audit.Updated.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Created.By.Idstring

Contact.User.Audit.Created.By.SystemIdinteger (int32)

Contact.User.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Namestring

Contact.User.Audit.Updated.By.Iconstring

Contact.User.Audit.Updated.By.HasIconboolean

Contact.User.Audit.Updated.By.TypeIdentityType (enum)

UserApiToken

Contact.User.Audit.Updated.By.Metadata.OmittedPropertiesarray of string

itemsstring

Contact.User.Audit.Updated.By.Referencestring

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

Contact.User.Audit.Updated.By.Audit.Created.ByIdstring

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

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Audit.Updated.Atstring (date-time)

Contact.User.Audit.Updated.By.Audit.Updated.ByIdstring

Contact.User.Audit.Updated.By.Audit.Updated.ByIdentityQueryModel (object)

idstring

auditobject

$metaobject

hrefstring

namestring

iconnullable string

Contact.User.Audit.Updated.By.Idstring

Contact.User.Audit.Updated.By.SystemIdinteger (int32)

Contact.User.Idstring

Contact.User.SystemIdinteger (int32)

Contact.Typestring

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

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