# 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` (object)

  - `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)
    Example: "D/1"

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

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

  - `guides.due_date` (string)
    Example: "foo"

  - `guides.reference` (string)
    Example: "foo"

  - `guides.observations` (string)
    Example: "foo"

  - `guides.retention` (string)
    Example: "foo"

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

  - `guides.saft_hash` (string)
    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.address_from` (object)

  - `guides.address_from.country` (string)
    Example: "Portugal"

  - `guides.address_from.postal_code` (string)
    Example: "1050-083"

  - `guides.address_from.detail` (string)
    Example: "Avenida Duque D'Avila, 46 - 3ºA"

  - `guides.address_from.city` (string)
    Example: "Lisboa"

  - `guides.address_to` (object)

  - `guides.client` (object)

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

  - `guides.items` (array)

  - `guides.items.description` (string)
    Example: "foo"

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

  - `guides.items.unit` (string)
    Example: "foo"

  - `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)

  - `guides.sequence_id` (string)
    Example: "12345"

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

  - `guides.at_doc_code_id` (string)
    Example: "999"

  - `guides.license_plate` (string)
    Example: "11-AA-22"

  - `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` (object)

  - `errors.error` (string)
    Example: "Invalid API key"