v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB

Estimates

Create Estimate

Creates a new quote, proforma or fees_note.

post/{estimates-type}.json

Path parameters

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.

Request body

Example request

{
  "quote": {
    "date": "22/11/2025",
    "due_date": "22/12/2025",
    "reference": "PO-999",
    "observations": "Services rendered",
    "retention": "0",
    "tax_exemption": "M00",
    "sequence_id": "123456",
    "client": {
      "name": "Client A",
      "code": "CLI-001",
      "email": "client@mail.com",
      "address": "Street A",
      "city": "Lisbon",
      "postal_code": "1000-100",
      "fiscal_id": "500999888",
      "country": "Portugal",
      "website": "www.client-a.com",
      "phone": "912345678",
      "fax": "212345678",
      "observations": "VIP Client"
    },
    "items": [
      {
        "name": "Consulting",
        "description": "IT Services",
        "unit_price": 50,
        "quantity": 2,
        "unit": "hour",
        "tax": {
          "name": "IVA23"
        }
      }
    ],
    "mb_reference": "1",
    "auto_add_related_document": "0",
    "tax_exemption_reason": "M00"
  }
}

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
      }
    ]
  }
}