API-v1

Application Programming Interface

InvoiceXpress Documentation



List All


debit-notes.list

Returns all your debit-notes.

Usage

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

https://{account-name}.app.invoicexpress.com/debit_notes.xml

Parameters

Parameters are the data you will pass with the call.

Property Required Description
api_key Yes Your secret identifier. You can find your API Key under Account >> API in the Account section.
page No You can ask for a specific page of debit-notes. Defaults to 1.
per_page No You can specify how many results you want to fetch. Defaults to 10 or value defined in account settings (10, 20 or 30).

Return Values

These are the results that will be returned on success and error.

Success
<debit_notes type="array">
  <debit_note>
    <id>541087</id>
    <status>draft</status>
    <archived>false</archived>
    <type>DebitNote</type>
    <sequence_number></sequence_number>
    <inverted_sequence_number></inverted_sequence_number>
    <date>07/05/2015</date>
    <due_date>06/07/2015</due_date>
    <reference></reference>
    <observations>Ligar para departamento financeiro</observations>
    <retention></retention>
    <permalink>http://www.app.invoicexpress.com/documents/541087cb7dbdb684848ceea2b564124c8aebf570372ff2</permalink>
    <client>
      <id>233387</id>
      <name>Ricardo Pereira</name>
      <email>someone@example.com</email>
      <address></address>
      <city></city>
      <postal_code></postal_code>
      <country>Portugal</country>
      <fiscal_id>508025338</fiscal_id>
      <website></website>
      <phone></phone>
      <fax></fax>
    </client>
    <currency>Euro</currency>
    <items type="array">
      <item>
        <name>MacBook Pro</name>
        <description></description>
        <unit_price>1000.0</unit_price>
        <unit></unit>
        <quantity>1.0</quantity>
        <tax>
          <name>IVA23</name>
          <value>23.0</value>
        </tax>
        <discount>0.0</discount>
        <subtotal>1000.0</subtotal>
        <tax_amount>230.0</tax_amount>
        <discount_amount>0.0</discount_amount>
        <total>1230.0</total>
      </item>
    </items>
    <sum>1000.0</sum>
    <discount>0.0</discount>
    <before_taxes>1000.0</before_taxes>
    <taxes>230.0</taxes>
    <total>1230.0</total>
  </debit_note>
  ...
<debit_notes>
Error
Code Description
HTTP: 401 Access denied The API Key parameter is missing incorrect.

Engenharia e Design ao seu serviço!

Uma equipa de Engenharia e Produto que pensam, desenham e executam em detalhe cada pormenor da experiência dos utilizadores.

Uma equipa ao seu dispor que trabalha diariamente para si.

Conhecer o InvoiceXpress