> For the complete documentation index, see [llms.txt](https://apidocs.cloudinvoice.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.cloudinvoice.net/documentacao-api/metodos-de-pagamento/list.md).

# List

## Listar Métodos de Pagamento

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

#### Query Parameters

| Name                | Type    | Description                                                                                                                                                                                                                                           |
| ------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| limit               | integer | Define o número de formas de pagamento por pesquisa.                                                                                                                                                                                                  |
| offset              | integer | Indica a posição inicial da pesquisa. Retorna a lista de formas de pagamento compreendida entre offset:offset+limit.                                                                                                                                  |
| ordering            | string  | <p>Define o campo e a direcção a usar na pesquisa de formas de pagamento. </p><p></p><p>Campos ordenáveis: id, code, description, where\_to\_use, payment\_mechanism. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.</p> |
| search              | string  | <p>Define o termo de pesquisa a utilizar na lista de formas de pagamento. </p><p></p><p>Campos Pesquisados: Descrição</p>                                                                                                                             |
| code                | string  | <p>Código da Forma de Pagamento.</p><p></p><p>Para pesquisa parcial pode usar o formato: "code\_\_search"</p>                                                                                                                                         |
| description         | string  | <p>Descrição da Forma de Pagamento. </p><p></p><p>Para pesquisa parcial pode usar o formato: "description\_\_search"</p>                                                                                                                              |
| does\_add\_to\_till | boolean | Adiciona à Caixa                                                                                                                                                                                                                                      |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 48,
    "next": "https://api.cloudinvoice.net/payment_methods/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": 1,
            "description": "Dinheiro",
            "where_to_use_id": 58,
            "where_to_use": {
                "id": 58,
                "description1": "Ambos"
            },
            "payment_mechanism_id": 61,
            "payment_mechanism": {
                "id": 61,
                "description1": "Numerário"
            },
            "does_add_to_till": true,
            "obs": ""
        },
        ...

    ]
}
```

{% endtab %}
{% endtabs %}

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

{% 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 %}