# List All

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

Endpoint: GET /guides.json
Version: 2.0.0
Security: apiKeyAuth

## Query parameters:

  - `api_key` (string, required)
    Your API Key.
    Example: "YOUR_API_KEY"

  - `Query Parameters` (object)
    Click to expand options.

## Response 200 fields (application/json):

  - `guides` (array)

  - `guides.id` (integer)
    Example: 541797

  - `guides.status` (string)
    Example: "final"

  - `guides.archived` (boolean)

  - `guides.type` (string)
    Example: "Shipping"

  - `guides.sequence_number` (string)
    Example: "1/D"

  - `guides.inverted_sequence_number` (string)
    Only present once the guide has been finalized.
    Example: "D/1"

  - `guides.atcud` (string)
    Example: "ABCD1234-1"

  - `guides.date` (string)
    dd/mm/yyyy
    Example: "13/07/2017"

  - `guides.due_date` (string)
    dd/mm/yyyy
    Example: "13/07/2017"

  - `guides.reference` (string,null)

  - `guides.observations` (string,null)
    No enforced character limit (text column).

  - `guides.retention` (string,null)

  - `guides.permalink` (string)
    Example: "https://web.invoicexpress.com/documents/541797d75bbee48911934cbd4a4294946a324295f52b08"

  - `guides.saft_hash` (string)
    Only present once the guide has been finalized.
    Example: "vaDf"

  - `guides.sum` (number)
    Example: 1

  - `guides.discount` (number)

  - `guides.before_taxes` (number)
    Example: 1

  - `guides.taxes` (number)
    Example: 0.07

  - `guides.total` (number)
    Example: 1.07

  - `guides.currency` (string)
    Example: "Euro"

  - `guides.loaded_at` (string)
    dd/mm/yyyy. Note the single-guide endpoint returns this same field with a time component (dd/mm/yyyy HH:mm:ss).
    Example: "27/07/2026"

  - `guides.license_plate` (string,null)
    255-character limit is the database column default, not an explicit business rule.
    Example: "11-AA-22"

  - `guides.at_doc_code_id` (string,null)
    Read-only. Written only by the AT gateway and never accepted on input. The 255-character limit is the database column default, not an explicit business rule.
    Example: "999"

  - `guides.sequence_id` (integer,null)
    Only present once the guide has been finalized.
    Example: 12345

  - `guides.tax_exemption` (string)
    Example: "M01"

  - `guides.address_from` (object)

  - `guides.address_from.country` (string)
    Not stored on the address itself — resolved through a tax-location name lookup, falling back to Portugal.
    Example: "Portugal"

  - `guides.address_from.postal_code` (string)
    255-character limit is the database column default on the Address model, not an explicit business rule.
    Example: "1050-083"

  - `guides.address_from.detail` (string)
    255-character limit is the database column default on the Address model, not an explicit business rule. Note the API re-inserts line breaks roughly every 35 characters before storing, so an input close to 255 characters can overflow the column — keep well under the limit.
    Example: "Avenida Duque D'Avila, 46 - 3ºA"

  - `guides.address_from.city` (string)
    255-character limit is the database column default on the Address model, not an explicit business rule.
    Example: "Lisboa"

  - `guides.address_to` (object)

  - `guides.load_site` (string,null)
    Flattened address_from (detail, postal code, city, country). Null when not set.
    Example: "Avenida Duque D'Avila, 1050-083 Lisboa, Portugal"

  - `guides.delivery_site` (string,null)
    Flattened address_to (detail, postal code, city, country). Null when not set.
    Example: "Avenida dos Aliados, 4000-327 Porto, Portugal"

  - `guides.client` (object)
    Only id and name are guaranteed; the remaining fields are present when set on the client record.

  - `guides.client.name` (string)
    Example: "John"

  - `guides.client.code` (string,null)
    255-character limit is the database column default, not an explicit business rule.
    Example: "CLI-001"

  - `guides.client.email` (string,null)
    Example: "john@example.com"

  - `guides.client.address` (string,null)
    No enforced character limit (text column).
    Example: "Avenida da República, Lisboa"

  - `guides.client.postal_code` (string,null)
    255-character limit is the database column default, not an explicit business rule.
    Example: "1050-555"

  - `guides.client.city` (string,null)
    255-character limit is the database column default, not an explicit business rule.
    Example: "Lisboa"

  - `guides.client.fiscal_id` (string,null)
    255-character limit is the database column default, not an explicit business rule.
    Example: "508025338"

  - `guides.client.country` (string)
    255-character limit is the database column default, not an explicit business rule.
    Example: "Portugal"

  - `guides.items` (array)

  - `guides.items.name` (string)
    Maximum 60 characters. V3 rejects a longer name with HTTP 422; V2 accepts the request and silently truncates the stored value to 60 characters.
    Example: "iPhone"

  - `guides.items.description` (string,null)
    Maximum 200 characters and 20 lines. V3 rejects a longer description with HTTP 422; V2 accepts the request and silently truncates the stored value to 200 characters.

  - `guides.items.unit_price` (string)
    Example: "1.0"

  - `guides.items.unit` (string,null)
    Restricted to a fixed set of unit values rather than length-limited free text.
    Example: "service"

  - `guides.items.quantity` (string)
    Example: "1.0"

  - `guides.items.tax` (object)

  - `guides.items.tax.value` (number)
    Example: 7

  - `guides.items.subtotal` (number)
    Example: 1

  - `guides.items.tax_amount` (number)
    Example: 0.07

  - `guides.items.discount_amount` (number)

  - `pagination` (object)

  - `pagination.total_entries` (integer)
    Example: 50

  - `pagination.per_page` (integer)
    Example: 20

  - `pagination.current_page` (integer)
    Example: 1

  - `pagination.total_pages` (integer)
    Example: 3

## Response 401 fields (application/json):

  - `errors` (array)

  - `errors.error` (string)
    Example: "Authentication Error"