Busca na lista de títulos

get

https://api.connect.staging.libercapital.com.br/v1/{program}/buyers/{document_number}/invoices

Obtém os títulos do sacado no programa. O retorno é limitado a 20 títulos por página.

Path Params

program

string

required

Código do programa Liber Capital no qual se deseja realizar a operação.

document_number

string

required

^[0-9A-Z]{8}$

Raiz (8 primeiros caracteres) do documento (CNPJ) do Sacado cadastrado na plataforma para o qual se deseja inserir o título a ser ofertado para antecipação.
Somente caracteres alfanuméricos.

Query Params

p

integer

≥ 1

Número da página.
Contagem é iniciada em 1.

reference_id

string

Identificador único do título no sistema do cliente. Através desse parâmetro é possível encontrar um título específico associado a este identificador. Múltiplos identificadores podem ser indicados, separando-os por meio do caractere de vírgula (,).

due_date

date

Filtra os títulos cujo campo due_date é EXATAMENTE IGUAL à data pesquisada.

Notação date como definida pela RFC 3339.
Exemplo: 2020-12-31

due_date__lt

date

Filtra os títulos cujo campo due_date é MENOR QUE à data pesquisada.

Notação date como definida pela RFC 3339.
Exemplo: 2020-12-31

due_date__lte

date

Filtra os títulos cujo campo due_date é MENOR QUE OU IGUAL à data pesquisada.

Notação date como definida pela RFC 3339.
Exemplo: 2020-12-31

due_date__gt

date

Filtra os títulos cujo campo due_date é MAIOR QUE à data pesquisada.

Notação date como definida pela RFC 3339.
Exemplo: 2020-12-31

due_date__gte

date

Filtra os títulos cujo campo due_date é MAIOR QUE OU IGUAL à data pesquisada.

Notação date como definida pela RFC 3339.
Exemplo: 2020-12-31

last_trade__status

string

enum

Filtra os títulos cujo campo last_trade.status é EXATAMENTE IGUAL ao valor pesquisad. Múltiplos identificadores podem ser indicados, separando-os por meio do caractere de vírgula (,).
Exemplo: OPEN,COMPLETED,CANCELED,PAID

last_trade__funder__document__number

string

^[0-9A-Z]{14}([,][0-9A-Z]{14})*$

Filtra os títulos pelo número do documento do financiador no campo last_trade, de modo que apenas filtros antecipados por esse financiador serão retornados. Múltiplos números de documentos podem ser indicados, separando-os por meio do caractere de vírgula (,).

last_trade__funder__document__number__not

string

^[0-9A-Z]{14}([,][0-9A-Z]{14})*$

Filtra os títulos pelo número do documento do financiador no campo last_trade, excluindo o financiador cujo Documento é informado. Apenas títulos antecipados por outros financiadores serão retornados. Múltiplos números de documentos podem ser indicados para exclusão, separando-os por meio do caractere de vírgula (,).

last_trade__disbursed_at__lt

date-time

Filtra os títulos cujo campo last_trade.disbursed_at é MENOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__disbursed_at__lte

date-time

Filtra os títulos cujo campo last_trade.disbursed_at é MENOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__disbursed_at__gt

date-time

Filtra os títulos cujo campo last_trade.disbursed_at é MAIOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__disbursed_at__gte

date-time

Filtra os títulos cujo campo last_trade.disbursed_at é MAIOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__settled_at__lt

date-time

Filtra os títulos cujo campo last_trade.settled_at é MENOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__settled_at__lte

date-time

Filtra os títulos cujo campo last_trade.settled_at é MENOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__settled_at__gt

date-time

Filtra os títulos cujo campo last_trade.settled_at é MAIOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__settled_at__gte

date-time

Filtra os títulos cujo campo last_trade.settled_at é MAIOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__cancelation_period_ended_at__lt

date-time

Filtra os títulos cujo campo last_trade.cancelation_period_ended_at é MENOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__cancelation_period_ended_at__lte

date-time

Filtra os títulos cujo campo last_trade.cancelation_period_ended_at é MENOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__cancelation_period_ended_at__gt

date-time

Filtra os títulos cujo campo last_trade.cancelation_period_ended_at é MAIOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__cancelation_period_ended_at__gte

date-time

Filtra os títulos cujo campo last_trade.cancelation_period_ended_at é MAIOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__completed_at__lt

date-time

Filtra os títulos cujo campo last_trade.completed_at é MENOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__completed_at__lte

date-time

Filtra os títulos cujo campo last_trade.completed_at é MENOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__completed_at__gt

date-time

Filtra os títulos cujo campo last_trade.completed_at é MAIOR QUE à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

last_trade__completed_at__gte

date-time

Filtra os títulos cujo campo last_trade.completed_at é MAIOR QUE OU IGUAL à data pesquisada.

Notação date-time como definida pela RFC 3339.
Exemplo: 2020-12-31T23:59:59-03:00

order_by

string

enum

Defaults to -last_updated_at

Campo para ordenação dos resultados.

-last_updated_at: Valor padrão. Ordenar por títulos recentemente modificados primeiro.
-created_at: Ordenar por títulos recentemente criados primeiro.

Allowed:

Responses

400

O cliente enviou parâmetros inválidos para a operação.
Verifique se a página de resultados desejada existe.

401

Não foi enviado o cabeçalho de autorização ou este cabeçalho contém um token inválido/expirado.

403

O cliente está tentando realizar uma operação que não possui permissões.
Verifique a identificação do financiador na URL do recurso.

405

O cliente está tentando realizar uma requisição que não é suportada pelo recurso.
Verifique o método da requisição enviada.

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json