> 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/documentos/pagamentos/list.md).

# List

## Lista dos Pagamentos do Documento

## Fornece uma lista dos pagamentos do documento.

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

Nesta lista estão incluídas as seguintes naturezas: Facturas, Facturas-Recibo, Facturas-Simplificadas, Notas de Crédito e Notas de Débito.

#### Query Parameters

| Name   | Type    | Description                                                                                                 |
| ------ | ------- | ----------------------------------------------------------------------------------------------------------- |
| limit  | integer | Define o número de documentos por pesquisa.                                                                 |
| offset | integer | Indica a posição inicial da pesquisa. Retorna a lista de documentos compreendida entre offset:offset+limit. |

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

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

{% endtab %}

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

```json
{
    "limit": 10,
    "offset": 0,
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "payment_date": "2023-01-16T12:40:46.841928Z",
            "total_payment": 52.0,
            "payment_method_id": 1,
            "payment_method":{"code": 1, "description": "Dinheiro"}
        }
    ]
}
```

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