InvoiceXpress API

schedules.get

Returns a specific schedule.

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

https://:screen-name.invoicexpress.net/schedules/:schedule-id.xml

Parameters

Parameters are the data you will pass with the call.

api_key

Your secret identifier. Your API Key is on Account Overview in the Account section.
Rules: Required

schedule-id

Requested schedule id.
Rules: Required

Return Values

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

Success

<?xml version="1.0" encoding="UTF-8"?>
<schedule>
   <id>26</id>
   <next_date>30/01/2010</next_date>
   <next_due_date>30/01/2010</next_due_date>
   <reference></reference>
   <observations></observations>
   <retention>4.0</retention>
   <client>
     <name>Chuck Norris</name>
     <email>client@email.com</email>
     <address></address>
     <postal_code></postal_code>
     <fiscal_id></fiscal_id>
   </client>
   <currency>Euro</currency>
   <items type="array">
     <item>
       <id>21</id>
       <name>Product x</name>
       <description></description>
       <unit_price>3.0</unit_price>
       <quantity>2.0</quantity>
       <tax>
         <name>IVA20</name>
         <value>20.0</value>
       </tax>
       <discount>4.0</discount>
     </item>
     <item>
       <id>16</id>
       <name>Product y</name>
       <description></description>
       <unit_price>0.0</unit_price>
       <quantity>3.0</quantity>
       <tax>
         <name>IVA20</name>
         <value>20.0</value>
       </tax>
       <discount>0.0</discount>
     </item>
   </items>
   <sum>6.0</sum>
   <discount>0.24</discount>
   <before_taxes>5.76</before_taxes>
   <taxes>1.15</taxes>
   <total>6.68</total>
 </schedule>

Error

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