Sign in
Guides

List All

Returns a list of guides (Shippings, Transports and Devolutions).

get/guides.json

Query parameters

api_keystring required
Example:YOUR_API_KEY

Your API Key.

textstring

Search for guide, client or item details.

type[]string[] required

Type(s) of document.

status[]string[] required

Status(es) of document.

non_archivedboolean required

Show non-archived documents.

archivedboolean

Include archived docs

loaded_at[from]string

Date in format dd/mm/yyyy.

loaded_at[to]string

Date in format dd/mm/yyyy.

pageinteger

Page number

per_pageinteger

Items per page

Click to expand options.

{
  "type[]": [
    "Shipping"
  ],
  "status[]": [
    "sent"
  ],
  "non_archived": true
}

Response

SUCCESS

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

{
  "guides": [
    {
      "id": 541797,
      "status": "final",
      "type": "Shipping",
      "sequence_number": "1/D",
      "inverted_sequence_number": "D/1",
      "atcud": "ABCD1234-1",
      "date": "13/07/2017",
      "due_date": "13/07/2017",
      "permalink": "https://web.invoicexpress.com/documents/541797d75bbee48911934cbd4a4294946a324295f52b08",
      "saft_hash": "vaDf",
      "sum": 1,
      "before_taxes": 1,
      "taxes": 0.07,
      "total": 1.07,
      "currency": "Euro",
      "loaded_at": "27/07/2026",
      "license_plate": "11-AA-22",
      "at_doc_code_id": "999",
      "sequence_id": 12345,
      "tax_exemption": "M01",
      "address_from": {
        "country": "Portugal",
        "postal_code": "1050-083",
        "detail": "Avenida Duque D'Avila, 46 - 3ºA",
        "city": "Lisboa"
      },
      "address_to": {
        "country": "Portugal",
        "postal_code": "4000-327",
        "detail": "Avenida dos Aliados",
        "city": "Porto"
      },
      "load_site": "Avenida Duque D'Avila, 1050-083 Lisboa, Portugal",
      "delivery_site": "Avenida dos Aliados, 4000-327 Porto, Portugal",
      "client": {
        "id": 1310176,
        "name": "John",
        "code": "CLI-001",
        "email": "john@example.com",
        "address": "Avenida da República, Lisboa",
        "postal_code": "1050-555",
        "city": "Lisboa",
        "fiscal_id": "508025338",
        "country": "Portugal"
      },
      "items": [
        {
          "name": "iPhone",
          "unit_price": "1.0",
          "unit": "service",
          "quantity": "1.0",
          "tax": {
            "id": 31597,
            "name": "IVA7",
            "value": 7
          },
          "subtotal": 1,
          "tax_amount": 0.07,
          "total": 1.07
        }
      ]
    }
  ],
  "pagination": {
    "total_entries": 50,
    "per_page": 20,
    "current_page": 1,
    "total_pages": 3
  }
}

Changes