Faturas

Listar todas as Faturas

Listar Faturas

GET /faturas/listar

Lista todas as faturas existentes na base de consulta.

Filtros estão disponíveis

Query Parameters

Name	Type	Description
id_dominio	Number	filtra pelo id de um domínio
id_conta	Number	Filtra pelo id de uma conta/serviço
id_cliente	Number	Filtra pelo id do cliente obtido em outras consultas
status	String	Filtra pelo status da fatura S -> Pago C -> Cancelada N -> Em Aberto R -> Reembolsada
registros	Number	Quantidade de registros a serem listados por consulta (pagina) Se não informado, adota 20 por padrão
pagina	Number	Página atual da consulta (registros listados em paginação) padrão: 1

200: OK Retorna objeto com a lista de faturas

{
    "status": "sucesso",
    "dados": {
        "total_registros": 277,
        "paginas": 139,
        "pagina": 1,
        "mostrando": "Registros de 1 até 2",
        "faturas": [
            {
                "id_fatura": "6",
                "numero": "6",
                "id_cliente": "1",
                "id_pedido": "0",
                "id_afiliado": "0",
                "data_cadastro": "2014-02-21",
                "data_vencimento": "2014-02-21",
                "forma_pagamento": "boletoBancario",
                "valor": "64.00",
                "valor_pago": "64.00",
                "data_pagamento": "2014-02-26 20:27:04",
                "notas": "",
                "status": "S",
                "multa": "1",
                "nosso_numero": "0",
                "itens": [
                    {
                        "tipo": [
                            "0",
                            "Avulso"
                        ],
                        "servico": "0",
                        "descricao": "Giga 2 b - fernandoguga.com.br de 21/02/2014 a 21/03/2014",
                        "valor": "10.00"
                    },
                    {
                        "tipo": [
                            "0",
                            "Avulso"
                        ],
                        "servico": "0",
                        "descricao": "registro do domínio fernandoguga.com.br - 21/02/2014 a 21/02/2015",
                        "valor": "10.00"
                    },
                    {
                        "tipo": [
                            "1",
                            "Conta/Serviço"
                        ],
                        "servico": "2",
                        "descricao": "Giga 2 b - fernandoguga.com.br de 08/03/2014 a 07/04/2014",
                        "valor": "14.00"
                    },
                    {
                        "tipo": [
                            "3",
                            "Domínio"
                        ],
                        "servico": "1",
                        "descricao": "Registro/Renovação do domínio fernandoguga.com.br - de 08/03/2014 a 07/03/2015",
                        "valor": "30.00"
                    }
                ],
                "url_fatura": "http://urlhostmgr/detalhesfatura.php?ID=4346&token=d005d16a6339c039ea898882da679849"
            },
            {
                "id_fatura": "7",
                "numero": "7",
                "id_cliente": "1",
                "id_pedido": "0",
                "id_afiliado": "0",
                "data_cadastro": "2018-09-05",
                "data_vencimento": "2018-09-05",
                "forma_pagamento": "itauShopLine",
                "valor": "4.90",
                "valor_pago": "9.60",
                "data_pagamento": "2018-09-25 16:42:01",
                "notas": null,
                "status": "S",
                "multa": "1",
                "nosso_numero": null,
                "itens": [
                    {
                        "tipo": [
                            "0",
                            "Avulso"
                        ],
                        "servico": "0",
                        "descricao": "teste",
                        "valor": "4.80"
                    },
                    {
                        "tipo": [
                            "0",
                            "Avulso"
                        ],
                        "servico": "0",
                        "descricao": "Multa por atraso no pagamento",
                        "valor": "0.10"
                    }
                ],
                "url_fatura": "http://urlhostmgr/detalhesfatura.php?ID=4346&token=d005d16a6339c039ea898882da679849"
            }
        ]
    }
}

404: Not Found Objeto contendo erro

{
    "status": "erro",
    "dados": "não há faturas cadastradas"
}

Busca um cliente determinado

Busca dados de uma fatura determinada

GET /faturas/listar/{ID}

responsável por listar dados de uma fatura.

Path Parameters

Name	Type	Description
ID	Number	ID da fatura.

200: OK retorna um Objeto com os dados do cliente

{
    "status": "sucesso",
    "dados": [
        {
            "id_fatura": "7",
            "numero": "7",
            "id_cliente": "1",
            "id_pedido": "0",
            "id_afiliado": "0",
            "data_cadastro": "2018-09-05",
            "data_vencimento": "2018-09-05",
            "forma_pagamento": "itauShopLine",
            "valor": "4.90",
            "valor_pago": "9.60",
            "data_pagamento": "2018-09-25 16:42:01",
            "notas": null,
            "status": "S",
            "multa": "1",
            "nosso_numero": null,
            "itens": [
                {
                    "tipo": [
                        "0",
                        "Avulso"
                    ],
                    "servico": "0",
                    "descricao": "teste",
                    "valor": "4.80"
                },
                {
                    "tipo": [
                        "0",
                        "Avulso"
                    ],
                    "servico": "0",
                    "descricao": "Multa por atraso no pagamento",
                    "valor": "0.10"
                }
            ],
            "url_fatura": "http://urlhostmgr/detalhesfatura.php?ID=4346&token=d005d16a6339c039ea898882da679849"
        }
    ]
}
```

404: Not Found Erro na consulta

{
    "status": "erro",
    "dados": "Fatura não encontrada"
}