Linhas - List

Lista das Linhas do Documento

Fornece uma Lista das linhas do documento existentes.

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

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

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 2,
    "next": null,
    "previous": null,
    "results":[
        {
            "id": 25960,
            "line_number": 1,
            "line_subitem": 0,
            "code": "ANEST11",
            "description": "Atropina",
            "short_description": "Atropina",
            "has_lots": false,
            "use_serial_number": false,
            "base_qty": 2.0,
            "global_discount1": 0.0,
            "line_discount1": 0.0,
            "line_discount2": 0.0,
            "line_discount3": 0.0,
            "total_gross_amount": 50.0,
            "total_discount_amount": 0.0,
            "total_net_amount": 47.1698113208,
            "total_taxes_amount": 2.8301886792,
            "line_unit_value": 25.0,
            "line_total_value": 50.0,
            "use_sizes_colors": false,
            "base_measure_unit_id": 1,
            "base_measure_unit":{"code": "UNI", "description": "Unidade"},
            "vat_tax_id": 3,
            "vat_tax":{"description": "Taxa Reduzida", "tax_rate": 6.0}
        },
        {
            "id": 25961,
            "line_number": 2,
            "line_subitem": 0,
            "code": "MAT44",
            "description": "Alfaxalona",
            "short_description": "Alfaxalona",
            "has_lots": false,
            "use_serial_number": false,
            "base_qty": 1.0,
            "global_discount1": 0.0,
            "line_discount1": 0.0,
            "line_discount2": 0.0,
            "line_discount3": 0.0,
            "total_gross_amount": 2.0,
            "total_discount_amount": 0.0,
            "total_net_amount": 1.8867924528,
            "total_taxes_amount": 0.1132075472,
            "line_unit_value": 2.0,
            "line_total_value": 2.0,
            "use_sizes_colors": false,
            "base_measure_unit_id": 18,
            "base_measure_unit":{"code": "ML", "description": "Mililitro"},
            "vat_tax_id": 3,
            "vat_tax":{"description": "Taxa Reduzida", "tax_rate": 6.0}
        }
    ]
}

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.