Agenda de liberação por dia — recebíveis pendentes pela data prevista de liberação, garantia pela data de devolução, e os vencidos
/v1/receivables/scheduleAutentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.
Parâmetros de consulta
fromstring (date-time)Início da agenda (ISO). Padrão: hoje, 00:00 de São Paulo
tostring (date-time)Fim da agenda (ISO, exclusivo). Padrão: 30 dias depois do início; teto 366
Respostas
200Sucesso
tostringobrigatórioFim da janela (ISO 8601, exclusivo).
daysobject[]obrigatórioOs dias da janela que têm algo a liberar, em ordem.
+4 campos de
daysdatestringobrigatórioO dia (
YYYY-MM-DD).countintegerobrigatórioQuantos recebíveis.
pendingCentsintegerobrigatórioRecebíveis pendentes com liberação prevista para o dia, em centavos.
warrantyCentsintegerobrigatórioRetenções de garantia a devolver no dia, em centavos.
fromstringobrigatórioInício da janela (ISO 8601).
totalsobjectobrigatórioAs somas da janela.
+3 campos de
totalscountintegerobrigatórioTotal de recebíveis na janela.
pendingCentsintegerobrigatórioTotal pendente na janela, em centavos.
warrantyCentsintegerobrigatórioTotal de garantia a devolver na janela, em centavos.
overdueobjectobrigatórioRecebíveis cuja data de liberação já passou e seguem pendentes.
+2 campos de
overduecountintegerobrigatórioQuantos recebíveis atrasados.
pendingCentsintegerobrigatórioValor atrasado, em centavos.
environmentstringobrigatórioO ambiente da agenda:
liveousandbox.Valores:livesandbox
400Requisição inválida (validação)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
401Não autenticado (credencial ausente ou inválida)
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
403Sem permissão
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório
500Erro interno do servidor
errorobjectobrigatório+8 campos de
errorcodestringobrigatórioparamsobject[]statusstringobrigatóriodetailsstringmessagestringobrigatóriocategorystringobrigatórioValores:validationauthenticationauthorizationpaymentclientserverrate_limitpendingresourcestringobrigatóriostatusCodeintegerobrigatório