Sign in

v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB
Clients

List Client Invoices

This method allows you to obtain the invoices for a specific client. You can filter the results by document status, type and if it’s archived or not.

post/clients/{client_id}/invoices.json

Path parameters

client_idinteger required
Example:42

Filter invoices for this client.

Query parameters

api_keystring required
Example:YOUR_API_KEY

Your API Key.

pageinteger
Example:1

You can ask for a specific page of results. Defaults to 1.

per_pageinteger
Example:30

You can specify how many results you want to fetch. Defaults to 10 or value defined in account settings (10, 20 or 30).

Request body

Example request

{
  "filter": {
    "status": [
      "final"
    ],
    "by_type": [
      "Invoice"
    ],
    "archived": [
      "non_archived"
    ]
  }
}

Response

SUCCESS. Returns the client's invoices.

Example response

{
  "invoices": [
    {
      "id": 541793,
      "status": "final",
      "archived": true,
      "type": "Invoice",
      "sequence_number": "28/A",
      "inverted_sequence_number": "A/28",
      "date": "27/06/2017",
      "due_date": "27/06/2017",
      "reference": "foo",
      "observations": "foo",
      "retention": "foo",
      "permalink": "https://www.app.invoicexpress.com/documents/...",
      "saft_hash": "Tdik",
      "sum": 1,
      "before_taxes": 1,
      "taxes": 0.07,
      "total": 1.07,
      "currency": "Euro",
      "client": {
        "id": 1310176,
        "name": "John",
        "country": "Portugal"
      },
      "items": [
        {
          "name": " iPhone ",
          "description": "foo",
          "unit_price": "1.0",
          "unit": "foo",
          "quantity": "1.0",
          "tax": {
            "id": 31597,
            "name": "IVA7",
            "value": 7
          },
          "subtotal": 1,
          "tax_amount": 0.07,
          "total": 1.07
        }
      ],
      "sequence_id": "12345",
      "tax_exemption": "M01"
    }
  ],
  "pagination": {
    "total_entries": 6,
    "current_page": 1,
    "total_pages": 1,
    "per_page": 10
  }
}