v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB

Estimates

Get Estimate

get/{estimates-type}/{document-id}.json

Path parameters

document-idinteger required

Example:1050

The ID of the document.

estimates-type'quotes' | 'proformas' | 'fees_notes' required

The type of the estimate document.

Query parameters

api_keystring required

Example:YOUR_API_KEY

Your API Key.

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

{
  "quote": {
    "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": 628535,
      "name": "John Doe",
      "code": "C1",
      "country": "Portugal",
      "email": "john@example.com"
    },
    "items": [
      {
        "name": "Product A",
        "description": "Big Product",
        "unit_price": 100,
        "quantity": 1,
        "unit": "un",
        "tax": {
          "name": "IVA23",
          "value": 23
        },
        "total": 123
      }
    ]
  }
}