{"items":[{"type":"link","label":"Cobranças","link":"/docs/charge-apis-openapi","routeSlug":"/docs/charge-apis-openapi","content":{"contentType":"overview","meta":{"name":"Cobranças"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"charge-apis-openapi.json","url":"/_bundle/docs/charge-apis-openapi.json?download"},{"kind":"download","label":"charge-apis-openapi.yaml","url":"/_bundle/docs/charge-apis-openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Cobranças (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A API de Cobranças tem como objetivo automatizar e centralizar o processo de emissão, consulta e acompanhamento de solicitações de cobrança. Por meio dessa funcionalidade, sistemas externos conseguem integrar-se de forma eficiente com a plataforma para gerir todo o ciclo de cobranças de clientes, melhorando a visibilidade, reduzindo erros e acelerando o processo financeiro."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cobranças:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/19712368690189-Cobran%C3%A7as"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/19712368690189-Cobran%C3%A7as"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lançamentos Financeiros:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar"},"children":[]}]}]}]}]}],"sectionId":"/docs/charge-apis-openapi"}],"sectionId":"/docs/charge-apis-openapi"}]}]}},{"type":"group","label":"v1","link":"/docs/charge-apis-openapi/v1","routeSlug":"/docs/charge-apis-openapi/v1","items":[{"label":"Retornar a cobrança por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/charge-apis-openapi/v1/buscarcobrancaporid","routeSlug":"/docs/charge-apis-openapi/v1/buscarcobrancaporid","metadata":{"seo":{"title":"Retornar a cobrança por id","description":"Permite consultar os detalhes de uma cobrança específica utilizando seu identificador único (id_cobranca)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buscarCobrancaPorId","name":"Retornar a cobrança por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1cobranca~1{id_cobranca}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a cobrança por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os detalhes de uma cobrança específica utilizando seu identificador único (id_cobranca)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id_cobranca","in":"path","schemaId":"schema_141","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da cobrança"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1cobranca~1{id_cobranca}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id_cobranca","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}","href":"v1/buscarcobrancaporid","openApiOperationId":"buscarCobrancaPorId","summary":"Retornar a cobrança por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GerarCobrancaResponseDto"}},"schemaId":"components/schemas/GerarCobrancaResponseDto"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1cobranca~1{id_cobranca}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GerarCobrancaResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GerarCobrancaResponseDto"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/buscarcobrancaporid"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}"},{"label":"Deletar cobrança por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/charge-apis-openapi/v1/deletarcobrancaporid","routeSlug":"/docs/charge-apis-openapi/v1/deletarcobrancaporid","metadata":{"seo":{"title":"Deletar cobrança por id","description":"Permite cancelar uma cobrança existente identificada por id_cobranca. É recomendada apenas quando a cobrança foi gerada incorretamente ou precisa ser invalidada antes de seu pagamento."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletarCobrancaPorId","name":"Deletar cobrança por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1cobranca~1{id_cobranca}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletar cobrança por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite cancelar uma cobrança existente identificada por id_cobranca. É recomendada apenas quando a cobrança foi gerada incorretamente ou precisa ser invalidada antes de seu pagamento."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id_cobranca","in":"path","schemaId":"schema_141","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da cobrança"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1cobranca~1{id_cobranca}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id_cobranca","in":"path","required":true,"schemaId":"schema_141"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}","href":"v1/deletarcobrancaporid","openApiOperationId":"deletarCobrancaPorId","summary":"Deletar cobrança por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1cobranca~1{id_cobranca}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/deletarcobrancaporid"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}"},{"label":"Criar uma nova cobrança","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/charge-apis-openapi/v1/criarcobranca","routeSlug":"/docs/charge-apis-openapi/v1/criarcobranca","metadata":{"seo":{"title":"Criar uma nova cobrança","description":"Permite criar uma nova cobrança, por meio desse endpoint, é possível informar o valor, data de vencimento, descrição da fatura e demais parâmetros que definem a cobrança. Essa funcionalidade facilita a geração automatizada de cobranças."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarCobranca","name":"Criar uma nova cobrança","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1gerar-cobranca/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar uma nova cobrança","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite criar uma nova cobrança, por meio desse endpoint, é possível informar o valor, data de vencimento, descrição da fatura e demais parâmetros que definem a cobrança. Essa funcionalidade facilita a geração automatizada de cobranças."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GerarCobrancaRequestDto"}},"schemaId":"components/schemas/GerarCobrancaRequestDto","pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1gerar-cobranca/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GerarCobrancaRequestDto"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca","href":"v1/criarcobranca","openApiOperationId":"criarCobranca","summary":"Criar uma nova cobrança"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/GerarCobrancaRequestDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GerarCobrancaRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GerarCobrancaResponseDto"}},"schemaId":"components/schemas/GerarCobrancaResponseDto"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1gerar-cobranca/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GerarCobrancaResponseDto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GerarCobrancaResponseDto"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/criarcobranca"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca"}],"content":{"contentType":"group","meta":{"name":"v1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"v1","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conjunto de recursos para acompanhar e administrar operações relacionadas a cobranças - esses recursos incluem retornar a cobrança por id, deletar cobrança por id e criar uma nova cobrança"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}","summary":"Retornar a cobrança por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/buscarcobrancaporid","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}","summary":"Deletar cobrança por id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/v1/deletarcobrancaporid","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca","summary":"Criar uma nova cobrança","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/criarcobranca","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/GerarCobrancaRequestDto":{"id":"components/schemas/GerarCobrancaRequestDto","kind":"json-schema","title":"GerarCobrancaRequestDto","data":{"type":"object","required":["conta_bancaria","descricao_fatura","id_parcela","data_vencimento","tipo"],"properties":{"conta_bancaria":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único para a conta bancária. A conta deve ser do tipo \"COBRANCAS_CONTA_AZUL\" ou, caso seja uma Conta PJ Conta Azul, do tipo \"CONTA_CORRENTE\""},"children":[]}]}]}]},"descricao_fatura":{"type":"string","example":"Pagamento da fatura #1234","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da fatura"},"children":[]}]}]}]},"id_parcela":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único para a parcela"},"children":[]}]}]}]},"data_vencimento":{"type":"string","format":"date","example":"2023-10-10","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de vencimento da cobrança"},"children":[]}]}]}]},"tipo":{"type":"string","example":"LINK_PAGAMENTO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo da cobrança"},"children":[]}]}]}],"enum":["LINK_PAGAMENTO","PIX_COBRANCA","BOLETO"]},"atributos":{"$ref":"#/components/schemas/GerarCobrancaRequestAtributosDto"},"maximo_parcelas":{"type":"integer","example":3,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número máximo de parcelas exibido na fatura do cartão"},"children":[]}]}]}]}}}},"components/schemas/GerarCobrancaRequestAtributosDto":{"id":"components/schemas/GerarCobrancaRequestAtributosDto","kind":"json-schema","title":"GerarCobrancaRequestAtributosDto","data":{"type":"object","properties":{"desconto_antecipado":{"$ref":"#/components/schemas/GerarCobrancaRequestAtributosDescontoAntecipado"}}}},"components/schemas/GerarCobrancaRequestAtributosDescontoAntecipado":{"id":"components/schemas/GerarCobrancaRequestAtributosDescontoAntecipado","kind":"json-schema","title":"GerarCobrancaRequestAtributosDescontoAntecipado","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deverá ser informado apenas um dos campos: valor ou percentual"},"children":[]}]}]}],"properties":{"valor":{"type":"number","format":"double","example":10,"description":"Quando informado, o campo \"percentual\" deve ser omitido"},"percentual":{"type":"number","format":"double","example":10,"description":"Quando informado, o campo \"valor\" deve ser omitido"},"dias_antes_vencer":{"type":"integer","example":10,"description":"Dias antes do vencimento para aplicar o desconto antecipado"}}}},"components/schemas/GerarCobrancaResponseDto":{"id":"components/schemas/GerarCobrancaResponseDto","kind":"json-schema","title":"GerarCobrancaResponseDto","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da cobrança"},"children":[]}]}]}]},"url":{"type":"string","example":"http://www.exemplo.com.br","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL da cobrança"},"children":[]}]}]}]},"status":{"type":"string","example":"AGUARDANDO_CONFIRMACAO","enum":["AGUARDANDO_CONFIRMACAO","EM_CANCELAMENTO","REGISTRADO","QUITADO","CANCELADO","INVALIDO","EXPIRADO","FALHA_EMISSAO","FALHA_CANCELAR","REMESSA_GERADO","REMESSA_PENDENTE","PAGO","EXTORNADO"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status da cobrança"},"children":[]}]}]}]}}}},"schema_141":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_141"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/charge-apis-openapi","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/charge-apis-openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/charge-apis-openapi.json?download"},{"url":"/_bundle/docs/charge-apis-openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Cobranças","description":"A API de Cobranças tem como objetivo automatizar e centralizar o processo de emissão, consulta e acompanhamento de solicitações de cobrança. Por meio dessa funcionalidade, sistemas externos conseguem integrar-se de forma eficiente com a plataforma para gerir todo o ciclo de cobranças de clientes, melhorando a visibilidade, reduzindo erros e acelerando o processo financeiro.\n\nSe desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:\n\n**Cobranças:**  \n[https://ajuda.contaazul.com/hc/pt-br/sections/19712368690189-Cobran%C3%A7as](https://ajuda.contaazul.com/hc/pt-br/sections/19712368690189-Cobran%C3%A7as)\n\n**Lançamentos Financeiros:**  \n[https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar](https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar)\n"}},"baseSlug":"/docs/charge-apis-openapi","routesMapping":{}}