Sign in

v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB
Estimates

List All

Returns a list of estimates (Quotes, Proformas, Fees Notes).

get/estimates.json

Query parameters

api_keystring required
Example:YOUR_API_KEY

Your API Key.

type[]string[] required

Type(s) of document.

status[]string[] required

Status(es) of document.

non_archivedboolean required

Show non-archived documents.

archivedboolean

Include archived docs

textstring

Filter by client/doc text

due_date[from]string

Start date (dd/mm/yyyy)

due_date[to]string

End date (dd/mm/yyyy)

date[from]string

Start date (dd/mm/yyyy)

date[to]string

End date (dd/mm/yyyy)

total_before_taxes[from]number

Min value

total_before_taxes[to]number

Max value

pageinteger

Page number

per_pageinteger

Items per page

Click to expand options.

{
  "type[]": [
    "Quote"
  ],
  "status[]": [
    "sent"
  ],
  "non_archived": true
}

Response

SUCCESS

Creates a new quote, proforma or fees_note.

Possible values for field atcud:

  • ABCD1234-1 (or similar) - Unique document identifier to the Tax Authority, when the sequence is registered.
  • N/D - The document's sequence is relevant for ATCUD but is not registered in the Tax Authority.
  • N/A - The document's sequence is not relevant for ATCUD and is not registered in the Tax Authority.

Example response

{
  "estimates": [
    {
      "id": 541791,
      "status": "final",
      "type": "Quote",
      "sequence_number": "1/A",
      "inverted_sequence_number": "A/1",
      "atcud": "ABCD1234-1",
      "date": "12/06/2017",
      "due_date": "12/06/2017",
      "reference": "foo",
      "observations": "foo",
      "retention": "foo",
      "permalink": "https://www.app.invoicexpress.com/documents/541791f16ae45a73b703c684a221ef198c10020f3d56a1",
      "saft_hash": "NfTN",
      "sum": 10,
      "before_taxes": 10,
      "taxes": 2.3,
      "total": 12.3,
      "currency": "Euro",
      "sequence_id": "12345",
      "tax_exemption": "M01",
      "client": {
        "id": 1310176,
        "name": "John",
        "country": "Portugal"
      },
      "items": [
        {
          "name": "iPhone",
          "description": "foo",
          "unit_price": "10.0",
          "unit": "foo",
          "quantity": "1.0",
          "subtotal": 10,
          "tax_amount": 2.3,
          "total": 12.3,
          "tax": {
            "id": 31567,
            "name": "IVA23",
            "value": 23
          }
        }
      ]
    }
  ],
  "pagination": {
    "total_entries": 50,
    "per_page": 20,
    "current_page": 1,
    "total_pages": 3
  }
}