Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Enable the previously disabled Account object.
When enabled, the account status will change to Active
if the account has ExternalId
assigned or Enabled
otherwise.
Create a new Client or Vendor Account object.
Get a single Account object by ID.
Activate the previously enabled Account object.
Gets a list of external Buyer objects that can be added to Account
Disable the Account object. Disabling prevents users from signing in
Get the Buyers collection.
Update the Account object.
Create a new Buyer object for the client account.
Validate the Account object.
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 the Buyer object. Disabled buyers cannot be used in transactions.
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:
| string | Primary account identifier. Example: "ACC-1671-0642" |
| string | Relative reference to object on API. Example: "/v1/accounts/accounts/ACC-1671-0642" |
| string | Type of the account (Client, Vendor, Operations) Example: "Client" |
| string | Status of the account (Enabled, Active, Disabled) Example: "Enabled" |
| string | Account name. Example: "Stark Industries" |
| string | Account description. Example: "Our company account" |
| string | External identifier - Customer Discount Group number. Example: "WW-1001111" |
| string | External identifier - Customer Discount Group name. Example: "Stark Industries" |
| string | Service level offered to the account (Essential, Elite, DSC) Example: "Elite" |
| object | Address of the company. Example: |
| string | Relative path to account logo. Example: "/static/accounts/ACC-1671-0642/logo.png" |
| string | Path to company’s website. Example: "https://www.example.com" |
| string | Technical support email for some corner cases. Example: "user@example.com" |
| object | Possible audit events: Created, Updated, Disabled, Enabled, or Activated. Example: |
|
Update the Buyer object. You can only update the logo and contact fields only.
Get the Sellers collection.
Get a single Seller object by ID.
Validate a Buyer object.
Delete the Buyer object.
Deactivate a seller.
When a seller is deactivated, the status changes from Active
to Offline
.
Update the seller object, except the seller status. Use the disable, activate, deactivate, and delete endpoints to manage the status.
Disable or deactivate the seller object.
When disabled, the status changes from Active
to Disabled
. Disabled sellers cannot be used in transactions.
Get a single Buyer object by ID.
Create a new Seller object.
Delete the seller object. When deleted, the status changes from Active
to Deleted
.
Get a single licensee object by ID.
Create a new licensee object.
List Licensee items in the Licensees collection.
Delete the licensee object.
Enable the previously disabled licensee object.
Disable the licensee object.
Update the licensee object.
You can update the licensee Seller
Object, except the status
(which is managed through the disable
, enable
, delete
endpoints) buyers id
and sellers id.
Activate a previously deactivated or disabled seller.
When activated, the status changes from Offline
or Disabled
to Active
.
id
string
Primary seller identifier.
Example: "SEL-1234-1234"
href
string
Relative reference to object on API.
Example: "/v1/accounts/sellers/SEL-1234-1234"
status
string
Status: Active , Disabled, Offline , Deleted
name
string
Seller's name.
Example: "SoftwareOne USA"
icon
string
Relative path to seller’s logo.
Example: "/static/accounts/SEL-1234-1234/logo.png"
externalId
string
External identifier.
Example: "WW-CON-123456"
address
object
Address of the seller.
Example:
currency
string
buyers
audit
object
Possible audit events: Created, Updated, Activated, Disabled, Deactivated, or Deleted
Example:
Get a list of modules in the platform.
Set passwords for non-SSO users during onboarding.
Unblock a previously blocked user.
Get the user groups collection.
Block a user.
Update a user group.
Create a user group for the client account.
Get a single user by ID.
Update a user.
Get a single user group by ID.
Invite a user to the account.
Delete a user group.
Get a single account user by ID.
Get a list of all platform users.
Assign an account user to a specific group.
Removes a user from a specific group.
Accepts user invitation to the account.
id
string
Primary licensee identifier.
Example: "LCE-1234-1234-1234"
href
string
Relative reference to object on API.
Example: "/v1/accounts/licensees/LIC-1234-1234-1234"
status
string
Status: Enabled
Active, Disabled, Deleted
name
string
Licensee's name.
Example: "Stark Industries Finance Dept"
icon
string
Relative path to licensee’s logo.
Example: "/static/accounts/LIC-1234-1234-1234/logo.png"
externalId
string
External identifier .
Example: "WW-CON-12345678"
useBuyerAddress
boolean
Defines whether address should be copied from buyer.
Example: "true"
address
object
Address of the licensee.
Example:
description
string
Description of the licensee.
contact
object
Contact person details.
Example:
buyer
seller
account
audit
object
Possible audit events: Created, Updated, Activated, Disabled, Deactivated, or Deleted.
Example:
id
string
Primary module identifier.
Example: "MOD-1234"
name
string
Name of the module.
Example: "Invoices"
description
string
Description of the module.
Example: "Invoices module"
accountTypes
string
Defines presence of module for each account type.
Example: ["vendor", "client", "operations"]
isEnabledByDefault
boolean
Defines whether the module is enabled by default.
Example: "true"
isConfigurable
boolean
Defines whether module’s access can be changed.
Example: "true"
id
string
Primary user identifier.
Example: "USR-1671-0642"
href
string
Relative reference to object on API (always /v1/accounts/users/{id}).
Example: "/v1/accounts/users/USR-1671-0642"
email
string
Email address of the user.
Example: "will.smith@softwareone.com"
status
string
Status of the user.
A user can have the Invited or InvitationExpired status only if they haven't joined the account.
name
string
User's name.
Example: "Will Smith"
firstName
string
First name of the user.
Example: "Will"
lastName
string
Last name of the user.
Example: "Smith"
phone
object
User's country code and phone number.
Example:
SSO
bool
Flag if a user logs using SSO.
Example: "true"
acceptedTerms
bool
Flag if user has accepted terms and conditions.
Example: "true"
accounts
List of accounts that user is added to, not returned on users account sub-collection.
Example:
groups
Groups that the user belongs to.
Example:
settings
invitation
object
Added only in context of account (on account sub-collection), and only in case of user being invited.
Example:
invitation.code
string
Invitation code sent to user to invite them to the platform.
Example: "910B14E6CB2343A09CB32F24BBC4BEF1"
invitation.status
string
Invitation status for the user in account.
Example: "Invited"
audit
object
Meaning of audit events: On GLobal User
created
- when user was created (once in lifecycle).
updated
- when user parameters changed last time.
login
- when user last time logged in.
blocked
- when user was blocked last time.
On account subcollection, in additional to above:
invited
- when user was invited into account (dropped on join).
joined
- when user was accepted invitation to account.
access
- when user last time switched to the account context.
Example:
| string | Primary group identifier. Example: "UGR-1234-1234" |
| string | Relative reference to object on API. Example: "/v1/accounts/groups/UGR-1234-1234" |
| string | Relative path to token’s logo. Example: "/static/accounts/UGR-1234-1234/logo.png" |
| string | Group name. Example: "Stark Industries" |
| string | Group description. Example: "Stark's marketing group" |
| List of modules available for the group. Example: "Invoices" |
| bool | Indicated if the user group is set as default in the account. There is only one default user-group per account. Example: "true" |
| stats | Statistics of the group. A group can be deleted only if the UsersCount is Example: |
Send new invitation when invite expires.
Create a new token object for the specific account.
Deletes a user from the account. The user remains active in the other accounts.
Get the API tokens collection.
Get all users assigned to an account.
Enable the specified token object.
Delete an existing token object.
Update the specified token object.
Disable the specified token object.
Resend an invitation to the user.
Get a single API token by ID.
id
string
Primary account user identifier.
Example: "AUSR-5709-0422-8243"
href
string
Relative reference to object on API (always /v1/accounts/account-users/{id}).
Example: "/v1/accounts/account-users/AUSR-5709-0422-8243"
user
account
invitation
Invitation.Status
Invitation information: Invited, Active, InvitationExpired
Example:
groups
List of user groups.
Example:
id
string
Primary API token identifier.
Example: "TKN-1671-0642"
href
string
Relative reference to object on API.
Example: "/v1/accounts/accounts/ACC-1671-0642/tokens/TKN-4134-7330"
name
string
Name of the token.
Example: "Robot"
description
string
Token description.
Example: "Test token"
status
string
Status of the token: Active, Disabled, Deleted
modules
At least one modules validation when creating API Token.
account
Account under which the token has been defined.
Example:
token
string
Authentication code.
Success
Redirect
Success
Success
No Content
No Content
No Content
No Content
No Content
No Content
No Content
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Created
Success
Success
Success
Success
Success
^UGR-\d\d\d\d-\d\d\d\d$
^UGR-\d\d\d\d-\d\d\d\d$
Success
^UGR-\d\d\d\d-\d\d\d\d$
^UGR-\d\d\d\d-\d\d\d\d$
Created
Success
Success
Success
Success
Success
Success
^UGR-\d\d\d\d-\d\d\d\d$
^UGR-\d\d\d\d-\d\d\d\d$
Success
Created
Success
Success
Success
Success
Created
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Success
Json representation of the account
Created
Json representation of the account
Success
Json representation of the user
Success
Json representation of the buyer
Created
Json representation of the buyer
Success
Json representation of the licensee
Created
Json representation of the licensee
Success