List

Lista de Documentos

Fornece uma Lista dos documentos existentes.

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

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 documentos. 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/
    -H "Content-Type: application/json"

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 3279,
    "next": "https://api.cloudinvoice.net/documents/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 7621,
            "doc_key": "FSI A2023-1/213",
            "document_date": "2023-01-10",
            "document_time": "11:30:48.700759",
            "document_number": 213,
            "our_reference": "",
            "is_valued": true,
            "total_amount": 54.9,
            "total_due_amount": 0.0,
            "due_date": "2023-01-10",
            "document_id": 2,
            "document": {
                "code": "FSI", 
                "document_name": "Factura Simplificada"
            },
            "document_serie_id": 6,
            "document_serie": {
                "code": "A2023-1", 
                "description": "Série A2023-1"
            },
            "document_status_id": 1202,
            "document_status": {
                "code": "F", 
                "description": "Finalizado"
            },
            "warehouse_id": 1,
            "warehouse": {
                "code": 1, 
                "description": "Armazém 1"
            },
            "document_nature_id": 302,
            "document_nature": {
                "code": "FS", 
                "description": "Factura Simplificada"
            },
            "party_id": 1,
            "party": {
                "class": 1601, 
                "code": 1, 
                "name": "Consumidor Final", 
                "fiscal_number": "999999990"
            }
        },
        ...
    ]
}

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.