Pagamentos - List

Lista dos Pagamentos do Documento

Fornece uma Lista dos pagamentos do documento existentes.

GET 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.
ordering	string	Define o campo e a direcção a usar na pesquisa de documentos. Campos ordenáveis: id, doc_key, document_date, document_time. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.
search	string	Define o termo de pesquisa a utilizar na lista de vendas. Campos Pesquisados: Id, Chave do Documento, Data do Documento
document_nature	integer	Natureza do Documento Consulte a tabela Apêndice para mais informação
document_status	integer	Estado do Documento Consulte a tabela Apêndice para mais informação

200: OK Lista de Documentos

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

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

Exemplo de Resposta

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

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.

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.