# List

## Lista de Fornecedores

## Fornece uma Lista de todos os fornecedores existentes.

<mark style="color:blue;">`GET`</mark> `https://api.cloudinvoice.net/suppliers/`

#### Query Parameters

| Name           | Type    | Description                                                                                                  |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| limit          | integer | Define o número de fornecedores por pesquisa.                                                                |
| offset         | integer | Indica a posição inicial da pesquisa. Retorna a lista de clientes compreendida entre offset:offset+limit.    |
| ordering       | string  | Define o campo e a direcção a usar na pesquisa.                                                              |
| search         | string  | Define o termo de pesquisa a utilizar na lista.                                                              |
| code           | integer | Código do fornecedor para pesquisa.                                                                          |
| supplier\_name | string  | <p>Nome do Fornecedor</p><p></p><p>Para pesquisa parcial pode usar o formato: "supplier\_name\_\_search"</p> |
| fiscal\_number | String  | <p>Contribuinte</p><p></p><p>Para pesquisa parcial pode usar o formato: "fiscal\_number\_\_search"</p>       |

{% tabs %}
{% tab title="Exemplo de Pedido" %}

```shell
curl https://api.cloudinvoice.net/suppliers/
    -H "Content-Type: application/json"
```

{% endtab %}

{% tab title="Exemplo de Resposta" %}

```json
{
    "limit": 10,
    "offset": 0,
    "count": 120,
    "next": "https://api.cloudinvoice.net/suppliers/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "code": 1,
            "supplier_name": "Fornecedor 1",
            "fiscal_number": "500000000",
            "fiscal_country_id": 1,
            "fiscal_country": {"code": "PT", "country_name": "Portugal"},
            "fiscal_status_type_id": 1593,
            "fiscal_status_type": {"code": "2", "description": "Sujeito Passivo de IVA"},
            "street1": "",
            "street2": "",
            "zip_code": "",
            "zip_locale": "",
            "country_id": 1,
            "country": {"code": "PT", "country_name": "Portugal"},
            "phone1": "",
            "mobile1": "",
            "email1": "",
            "total_debits": 0.0,
            "total_credits": 100.0,
            "current_balance": 100.0
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](https://apidocs.cloudinvoice.net/introducao/exemplos-de-pedidos)

{% hint style="info" %}
**Notas:** Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.
{% endhint %}