API-v1

Application Programming Interface

InvoiceXpress Documentation



User Accounts


users.accounts

Allows you to view the InvoiceXpress accounts related to a specific user.

Field Table

Property | Description ---------- | -------- | ----------- id | Used for uniquely identifying an account url | URL to access the account api_key | The API Key for this account state | The account can be active, inactive or pending (suspended)

Usage

You call this method by submitting an HTTP GET request to the following URL:

https://www.app.invoicexpress.com/users/accounts.xml
Parameterss

Parameters are the data you will pass with the call.

Property Required Description
api_key Yes Your secret identifier. You can find your API Key under Account >> API in the Account section.
Return Values

If successful, the call will return the user accounts.

Header

Content-Type: application/xml; charset=utf-8

Body
<accounts>
  <account>
    <id>1</id>
    <name>Oils LDA</name>
    <url>https://oils.app.invoicexpress.com</url>
    <api_key>000111222333444</api_key>
    <state>active</state>
    <blocked>false</blocked>
    <roles>
      <role>administrator</role>
    </roles>
  </account>
  <account>
    <id>2</id>
    <name>Design & Code LDA</name>
    <url>https://designandcode.app.invoicexpress.com</url>
    <api_key>3kjj23kjh2kjkj2k3</api_key>
    <state>active</state>
    <blocked>true</blocked>
    <roles>
      <role>contributor</role>
    </roles>
  </account>
</accounts>

In case of error it will return:

Code Description
HTTP: 401 Access denied The API Key parameter is missing or was incorrectly entered.

Engenharia e Design ao seu serviço!

Uma equipa de Engenharia e Produto que pensam, desenham e executam em detalhe cada pormenor da experiência dos utilizadores.

Uma equipa ao seu dispor que trabalha diariamente para si.

Conhecer o InvoiceXpress