Create

Gerar Relatório

Gera um relatório com os parâmetros indicados.

POST https://api.cloudinvoice.net/reports/new/

Request Body

Name	Type	Description
report_id*	integer	ID do Relatório Consulte a tabela Apêndice para saber mais.
initial_date*	string	Data de Início. Formato: YYYY-MM-DD
end_date*	string	Data de Fim. Formato: YYYY-MM-DD
format	string	Formato do Relatório. Por omissão, usa formato json. Formatos disponíveis: - ticket - json - csv
use_work_schedule	boolean	Usar Horário de Fecho de Caixa. Por omissão, usa falso
salesman_id	integer	ID do Vendedor. Consulte a tabela Vendedores para saber mais.
customer_id	integer	ID do Cliente. Consulte a tabela Clientes para saber mais.
product_id	integer	ID do Produto. Consulte a tabela Produtos para saber mais.

201: Created

400: Bad Request Lista de erros detectados

401 (Sem Resposta)

{
    // Response
}

403: Forbidden (Sem Resposta)

{
    // Response
}

Exemplo de Pedido

curl -X POST https://api.cloudinvoice.net/reports/new/
    -d '{
        "report_id": "1001",
        "initial_date": "2024-01-01",
        "end_date": "2024-12-31",
        "format": "json",
        "use_work_schedule": false,
        "salesman_id": 1,
        "customer_id": 1,
        "product_id": 1
    }'

Exemplo de Resposta

[
    {
        "title": "Total por Empregado",
        "header":[
            "Empregado",
            "Comissao",
            "Valor"
        ],
        "data":[
            ["Empregado 1", "0.00", "20761.91"],
            ["Empregado 2_", "0.00", "3035.22"],
            ["Gerente", "0.00", "1249.75"],
            ["Balcao", "0.00", "201.80"]
        ],
        "footer":[
            "Total",
            "0.00",
            "25248.68"
        ]
    },
    {
        "title": "Total por Empregado/Data",
        "header":[
            "Empregado",
            "Data",
            "Valor"
        ],
        "data":[
            ["Empregado 1", "2024-03-29", "37.25" ], 
            ["Empregado 1", "2024-01-03", "2.90"],
        ]
        "footer":[
            "Total",
            "",
            "25248.68"
        ]
    }
]

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