List

Lista de Recibos

Fornece uma Lista dos Recibos existentes.

GET https://api.cloudinvoice.net/receipts/

Query Parameters

Name	Type	Description
limit	integer	Define o número de recibos por pesquisa.
offset	integer	Indica a posição inicial da pesquisa. Retorna a lista de recibos compreendida entre offset:offset+limit.
ordering	string	Define o campo e a direcção a usar na pesquisa de recibos. 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 documentos. Campos Pesquisados: Id, Chave do Documento, Data do Documento.
document_status	integer	Estado do Documento Consulte a tabela Apêndice para mais informação

Exemplo de Pedido

curl https://api.cloudinvoice.net/receipts/
    -H "Content-Type: application/json"

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 117,
    "next": "http://localhost:8000/api/receipts/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "doc_key": "REC A01/1",
            "document_date": "2026-03-09",
            "document_time": "13:05:09.205696",
            "document_number": 1,
            "party_reference": "",
            "module_origin": 1,
            "line_details_count": 1,
            "total_gross_amount": 1.0,
            "is_percentage_discount": true,
            "discount_percentage": 0.0,
            "total_net_amount": 0.8180337405,
            "total_amount": 1.0,
            "total_document_amount": 1.0,
            "total_received_amount": 1.0,
            "header_text": "",
            "footer_text": "",
            "number_of_prints": 7,
            "obs": "",
            "has_withholding": false,
            "document_id": 14,
            "document": {
                "code": "REC",
                "document_name": "Recibo",
                "ask_payment_onclose": true
            },
            "document_serie_id": 1,
            "document_serie": {
                "code": "A01",
                "description": "Serie A01"
            },
            "document_nature_id": 341,
            "document_nature": {
                "code": "RG",
                "description": "Recibo"
            },
            "document_status_id": 1202,
            "document_status": {
                "code": "F",
                "description": "Finalizado"
            },
            "salesman_id": null,
            "salesman": null,
            "party_id": 2,
            "party": {
                "class": 1601,
                "code": 2,
                "name": "Cliente Demo",
                "commercial_name": "",
                "fiscal_number": "123456789",
                "street1": "Rua Principal",
                "street2": "",
                "zip_code": "8800-000",
                "zip_locale": "Tavira"
            }
        },
        ...
    ]
}

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.