Skip to main content
Version: 8.1.x

accounts

Entry Point: /accounts/{scope}

The accounts resource provides access to the details of an organizational account. Using the resource you can retrieve account attribute values.You can also retrieve the accounts’s purchases through this resource.

Read Account List​

Retrieve a list of accounts that the logged-in user is associated to.

Workflow​

  1. Start with root
  2. GET the link with rel: defaultprofile
  3. GET the link with rel: accounts
  4. Render the response

Read Account​

Retrieve read/write attributes on an account.

Workflow​

  1. Start with root
  2. GET the link with rel: defaultprofile
  3. GET the link with rel: accounts
  4. GET the link with rel: element
  5. Render the response

Response Fields​

Type: accounts.account​

NameDescriptionType
business-nameAccount’s business name.string
business-numberAccount’s business number.string
faxAccount’s fax number.string
phoneAccount’s phone number.string
tax-exemption-idAccount’s tax exemption ID.string

Read Attributes From Account​

Retrieve a list of read-only attributes for the account.

Workflow​

  1. Start with root
  2. GET the link with rel: defaultprofile
  3. GET the link with rel: accounts
  4. GET the link with rel: element
  5. GET the link with rel: attributes
  6. Render the response

Read Purchases From Profile​

Retrieve a list of purchases for the logged in customer.

Workflow​

  1. GET the link with rel: defaultprofile
  2. GET the link with rel: accounts
  3. GET the link with rel: element
  4. GET the link with rel: purchases
  5. Render the response