InvoiceXpress API

purchase_orders.get

Returns a specific purchase order.

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

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

invoice-id

Requested purchase order id.
Rules: Required

Return Values

Success

The requested purchase order is passed back in the response.
HTTP: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<purchase_order>
 <id>55</id>
 <status>draft</status>
 <sequence_number>draft</sequence_number>
 <date>19/10/2009</date>
 <due_date>19/10/2009</due_date>
 <loaded_at>16/10/2009</loaded_at>
 <delivery_site>Chiado, Lisboa </delivery_site>
 <observations>Computer Processed</observations>;
 <supplier>
  <id>65</id>
  <name>Supplier</name>
  <email>supplier@email.com</email>
  <address></address>
  <postal_code></postal_code>
  <fiscal_id></fiscal_id>
 </supplier>
 <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>
</purchase_order>

Error

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