Estatísticas

O método permite recuperar estatísticas de pagamento, enviando uma solicitação POST.

O que o método permite fazer

• Retorna estatísticas sobre os estados das faturas para o período especificado.

Endpoint

POST https://api.trybit.com/v2/invoice/merchant/statistics

Cabeçalhos

Nome	Tipo	Exemplo	Descrição
Autorização*	string	Token eyJ0eXAiOiJK<...>4npi1ksS8tSY	Chave de API do projeto

Corpo da solicitação

Parâmetros principais

Nome	Tipo	Exemplo	Descrição
start*	string	01.01.2026	Data no formato «dd.mm.yyyyy»
end*	string	31.01.2026	Data no formato «dd.mm.yyyyy» Deve ser maior ou igual a start.

Exemplos de solicitação

Estes exemplos mostram como enviar uma solicitação para recuperar estatísticas sobre os estados das faturas para o período especificado.

cURL

curl -X POST https://api.trybit.com/v2/invoice/merchant/statistics \
     -H "Authorization: Token <API KEY>" \\
     -H "Content-Type: application/json" \\
     -d '{"start":"01.01.2023","end":"31.01.2023"}'

Python

JavaScript

PHP

Exemplos de resposta

Uma solicitação bem-sucedida retorna uma resposta com o status sucesso e um resultado objeto.

200: OK – Estatísticas

{
    "status": "success",
    "result": {
        "count": {
            "all": 907,
            "created": 4,
            "paid": 90,
            "overpaid": 8,
            "partial": 6,
            "canceled": 799
        },
        "amount": {
            "all": 214356.22712,
            "created": 4.0,
            "paid": 629.729137,
            "overpaid": 36.82,
            "partial": 11.4,
            "canceled": 213674.277983
        }
    }
}

Parâmetros de resposta

O resultado objeto contém:

Nome	Tipo	Exemplo	Descrição
contagem	dict	"count": { "all": 907, "created": 4, "paid": 90, "overpaid": 8, "partial": 6, "canceled": 799 }	Objeto contendo valores para o número de faturas
amount	dict	"amount": { "all": 214356.22712, "created": 4.0, "paid": 629.729137, "overpaid": 36.82, "partial": 11.4, "canceled": 213674.277983 }	Objeto contendo valores para montantes em USD
total	int, float	907 / 214356.22712	Todas as faturas
created	int, float	4 / 4.0	Faturas com o estado “Criado”
pago	int, float	90 / 629.729137	Faturas com o estado “Pago”
pago em excesso	int, float	8 / 36.82	Faturas com o estado “Pagas em excesso”
parcial	int, float	6 / 11.4	Faturas com o estado “Parcialmente pagas”
cancelado	int, float	799 / 213674.277983	Faturas com o estado “Canceladas”