Endpoints responsáveis pelo envio das informações de faturamento dos pedidos, permitindo a solicitação e emissão do boleto bancário. Funcionalidade aplicável aos fornecedores que utilizam crédito Yandeh.
Início > Faturamentos
Versão: 2.0
API de Faturamento
GET Faturamento
Endpoint responsável pela consulta dos faturamentos cadastrados na plataforma Yandeh.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos pedidos.
chave_acesso : Chave de acesso para a nota fiscal.
-
Parâmetro obrigatório.
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/faturamento?chave_acesso=35240912345678000199550100000123451234567890' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"content": [
{
"objectType": "INVOICE",
"id": "gqgX1",
"createdBy": "9f4e2a67-8c1b-4d3f-a7e5-2b9c6f1a4e8d",
"createdDate": "2025-01-01T00:00:00.000",
"lastModifiedBy": "9f4e2a67-8c1b-4d3f-a7e5-2b9c6f1a4e8d",
"lastModifiedDate": "2025-02-01T00:00:00.000",
"customerReference": "urn:party:pgid:fornecedor",
"date": "2025-01-01T00:30:00",
"dueDate": "2025-02-01T00:00:00",
"errorReason": null,
"externalReference": "urn:invoice:nfe:35240912345678000199550100000123451234567890",
"requestChannel": "API",
"amount": 2000.00,
"currency": "BRL",
"state": "CLOSED",
"status": "EXECUTED",
"rawInvoice": null,
"negotiableInstruments": [
{
"objectType": "NEGOTIABLE_INSTRUMENT",
"id": "edcba",
"createdBy": "9f4e2a67-8c1b-4d3f-a7e5-2b9c6f1a4e8d",
"createdDate": "2025-01-01T00:00:00.000",
"lastModifiedBy": "9f4e2a67-8c1b-4d3f-a7e5-2b9c6f1a4e8d",
"lastModifiedDate": "2025-01-01T00:00:00.000",
"customerReference": "urn:party:pgid:fornecedor",
"date": "2025-01-01T00:00:00.000",
"dueDate": "2025-02-01T00:00:00.000",
"errorReason": null,
"externalReference": "urn:ndup:123456789",
"requestChannel": null,
"amount": 2000.5,
"currency": "BRL",
"state": "CLOSED",
"status": "EXECUTED",
"discountAmount": 0.0,
"documentReference": "123456789",
"rawNegotiableInstrument": null,
"boleto": {
"id": "N78Qe",
"createdBy": "9f4e2a67-8c1b-4d3f-a7e5-2b9c6f1a4e8d",
"createdDate": "2025-01-01T00:00:00.000",
"lastModifiedBy": "9f4e2a67-8c1b-4d3f-a7e5-2b9c6f1a4e8d",
"lastModifiedDate": "2025-01-01T00:00:00.000",
"amount": 2000.5,
"available": true,
"bankReference": "111",
"barcode": "34191.09099 00153.182001 09573.040004 1 11740000282750",
"currency": "BRL",
"customerReference": "urn:party:pgid:fornecedor",
"date": "2025-01-01",
"documentReference": "09001587",
"dueDate": "2025-02-01",
"internalReference": "urn:qprof:523123",
"paidAmount": 0.0,
"paymentDate": null,
"url": "/api/v1/tickets/copy/edcba",
"state": "OPEN",
"base64": null
}
}
]
}
],
"totalElements": 1,
"size": 100,
"number": 0,
"pageable": {
"pageSize": 100,
"pageNumber": 0
},
"totalPages": 1,
"numberOfElements": 1
}
Elementos da Resposta
content: Array contendo os faturamentos retornadas pela consulta.
Tipo: Array de JSON.
objectType: Tipo do objeto retornado.
Tipo: String.
id: ID do faturamento.
Tipo: String.
createdBy: Hash identificador do usuário de criação do faturamento.
Tipo: String.
createdDate: Data e hora de criação do faturamento.
Tipo: Datetime.
lastModifiedBy: Hash identificador do usuário que fez a última modificação.
Tipo: String.
lastModifiedDate: Data e hora da última modificação do faturamento.
Tipo: Datetime.
customerReference: Identificação do fornecedor.
Tipo: String.
date: Data de emissão do faturamento.
Tipo: Datetime.
dueDate: Data de vencimento da primeira parcela do boleto.
Tipo: Datetime.
errorReason:Indica o motivo da falha da solicitação do faturamento, quando aplicável. Retorna null se a fatura for processada com sucesso.
Tipo: String.
externalReference: Número chave de acesso da nota fiscal
Tipo: String.
requestChannel: Canal de solicitação do faturamento.
Tipo: String.
amount: Valor total do faturamento.
Tipo: Float.
currency: Código da moeda utilizada (BRL, USD, etc.).
Tipo: String.
state: Estado atual do faturamento.
Tipo: String.
status: Status de processamento.
Tipo: String.
rawInvoice: Dados brutos da nota fiscal original. Null se não disponível.
Tipo: String.
negotiableInstruments: Array contendo informações das parcelas do faturamento
Tipo: Array de JSON.
objectType: Tipo do objeto.
Tipo: String.
id: Identificador único do instrumento negociável.
Tipo: String.
createdBy: Hash identificador do usuário de criação.
Tipo: String.
createdDate: Data e hora de criação do instrumento.
Tipo: Datetime.
lastModifiedBy: Hash identificador do usuário que fez a última modificação.
Tipo: String.
lastModifiedDate: Data e hora da última modificação.
Tipo: Datetime.
customerReference: Referência do fornecedor.
Tipo: String.
date: Data de emissão da parcela.
Tipo: Datetime.
dueDate: Data de vencimento da parcela.
Tipo: Datetime.
errorReason: Indica o motivo da falha da fatura, quando aplicável. Retorna null se a fatura for processada com sucesso.
Tipo: String.
externalReference: Numero da nota fiscal + número da parcela
Tipo: String.
requestChannel: Canal de solicitação.
Tipo: String.
amount: Valor total da parcela.
Tipo: Float.
currency: Código da moeda utilizada (BRL, USD, etc.).
Tipo: String.
state: Estado atual da parcela.
Tipo: String.
status: Status de processamento.
Tipo: String.
discountAmount: Valor do desconto na parcela.
Tipo: Float.
documentReference: Numero da nota fiscal + número da parcela
Tipo: String.
rawNegotiableInstrument: Dados brutos do instrumento original.
Tipo: String.
boleto: Dados do boleto.
Tipo: JSON.
id: Identificador único do boleto no sistema.
Tipo: String.
createdBy: Hash identificador do usuário que criou o boleto.
Tipo: String.
createdDate: Data e hora de criação do boleto.
Tipo: Datetime.
lastModifiedBy: Hash identificador do usuário que fez a última modificação.
Tipo: String.
lastModifiedDate: Data e hora da última modificação.
Tipo: Datetime.
amount: Valor do boleto.
Tipo: Float.
available: Indica se o boleto está disponível para pagamento.
Tipo: Boolean.
bankReference: Código de referência do banco emissor.
Tipo: String.
barcode: Código de barras do boleto.
Tipo: String.
currency: Código da moeda do boleto (BRL, USD, etc.).
Tipo: String.
customerReference: Referência do fornecedor.
Tipo: String.
date: Data de emissão do boleto.
Tipo: Date (YYYY-MM-DD).
documentReference: Referência do documento do boleto.
Tipo: String.
dueDate: Data de vencimento do boleto.
Tipo: Date (YYYY-MM-DD).
internalReference: Referência interna do faturamento (URN).
Tipo: String.
paidAmount: Valor já pago do boleto.
Tipo: Float.
paymentDate: Data do pagamento do boleto. Null se não pago.
Tipo: Date.
url: URL para acesso/cópia do boleto.
Tipo: String.
state: Estado atual do boleto.
Tipo: String.
base64: Representação base64 do boleto (PDF). Null se não disponível.
Tipo: String.
totalElements: Número total de elementos encontrados na consulta.
Tipo: Integer.
size: Tamanho da página retornada.
Tipo: Integer.
number: Número da página atual.
Tipo: Integer.
pageable: Informações de paginação da consulta.
Tipo: JSON.
pageSize: Tamanho da página configurado para a consulta.
Tipo: Integer.
pageNumber: Número da página atual.
Tipo: Integer.
totalPages: Número total de páginas disponíveis.
Tipo: Integer.
numberOfElements: Número de elementos presentes na página atual.
Tipo: Integer.
Resposta com erros
Status code 404:
Caso seja enviado no parâmetro "chave_acesso" o número de uma nota fiscal inválida.
"Nota fiscal não encontrada."
POST Faturamento
Endpoint para envio do faturamento . Deve ser utilizado sempre que um pedido for faturado.
Observações:
-
O envio do faturamento deve ocorrer assim que for atualizado o pedido para faturado no PATCH Pedidos para que o boleto fique disponível para o cliente efetuar o download na plataforma.
-
Para os fornecedores que vão gerar o boleto (PDF) no próprio ERP (enviando para a Yandeh somente a solicitação do registro) deve enviar as informações do "Boleto" dentro do array "negociação". Para os demais, não enviar os campos correspondentes.
-
Após cancelamento de um pedido (status cancelado) ele não poderá ser faturado.
-
Não é possível utilizar mais de uma nota fiscal para o mesmo pedido (mesmo boleto)
Endpoint POST
URL:
Sintaxe da Requisição
-
Tipo de requisição: POST .
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"chave_acesso": "35230567313130000155550030000221571007404988",
"valor_faturado": 2000.00,
"negociacao": [
{
"referencia": "12345678",
"data_faturamento": "2024-01-01T00:00:00",
"data_vencimento_parcela": "2024-02-01T00:00:00",
"valor_parcela": 2000.00,
"desconto": 0,
"boleto": {
"referencia_bancaria": "123",
"codigo_barras": "35230567313130000155550030000221571007404988",
"nosso_numero": "00000120"
},
"documento_referencia": "0941167201"
}
],
"data_pedido": "2024-01-17T00:00:00",
"data_vencimento": "2024-02-01T00:00:00",
"xml_nota": "xml da nota",
"cnpj_cliente": "12345678912345"
}
]
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/faturamento' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '[
{
"chave_acesso": "35230567313130000155550030000221571007404988",
"valor_faturado": 2000.00,
"negociacao": [
{
"referencia": "12345678",
"data_faturamento": "2024-01-01T00:00:00",
"data_vencimento_parcela": "2024-01-01T00:00:00",
"valor_parcela": 2000.00,
"desconto": 0,
"boleto": {
"referencia_bancaria": "237",
"codigo_barras": "35230567313130000155550030000221571007404988",
"nosso_numero": "00000120"
},
"documento_referencia": "0941167201"
}
],
"data_pedido": "2024-01-01T00:00:00",
"data_vencimento": "2024-01-01T00:00:00",
"xml_nota": "<?xml version='\''1.0'\'' encoding='\''UTF-8'\''?><nfeProc xmlns='\''http://www.portalfiscal.inf.br/nfe'\'' versao='\''4.00'\''><NFe xmlns='\''http://www.portalfiscal.inf.br/nfe'\''><infNFe Id='\''35230567313130000155550030000221571007404988'\'' versao='\''4.00'\''><ide><cUF>35</cUF><cNF>88634906</cNF><natOp>VENDA </protNFe></nfeProc>",
"cnpj_cliente": "12345678912345"
}
]'
Elementos da Requisição
chave_acesso: Chave da nota fiscal de venda.
Tipo: String.
valor_faturado: Valor faturado no pedido.
Tipo: Float.
Negociação:
Tipo: Array de JSON.
referencia: Numero da NF + numero-parcela.
Tipo: String.
data_faturamento: Data do faturamento da parcela.
Tipo: Datetime.
data_vencimento_parcela: Data do vencimento da parcela do pedido.
Tipo: Datetime.
valor_parcela : Valor da parcela a ser pago pelo cliente.
Tipo: Float.
desconto: Valor do desconto aplicado no boleto. Não havendo informar 0.
Tipo: Float.
boleto : Dados do boleto. (Informar somente se o fornecedor gerar o boleto no próprio ERP)
referencia_bancaria: Código do banco do boleto. Preencher 341(Itau)
Tipo: String.
codigo_barras: Código de barras do boleto.
Tipo: String.
nosso_numero: Nosso número do boleto.
Tipo: String.
documento_referencia: Zeros + numero da NF + numero da parcela (zero a esquerda até completar 10 digitos)
Tipo: String.
data_pedido: Data do pedido
Tipo: Datetime.
data_vencimento: data de vencimento do boleto (Cálculo data do pedido/faturamento x prazo de pagamento)
Tipo: Datetime.
xml_nota: XML da nota contendo o campo xPed como o número do pedido Yandeh
Tipo: String.
cnpj_cliente: CNPJ do cliente a ser gerado a cobrança
Tipo: String.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"data": [
{
"id": "YnmkA",
"date": "2025-01-23T00:00:00",
"state": "OPEN",
"amount": 50.25,
"status": null,
"dueDate": "2025-02-08T00:00:00",
"currency": "BRL",
"involved": [
{
"id": "ggnd5",
"type": "OBLIGEE",
"party": {
"id": "oLRw9",
"name": "Fornecedor ATACADISTA",
"addresses": null,
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-29T11:35:34.487612",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"identifications": [
{
"id": "oLRw9",
"type": "CNPJ",
"value": "05955701000106",
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-29T11:35:34.487718",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2024-05-29T11:35:34.487718"
}
],
"lastModifiedDate": "2024-01-29T11:35:34.487612"
},
"createdBy": "446fffd7-5c7a-468b-a0a2-a7a898fec767",
"createdDate": "2025-01-24T18:15:43.405809282",
"lastModifiedBy": "446fffd7-5c7a-468b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405809282"
},
{
"id": "lgPdx",
"type": "OBLIGOR",
"party": {
"id": "gVxYa",
"name": "MERCEARIA LTDA",
"addresses": null,
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-27T18:06:29.79385",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"identifications": [
{
"id": "gVxYa",
"type": "CNPJ",
"value": "09458008000184",
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-27T18:06:29.793956",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2024-01-27T18:06:29.793956"
}
],
"lastModifiedDate": "2024-01-27T18:06:29.79385"
},
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2025-01-24T18:15:43.405825793",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405825793"
}
],
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"objectType": "INVOICE",
"rawInvoice": null,
"createdDate": "2025-01-24T18:15:43.405741821",
"errorReason": null,
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"paymentMethods": [
{
"id": "jWlYV",
"type": "NEGOTIABLE_INSTRUMENTS_CESSION",
"amount": 50.25,
"currency": "BRL",
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2025-01-24T18:15:43.405947725",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405947725"
}
],
"lastModifiedDate": "2025-01-24T18:15:43.405741821",
"customerReference": "urn:party:pgid:fornecedor",
"externalReference": "urn:invoice:nfe:35250605950001000106000010065401381143104800",
"negotiableInstruments": [
{
"id": "99xeY",
"date": "2025-01-24T17:43:00",
"state": "OPEN",
"amount": 50.25,
"boleto": {
"id": "v4vk3",
"url": "/api/v1/tickets/copy/null",
"date": "2025-01-24",
"state": "OPEN",
"amount": 50.25,
"base64": null,
"barcode": 34195113600005000251090450958862000950004000
"dueDate": "2025-02-08",
"currency": "BRL",
"available": false,
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"paidAmount": null,
"createdDate": "2025-01-24T18:15:43.405858113",
"paymentDate": null,
"bankReference": "341",
"lastModifiedBy": "446fffd7-5c7a-468b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405858113",
"customerReference": "urn:party:pgid:fornecedor",
"documentReference": "04509588",
"internalReference": null
},
"status": null,
"dueDate": "2025-02-08T00:00:00",
"currency": "BRL",
"involved": [
{
"id": "agzdy",
"type": "OBLIGEE",
"party": {
"id": "oLRw9",
"name": "ATACADISTA",
"addresses": null,
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-29T11:35:34.487612",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"identifications": [
{
"id": "oLRw9",
"type": "CNPJ",
"value": "05950001000106",
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-29T11:35:34.487718",
"lastModifiedBy": "446fffd7-5c7a-468b-a0a2-a7a898fec767",
"lastModifiedDate": "2024-01-29T11:35:34.487718"
}
],
"lastModifiedDate": "2024-01-29T11:35:34.487612"
},
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2025-01-24T18:15:43.405895834",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405895834"
},
{
"id": "EJzQA",
"type": "OBLIGOR",
"party": {
"id": "gVxYa",
"name": "MERCEARIA LTDA",
"addresses": null,
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-27T18:06:29.79385",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"identifications": [
{
"id": "gVxYa",
"type": "CNPJ",
"value": "09008008000104",
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2024-01-27T18:06:29.793956",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2024-01-27T18:06:29.793956"
}
],
"lastModifiedDate": "2024-01-27T18:06:29.79385"
},
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2025-01-24T18:15:43.405905044",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405905044"
}
],
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"objectType": "NEGOTIABLE_INSTRUMENT",
"createdDate": "2025-06-24T18:15:43.405841403",
"errorReason": null,
"discountAmount": 0,
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405841403",
"customerReference": "urn:party:pgid:fornecedor",
"documentReference": "0651013801",
"externalReference": "urn:ndup:654113801",
"estimatedDiscounts": null,
"rawNegotiableInstrument": null
}
],
"notasFiscaisEletronicas": [
{
"id": "7eDNg",
"report": null,
"status": "USE_AUTHORIZED",
"content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><nfeProc versao=\"4.00\" oT8yO5VX3Q6zWgF6AW1v6XUv6SOgPmnsu/8007v24tlh2uIcPQ82aIlIydeyizGfYphJ3XP8cl9MNskbJ9rnquEL1URGVJCyZD9AVwiD7hTrZ+qow=</X509Certificate></X509Data></KeyInfo></Signature></NFe><protNFe versao=\"4.00\"><infProt><tpAmb>1</tpAmb><verAplic>SP_NFE_PL009_V4</verAplic><chNFe>3525060565401381143104885</chNFe><dhRecbto>2025-06-24T17:43:56-03:00</dhRecbto><nProt>135251717824253</nProt><di<cStat>100</cStat><xMotivo>Autorizado o uso da NF-e</xMotivo></infProt></protNFe></nfeProc>",
"accessKey": "35250605950001000106000010065401381143104800",
"createdBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"createdDate": "2025-01-24T18:15:43.405923754",
"lastModifiedBy": "446fffd7-5c7a-400b-a0a2-a7a898fec767",
"lastModifiedDate": "2025-01-24T18:15:43.405923754"
}
],
"salesOrdersAssociations": null,
"invoiceInternalPaymentInstructionAssociations": null
}
],
"status_code": 200
}
Resposta com erros
Status code 403:
Caso o faturamento contenha alguma informação incorreta, será retornado o status code 403 juntamente com a mensagem de erro correspondente. O faturamento deverá ser corrigido e reenviado.
Exemplo: XPED não enviado no XML ou número não corresponde ao pedido de venda:
{
"data": {
"errors": [
{
"code": "NO_INTERNAL_PAYMENT_INSTRUCTION_FOUND",
"meta": {
"object": "urn:party:fornecedor:400069",
"usecase": "tech.alpe.konekt.foundation.core.instructions.api.usecase.VerifyInternalPaymentIstruction"
},
"message": "There is no InternalPaymentInstruction with the same externalReference urn:party:fornecedor:400069"
}
]
},
"status_code": 403
}
{
"data": {
"errors": [
{
"code": "XPED_FIELD_VALUE_DOES_NOT_MATCH_ORDER_EXTERNAL_REFERENCE",
"meta": null,
"message": "Order with external reference: fornecedor:400901 was sent with an NFe xml where xPed field value does not match"
}
]
},
"status_code": 403
}
Status code 409:
Caso um faturamento (nota fiscal) já tenha sido registrado anteriormente, será retornado o status code 409 com a mensagem de erro abaixo. Nesse caso, o reenvio não é necessário.
{
"data": {
"errors": [
{
"code": "OBJECT_ALREADY_EXISTS",
"meta": null,
"message": "Object ExternalPaymentInstruction(urn:invoice:nfe:35250678260045001167550020003477701660085100) already exists"
}
]
},
"status_code": 409
}
Status code 422:
Não informado a chave de acesso nos parâmetros da requisição
{
"detail": [
{
"loc": [
"query",
"chave_acesso"
],
"msg": "field required",
"type": "value_error.missing"
}
]
}
POST boleto
Endpoint para captura do boleto Yandeh para impressão.
É importante que os boletos Yandeh sejam entregues junto ao pedido
Endpoint POST
URL:
Parâmetros da Requisição
-
Tipo de requisição: POST.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"chave_nfe": "35230704039770000108550320010101002659414600"
}
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/v2/boleto' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
"chave_nfe": "35231143022644000160550020000000041041300208"
}'
Elementos da Requisição
chave_nfe: Chave da nota fiscal de venda
Tipo: String
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará status code 200 com o boleto estará disponível para impressão no formato texto do PDF.
Resposta com erros
Status code 401:
Erro na validação do token
{
"reason": "Could not validate the token"
}
Status code 406:
Boleto ainda não está disponível para download
"Boleto não disponível"
Geração do Boleto pelo ERP:
Caso o fornececedor optar por gerar o boleto no ERP próprio, devem serguir as configurações:
-
Dados do beneficiário conforme imagem abaixo
-
Vencimento do título
-
Dados da conta bancária Yandeh (agência/conta-dígito)
-
Faixa bancária disponibilizada
-
Valor do boleto
-
Número da nota fiscal seguido da parcela da duplicata
-
Taxa mora diária em reais acordada
-
Multa em reais acordada
-
Dias para protesto acordado
-
Dados do pagador/cliente (Razão social, endereço e cnpj)
-
Dados do beneficiário final (dados do fornecedor). Razão social e cnpj
Os campos Espécie Doc., Aceite, Carteira e Espécie Moeda manter igual a imagem abaixo.
