Licensees

The Licensee object represents a licensee in the Marketplace platform.

This object contains the following attributes:

Field	Type	Description
id	string	The primary identifier for the licensee. Example: LCE-1234-1234-1234
href	string	A relative reference to the object in the API. Example: /v1/accounts/licensees/LIC-1234-1234-1234"
status	string	The status of the licensee. Possible values: Enabled, Active, Disabled, or Deleted.
name	string	The licensee's name. Example: Stark Industries Finance Dept
icon	string	A relative path to the licensee’s logo. Example: /static/accounts/LIC-1234-1234-1234/logo.png
externalId	string	The external identifier. Example: WW-CON-12345678
useBuyerAddress	boolean	Defines whether the address should be copied from the buyer. Example: true
address	address	The address of the licensee. Example: { "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }
description	string	A description of the licensee.
contact	object	The details of the contact person. Example: { "name": "Will Smith", "firstName": "Will", "lastName": "Smith", "email": "[email protected]", "phone": null, "user": { "id": "USR-0000-0001", "icon": null, "name": "Will Smith" } } "addressLine1": "123 Main Street", "addressLine2": "Apt 4B", "postCode": "12345", "city": "Cityville", "state": "S", "country": "ST" }
buyer	buyer	A reference to the Buyer object.
seller	seller	A reference to the Seller object.
account	account	A reference to the Account object.
audit	object	A reference to the Audit object. Possible values: Created, Updated, Activated, Disabled, Deactivated, or Deleted.

Example

SHORT FORM

{
	"id": "LCE-8893-6916-0000",
	"contact": null,
	"name": "Stark Industries",
	"externalId": null,
	"status": "Active",
	"address": null,
	"useBuyerAddress": false,
	"icon": null,
	"description": null
}

FULL EXAMPLE