Listar parcelas
Retorna todas as parcelas, ordenadas por data de criação, com as mais recentes primeiro.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Valida se a parcela pode entrar em uma fatura de antecipação ou refinanciamento.
Com o campo definido como true
, retornará apenas parcelas pagas com valor excedente.
ID da parcela. O valor deve ser uma string ou uma lista separada por vírgula.
ID do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
Caso sejam usados os filtros payment_for
ou validate_customer_payment
, o campo loan
será obrigatório e só poderá ser informado um único ID por requisição.
Expande as referências.
Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.
Um cursor para uso na paginação. starting_after
é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo
, sua chamada subsequente poderá incluir starting_after=obj_foo
para buscar a próxima página da lista.
Um cursor para uso na paginação. starting_after
é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo
, sua chamada subsequente poderá incluir starting_after=obj_foo
para buscar a próxima página da lista.
Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100, e o padrão é 10.
Campo para definir o dia de pagamento do boleto. Ao enviar este campo, será realizado um cálculo de valor presente (VP
) para o dia de pagamento informado.
O status da parcela. O valor deve ser uma string ou uma lista separada por vírgula.
void
, paid
, uncollectible
, unpaid
Um filtro com base no campo dueDate
. O valor deve ser uma data.
Um filtro com base no campo dueDate
. O valor deve ser uma data.
Um filtro com base no campo payer
. O valor deve ser uma string ou uma lista separada por vírgula.
Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.
Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.
Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.
Um filtro com base no campo customer
. O valor deve ser uma string ou uma lista separada por vírgula.
Response
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter
.
Uma lista de parcelas