Listar empréstimos
Retorna todas os empréstimos.
Os itens são retornados e ordenados por data de criação, com os itens mais recentes primeiro.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Expande as referências. Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint. Também é possível expandir as seguintes referências fora do contrato deste endpoint: installments. Para estes casos, é possível indicar um limite de registros a serem consultados, no seguinte formato: installments:40. Por padrão, este limite é de 10 registros.
Um filtro com base no campo customer do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
Um filtro com base no campo id do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
Um filtro com base no campo company do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
Um filtro com base no campo attachments.file do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
Um filtro com base no campo status do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
open, disbursed, disbursing, repaid, void, canceled, expired, pending Um filtro com base no campo createdAt. O valor deve ser uma data.
Um filtro com base no campo createdAt. O valor deve ser um data.
Um filtro com base no campo external_id. O valor deve ser uma string.
Um filtro com base no campo contractNumber do empréstimo. O valor deve ser uma string ou uma lista separada por vírgula.
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.
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.
Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.
Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.
Response
Uma lista de empréstimos.
Informa se existem mais itens. Os próximos itens podem ser obtidos informando o ID do último item no startingAfter.
Uma lista de empréstimos