Saf-t PT Suportado

InvoiceXpress API

debit_notes.list

Returns all your debit notes.

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

https://screen-name.invoicexpress.net/debit_notes.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

page

You can ask a specific page of debit notes
Defaults to 1
Rules: Optional

per_page

You can specify how many results you want to fetch.
Defaults to 10
Max is 200
Rules: Optional

Return Values

This is the result that will be passed back to you.

Success

The element “results” is always returned first inside debit_notes (root level).
It contains:
- The current page
- The number of entries fetched on this request. Equal or less than specified by per_page
- The total number of entries without pagination available

<?xml version="1.0" encoding="UTF-8"?>
<debit_notes>
 <results>
  <current_page>1</current_page>
  <entries>10</entries>
  <total_entries>200</total_entries>
 </results>
 <debit_note>
  <id>55</id>
  <status>draft</status>
  <sequence_number>draft</sequence_number>
  <date>19/10/2009</date>
  <due_date>19/10/2009</due_date>
  <reference>123456</reference>
  <observations>Computer Processed</observations>
  <permalink>http://link/to/document</permalink>
  <retention>5.0</retention>
  <client>
   <id>65</id>
   <name>Client</name>
   <code>Code</code>
   <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>
 </debit_note>
 <debit_note>
  <id>56</id>
  <status>draft</status>
  <sequence_number>draft</sequence_number>
  <date>22/10/2009</date>
  <due_date>22/10/2009</due_date>
  <reference>123457</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>35</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>36</id>
    <name>Product 2</name>
    <description>Beauty product</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>
 </debit_note>
</debit_notess>

Errors

HTTP: 401 Access denied
The API Key parameter is missing incorrect.