InvoiceXpress API

cash_invoices.get

Returns all the information about a cash invoice:

- Basic information (date, status, sequence number)
- Client
- Document items
- Document timeline

Document timeline is composed by:
- Date, time and the user who created it
- Type of the event

The complete list of timeline events is:

  • create
  • edited
  • send_email
  • canceled
  • deleted
  • settled
  • second_copy
  • archived
  • unarchived
  • comment

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

https://:screen-name.invoicexpress.net/cash_invoices/:cash-invoice-id.xml

Parameters

Parameters are the data you will pass with the call.

api_key

Your secret identifier. You find your API Key under Account Overview in the Account section.
Rules: Required

cash-invoice-id

Requested cash invoice id.
Rules: Required

Return Values

Success

The requested cash invoice is passed back in the response.

<?xml version="1.0" encoding="UTF-8"?>
<cash_invoice>
 <id>55</id>
 <status>draft</status>
 <sequence_number>draft</sequence_number>
 <date>19/10/2009</date>
 <reference>123456</reference>
 <observations>Computer Processed</observations>
 <retention>5.0</retention>
 <client>
  <id>65</id>
  <name>Client</name>
  <email>client@email.com</email>
  <address></address>
  <postal_code></postal_code>
  <fiscal_id></fiscal_id>
 </client>
 <currency>Euro</currency>
 <items>
  <item>
   <id>19</id>
   <name>Product 1</name>
   <description>Cleaning product</description>
   <unit_price>10.0</unit_price>
   <quantity>1.0</quantity>
   <unit>unit</unit>
   <tax>
    <name></name>
    <value>0.0</value>
   </tax>
   <discount>10.0</discount>
  </item>
  <item>
   <id>20</id>
   <name>Product 2</name>
   <description>Product for beauty</description>
   <unit_price>5.0</unit_price>
   <quantity>1.0</quantity>
   <unit>unit</unit>
   <tax>
    <id>19</id>
    <name>IVA20</name>
    <value>20.0</value>
   </tax>
   <discount>0.0</discount>
  </item>
 </items>
 <sum>15.0</sum>
 <discount>1.0</discount>
 <before_taxes>14.0</before_taxes>
 <taxes>1.0</taxes>
 <total>14.3</total>
</cash_invoice>

Error

HTTP: 401 Access denied
The API Key parameter is missing incorrect.
HTTP: 404 Not Found
No cash_invoice matches the supplied :cash-invoice-id.