API-v1

Application Programming Interface

InvoiceXpress Documentation



Get


debit-notes.get

Returns a specific debit-note.

Usage

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

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

Parameters

Parameter Required Description
api_key Yes Your secret identifier. You can find your API Key under Account >> API in the Account section.
debit-note-id Yes The requested debit-note id.

Return Values

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

Success
<debit_note>
  <id>541091</id>
  <status>final</status>
  <archived>false</archived>
  <type>DebitNote</type>
  <sequence_number>64/A</sequence_number>
  <inverted_sequence_number>A/64</inverted_sequence_number>
  <date>11/05/2015</date>
  <due_date>10/07/2015</due_date>
  <reference></reference>
  <observations>Ligar para departamento financeiro</observations>
  <retention></retention>
  <permalink>http://www.app.invoicexpress.com/documents/54109151f2d4681a26701e642d330e37ef6c6569af2442</permalink>
  <saft_hash>tTV7</saft_hash>
  <client>
    <id>233430</id>
    <name>Ricardo Pereira</name>
    <code></code>
    <email>someone@example.com</email>
    <address></address>
    <city></city>
    <postal_code>1234-555</postal_code>
    <country>Portugal</country>
    <fiscal_id>508025338</fiscal_id>
    <website>www.invoicexpress.com</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>
        <id>31321</id>
        <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>
Error
Code Description
HTTP: 401 Access denied The API Key parameter is missing or is incorrectly entered.
HTTP: 404 Not Found No debit-note matches the supplied {debit-note-id}.

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