v1

latestOpenAPI 3.0.12026-08-04115177259.2 KB
Parceiros

Relatório de faturamento

Para autenticar nos endpoints de Parceiros, utilize o Token de Parceiro.<br />O token pode ser gerado na plataforma em Admin > Personalizar > Integração.<br />Envie-o no header Authorization com o schema Bearer.<br />Este token é exclusivo para os endpoints de Gestão de Contas e Parceiros. <br /><br />Retorna o relatório de faturamento do parceiro. As datas são tratadas apenas como data (dia/mês/ano), ignorando horário. Se a data inicial não for fornecida, considera o primeiro dia do mês atual. A data final é calculada automaticamente como o último dia do mês após a data inicial e retornada no campo EndBillingAt.

get/v2/partner/billing/report

Query parameters

startDatestring date-time

Data inicial para filtro (opcional). Se não informada, usa o primeiro dia do mês atual. Formato: YYYY-MM-DD

companyIdstring uuid

ID da conta para filtro (opcional)

Response

Success

partnerNamestring nullable
periodstring nullable

Período no formato YYYY-MM

qrInstanceTotalCostnumber double
customDomainnumber double
infraTotalCostnumber double
companyTotalPricenumber double
appPricenumber double
volumeDiscountPricenumber double
totalPricenumber double