Endpoint responsável por realizar a conciliação bancária entre a Yandeh e o fornecedor, aplicável exclusivamente aos fornecedores que utilizam o crédito Yandeh.
Início > Conciliação Bancária
Versão: 2.0
Conciliação Bancária
GET Conciliação Bancária
Endpoint para consulta dos extratos(conciliações) bancários.
Endpoint GET
URL:
https://yandeh-seller-integration.yandeh.com.br/v2/conciliacao_bancaria
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta das conciliações.
data_inicio: Data de início para emissão do extrato, no formato AAAA/MM/DD.
data_fim: Data de término para emissão do extrato, no formato AAAA/MM/DD.
-
As datas de início e fim não são obrigatórias. No entanto, caso uma delas seja informada, a outra se torna obrigatória.
quantidade_pagina: Quantidade de conciliações a serem exibidas por página.
-
Parâmetro obrigatório.
-
Máxima de 100 conciliações por página permitida.
pagina: Página a ser exibida.
-
Parâmetro obrigatório
-
Página inicial 0
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/conciliacao_bancaria?pagina=0&quantidade_pagina=10&data_inicio=2020%2F01%2F01&data_fim=2025%2F06%2F01' \
--header 'Authorization: ••••••'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados da conciliação com status code 200.
Exemplo de retorno:
{
"content": {
"content": [
{
"data_pagamento_fornecedor": "2023-08-01T16:03:31.830149",
"instrucao_liquidacao": [
{
"instrucao_pagamento": {
"boleto": {
"banco": "341",
"codigo_barras": "34191.0900850000.82200000573.040004894280000016000",
"data_emissao": "2023-07-24",
"nosso_numero": "00500008",
"data_vencimento": "2023-07-31",
"valor_pago_cliente": 167.8,
"data_pagamento_cliente": "2023-07-31",
"instrumento_negociavel": {
"nota_fiscal_parcela": "1075653001",
"nota_fiscal": {
"chave_nf": "35230704050076000490550320010756531399940063"
}
}
}
},
"status_transacao": "EXECUTED",
"detalhes": [
{
"total_pago_fornecedor": 167.8
}
]
}
]
}
]
},
"total_elemento": 1,
"tamanho": 100,
"paginacao": {
"quantidade_pagina": 100,
"pagina": 0
},
"total_paginas": 1,
"numero_de_elemento": 0
}
Elementos da Resposta
data_pagamento_fornecedor: Data do pagamento feito pela Yandeh para o fornecedor.
Tipo: String.
Instrucao_liquidacao
Boleto
banco: Banco de origem do boleto.
Tipo: String
codigo_barras: Código de barras (barcode) do boleto
Tipo: String
data_emissao: Data de emissão do boleto.
Tipo: String
nosso_numero: Nosso Número do boleto.
Tipo: String
data_vencimento: Data de vencimento do boleto.
Tipo: String
valor_pago_cliente: Valor pago pelo cliente.
Tipo: Float
data_pagamento_cliente: Data do pagamento do boleto pelo cliente.
Tipo: String
instrumento_negociavel
nota_fiscal_parcela: Número da NF + número da parcela referente ao faturamento.
Tipo: String
nota_fiscal
chave_nf: Número da chave de acesso da nota fiscal referente ao faturamento.
Tipo: String
status_transacao: Status da operação (Executed - Pago para o fornecedor).
Tipo: String
detalhes
total_pago_fornecedor: Total pago pela Yandeh ao fornecedor
Tipo: Float.
Respostas para erros
500 Internal Server Error
{
"detail": "Não foi possível receber conciliações bancárias da Alpe. {error}"
}
400 Bad Request
{
"detail": "O número da página deve ser um inteiro."
}
{
"detail": "A quantidade de itens por página deve ser um inteiro positivo maior que zero."
}
{
"detail": "A data de início não pode ser maior que a data de fim."
}
{
"detail": "As datas devem estar no formato válido (YYYY/MM/DD)"
}