v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB

Invoices

Change Invoice State

Changes the state of invoice documents.

From	To	State on Request Body	Notes
draft	final	finalized	All documents.
draft	settled	finalized	Only invoice_receipt.
draft	deleted	deleted	All documents.
final	canceled	canceled	All documents.
settled	canceled	canceled	Only invoice_receipt.
final	settled	settled	All documents.
settled	final	unsettled	Only credit_note and debit_note.

put/{invoices-type}/{document-id}/change-state.json

Path parameters

invoices-type'invoices' | 'invoice_receipts' | 'simplified_invoices' | 'credit_notes' | 'debit_notes' required

The type of the invoice document.

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

{
  "invoice": {
    "state": "finalized",
    "message": "Wrong value"
  }
}

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

{
  "invoice": {
    "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
    }
  }
}