Sign in

v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB
Invoices

Generate Payment

post/documents/{document-id}/partial_payments.json

Path parameters

document-idinteger required
Example:1050

The ID of the document.

Query parameters

api_keystring required
Example:YOUR_API_KEY

Your API Key.

Request body

Example request

{
  "partial_payment": {
    "amount": 10,
    "payment_mechanism": "TB",
    "note": "Transfer",
    "payment_date": "22/11/2025"
  }
}

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

{
  "receipt": {
    "id": 2137287,
    "status": "final",
    "type": "Invoice",
    "sequence_number": "6/G",
    "inverted_sequence_number": "G/6",
    "atcud": "ABCD1234-6",
    "sequence_id": "12345",
    "tax_exemption": "M01",
    "date": "04/08/2016",
    "due_date": "19/08/2016",
    "reference": "ref123",
    "observations": "Observations",
    "retention": "0",
    "permalink": "https://www.app.invoicexpress.com/documents/...",
    "saft_hash": "J4ay",
    "sum": 24.39,
    "before_taxes": 24.39,
    "taxes": 5.61,
    "total": 30,
    "currency": "Euro",
    "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
      }
    ],
    "mb_reference": {
      "entity": "10611",
      "reference": "123 456 789",
      "value": 123.45
    }
  }
}