API

Application Programming Interface

InvoiceXpress Documentation



Authentication


users.login

This endpoint does not require an API Key to be acessible.

Instead it requires your current login and password. Upon successful login it will return all the accounts which belong to you. Use this to obtain the API Key for your accounts avoiding going through the web interface to generate them.

Field Table

Property Description
id Used for uniquely identifying an account
name Organization name
url The URL to make all REST requests for this 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 POST request to the following URL with your current credentials as XML data in the body:

https://www.app.invoicexpress.com/login.xml
Header

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

Body
<credentials>
  <login>someone@example.com</login>
  <password>mypassword</password>
</credentials>

Return Values

Success

Your current accounts are sent on a XML format. Example XML:

<accounts>
  <account>
    <id>1</id>
    <name>My Company LDA</name>
    <url>https://mycompany.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>My Other Company S.A.</name>
    <url>https://myothercompany.app.invoicexpress.com</url>
    <api_key>3330000</api_key>
    <state>active</state>
    <blocked>true</blocked>
    <roles>
      <role>contributor</role>
    </roles>
  </account>
</accounts>
Error
Code Description
HTTP: 401 Access denied Authentication failed using the submitted credentials.
HTTP: 422 Unprocessable Entity Credentials are missing.