{"items":[{"type":"link","label":"Baixas","link":"/docs/acquittance-apis-openapi","routeSlug":"/docs/acquittance-apis-openapi","content":{"contentType":"overview","meta":{"name":"Baixas"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"acquittance-apis-openapi.json","url":"/_bundle/docs/acquittance-apis-openapi.json?download"},{"kind":"download","label":"acquittance-apis-openapi.yaml","url":"/_bundle/docs/acquittance-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/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Baixas (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 Baixas tem como objetivo automatizar e simplificar o processo de conciliação financeira, permitindo o registro e o acompanhamento de pagamentos recebidos. Com ela, é possível criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa, deletar uma baixa e retornar a baixa, garantindo que o status financeiro das cobranças seja atualizado de maneira precisa e em tempo real, reduzindo o retrabalho e evitando inconsistências entre sistemas."},"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":"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/acquittance-apis-openapi"}],"sectionId":"/docs/acquittance-apis-openapi"}]}]}},{"type":"group","label":"v1","link":"/docs/acquittance-apis-openapi/v1","routeSlug":"/docs/acquittance-apis-openapi/v1","items":[{"label":"Criar uma nova baixa","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/criarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/criarbaixa","metadata":{"seo":{"title":"Criar uma nova baixa","description":"Permite registrar uma nova baixa vinculada a uma parcela específica. Por meio desse endpoint, é possível informar os dados do pagamento, como data, valor, juros, multa, descontos e método de pagamento. Ao registrar a baixa, o sistema atualiza automaticamente o status da parcela refletindo a quitação realizada."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarBaixa","name":"Criar uma nova baixa","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{parcela_id}~1baixa/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar uma nova baixa","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 registrar uma nova baixa vinculada a uma parcela específica. Por meio desse endpoint, é possível informar os dados do pagamento, como data, valor, juros, multa, descontos e método de pagamento. Ao registrar a baixa, o sistema atualiza automaticamente o status da parcela refletindo a quitação realizada."},"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":"parcela_id","in":"path","schemaId":"schema_148","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{parcela_id}~1baixa/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BaixaCriacaoRequestDTO"}},"schemaId":"components/schemas/BaixaCriacaoRequestDTO","pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{parcela_id}~1baixa/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"parcela_id","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BaixaCriacaoRequestDTO"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa","href":"v1/criarbaixa","openApiOperationId":"criarBaixa","summary":"Criar uma nova baixa"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BaixaCriacaoRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BaixaCriacaoRequestDTO"}},"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/BaixaCriacaoResponseDTO"}},"schemaId":"components/schemas/BaixaCriacaoResponseDTO"},{"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~1parcelas~1{parcela_id}~1baixa/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaixaCriacaoResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaixaCriacaoResponseDTO"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/criarbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa"},{"label":"Retornar as baixas pelo id da parcela","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/listarbaixas","routeSlug":"/docs/acquittance-apis-openapi/v1/listarbaixas","metadata":{"seo":{"title":"Retornar as baixas pelo id da parcela","description":"Permite consultar todas as baixas associadas a uma determinada parcela. Essa funcionalidade possibilita o acompanhamento detalhado de pagamentos realizados, facilitando a auditoria e o controle financeiro."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listarBaixas","name":"Retornar as baixas pelo id da parcela","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{parcela_id}~1baixa/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as baixas pelo id da parcela","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permite consultar todas as baixas associadas a uma determinada parcela. Essa funcionalidade possibilita o acompanhamento detalhado de pagamentos realizados, facilitando a auditoria e o controle financeiro."},{"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":"parcela_id","in":"path","schemaId":"schema_148","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{parcela_id}~1baixa/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"parcela_id","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa","href":"v1/listarbaixas","openApiOperationId":"listarBaixas","summary":"Retornar as baixas pelo id da parcela"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-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":"schema_149"}},"schemaId":"schema_149"},{"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~1parcelas~1{parcela_id}~1baixa/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_149","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_149"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/listarbaixas"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa"},{"label":"Atualizar parcialmente uma baixa por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/atualizarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/atualizarbaixa","metadata":{"seo":{"title":"Atualizar parcialmente uma baixa por id","description":"Permite atualizar parcialmente as informações de uma baixa. Use a baixa parcial quando houver pagamento ou recebimento parcial de uma fatura, seja por negociação com cliente/fornecedor ou em situações de inadimplência parcial. Por meio desse endpoint, é possível corrigir dados como valor, conta financeira, data de pagamento ou observações, mantendo o controle de versão para evitar conflitos de atualização."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"atualizarBaixa","name":"Atualizar parcialmente uma baixa por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualizar parcialmente uma baixa 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 atualizar parcialmente as informações de uma baixa. Use a baixa parcial quando houver pagamento ou recebimento parcial de uma fatura, seja por negociação com cliente/fornecedor ou em situações de inadimplência parcial. Por meio desse endpoint, é possível corrigir dados como valor, conta financeira, data de pagamento ou observações, mantendo o controle de versão para evitar conflitos de atualização."},"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":"baixa_id","in":"path","schemaId":"schema_148","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BaixaAtualizacaoRequestDTO"}},"schemaId":"components/schemas/BaixaAtualizacaoRequestDTO","pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"baixa_id","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_148"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BaixaAtualizacaoRequestDTO"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","href":"v1/atualizarbaixa","openApiOperationId":"atualizarBaixa","summary":"Atualizar parcialmente uma baixa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/BaixaAtualizacaoRequestDTO","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BaixaAtualizacaoRequestDTO"}},"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/BaixaCriacaoResponseDTO"}},"schemaId":"components/schemas/BaixaCriacaoResponseDTO"},{"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~1parcelas~1baixa~1{baixa_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaixaCriacaoResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaixaCriacaoResponseDTO"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/atualizarbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}"},{"label":"Deletar baixa por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/deletarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/deletarbaixa","metadata":{"seo":{"title":"Deletar baixa por id","description":"Permite excluir uma baixa existente do sistema. Esse endpoint deve ser utilizado com cautela, pois a exclusão impacta diretamente o saldo e o histórico financeiro da parcela associada."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletarBaixa","name":"Deletar baixa por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletar baixa 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 excluir uma baixa existente do sistema. Esse endpoint deve ser utilizado com cautela, pois a exclusão impacta diretamente o saldo e o histórico financeiro da parcela associada."},"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":"baixa_id","in":"path","schemaId":"schema_148","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"baixa_id","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_148"}],"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/parcelas/baixa/{baixa_id}","href":"v1/deletarbaixa","openApiOperationId":"deletarBaixa","summary":"Deletar baixa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-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~1parcelas~1baixa~1{baixa_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/deletarbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}"},{"label":"Retornar a baixa por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/acquittance-apis-openapi/v1/buscarbaixa","routeSlug":"/docs/acquittance-apis-openapi/v1/buscarbaixa","metadata":{"seo":{"title":"Retornar a baixa por id","description":"Permite consultar os detalhes de uma baixa específica a partir do seu identificador único (baixa_id). O retorno inclui informações completas sobre a baixa, como data de pagamento, valores envolvidos, conta financeira utilizada, método de pagamento e observações registradas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"buscarBaixa","name":"Retornar a baixa por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a baixa 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 baixa específica a partir do seu identificador único (baixa_id). O retorno inclui informações completas sobre a baixa, como data de pagamento, valores envolvidos, conta financeira utilizada, método de pagamento e observações registradas."},"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":"baixa_id","in":"path","schemaId":"schema_148","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1baixa~1{baixa_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"baixa_id","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_148"}],"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/parcelas/baixa/{baixa_id}","href":"v1/buscarbaixa","openApiOperationId":"buscarBaixa","summary":"Retornar a baixa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/acquittance-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/BaixaResponseDTO"}},"schemaId":"components/schemas/BaixaResponseDTO"},{"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~1parcelas~1baixa~1{baixa_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaixaResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaixaResponseDTO"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/buscarbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}"}],"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 ao gerenciamento de baixas - esses recursos incluem criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa por id, deletar baixa por id e retornar a baixa por id"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa","summary":"Criar uma nova baixa","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/criarbaixa","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa","summary":"Retornar as baixas pelo id da parcela","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/listarbaixas","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","summary":"Atualizar parcialmente uma baixa por id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/v1/atualizarbaixa","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","summary":"Deletar baixa por id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/v1/deletarbaixa","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}","summary":"Retornar a baixa por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/buscarbaixa","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/BaixaCriacaoRequestDTO":{"id":"components/schemas/BaixaCriacaoRequestDTO","kind":"json-schema","title":"BaixaCriacaoRequestDTO","data":{"type":"object","required":["data_pagamento","conta_financeira","composicao_valor"],"properties":{"data_pagamento":{"type":"string","format":"date","example":"2023-10-01","description":"Data do pagamento"},"composicao_valor":{"$ref":"#/components/schemas/ValorComposicaoDTO"},"conta_financeira":{"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 conta financeira"},"children":[]}]}]}]},"metodo_pagamento":{"type":"string","example":"CARTAO_CREDITO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Método de pagamento"},"children":[]}]}]}],"enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO"]},"observacao":{"type":"string","example":"Pagamento referente à fatura #1234.","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observação"},"children":[]}]}]}]},"nsu":{"type":"string","example":"1234567890","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número sequencial único"},"children":[]}]}]}]}}}},"components/schemas/BaixaCriacaoResponseDTO":{"id":"components/schemas/BaixaCriacaoResponseDTO","kind":"json-schema","title":"BaixaCriacaoResponseDTO","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 gerado automaticamente após a criação"},"children":[]}]}]}]},"versao":{"type":"integer","format":"int64","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versão da baixa"},"children":[]}]}]}]},"data_pagamento":{"type":"string","format":"date","example":"2023-10-01","description":"Data do pagamento"},"composicao_valor":{"$ref":"#/components/schemas/ValorComposicaoDTO"},"conta_financeira":{"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 conta financeira"},"children":[]}]}]}]},"metodo_pagamento":{"type":"string","example":"CARTAO_CREDITO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Método de pagamento"},"children":[]}]}]}],"enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO"]},"observacao":{"type":"string","example":"Pagamento referente à fatura #1234.","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observação"},"children":[]}]}]}]},"nsu":{"type":"string","example":"1234567890","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número sequencial único"},"children":[]}]}]}]}}}},"components/schemas/BaixaResponseDTO":{"id":"components/schemas/BaixaResponseDTO","kind":"json-schema","title":"BaixaResponseDTO","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 baixa"},"children":[]}]}]}]},"versao":{"type":"integer","format":"int64","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versão da baixa"},"children":[]}]}]}]},"data_pagamento":{"type":"string","format":"date","example":"2023-10-01","description":"Data do pagamento"},"valor_composicao":{"$ref":"#/components/schemas/ValorComposicaoDTO"},"conta_financeira":{"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 conta financeira"},"children":[]}]}]}]},"id_reconciliacao":{"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 reconciliação"},"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 da parcela"},"children":[]}]}]}]},"id_solicitacao_cobranca":{"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 solicitação de cobrança"},"children":[]}]}]}]},"observacao":{"type":"string","example":"Pagamento referente à fatura #1234.","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observação"},"children":[]}]}]}]},"metodo_pagamento":{"type":"string","example":"CARTAO_CREDITO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Método de pagamento"},"children":[]}]}]}],"enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUA","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO"]},"origem":{"type":"string","example":"SALDO_CONTA_BANCARIA","description":"Origem","enum":["LANCAMENTO_FINANCEIRO","DAS","FOLHA","TRANSFERENCIA","SALDO_CONTA_BANCARIA","VENDA","COMPRA","VENDA_AGENDADA","COMPRA_AGENDADA","IMPORTACAO_DOCUMENTO","IMPOSTO_RETIDO","SIC","NOTA_COMPRA","ANTECIPACAO","RENEGOCIACAO","HONORARIOS_CONTABEIS"]},"id_recibo_digital":{"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 do recibo digital"},"children":[]}]}]}]},"tipo_evento_financeiro":{"type":"string","example":"RECEITA","description":"Tipo de evento financeiro","enum":["RECEITA","DESPESA"]},"nsu":{"type":"string","example":"1234567890","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número sequencial único"},"children":[]}]}]}]},"id_referencia":{"type":"string","example":"REF1234","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da referência"},"children":[]}]}]}]},"atualizado_em":{"type":"string","format":"date-time","example":"2023-10-01T12:00:00Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de atualização"},"children":[]}]}]}]},"anexos":{"type":"array","items":{"$ref":"#/components/schemas/AnexoBaixaResponseDTO"}}}}},"components/schemas/AnexoBaixaResponseDTO":{"id":"components/schemas/AnexoBaixaResponseDTO","kind":"json-schema","title":"AnexoBaixaResponseDTO","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 do anexo"},"children":[]}]}]}]},"referencia":{"type":"string","example":"REF1234","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Referência associada ao anexo"},"children":[]}]}]}]},"nome":{"type":"string","example":"pagamento_recibo.pdf","description":"Nome do anexo"},"descricao":{"type":"string","example":"Recibo de pagamento referente à 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 detalhada do anexo"},"children":[]}]}]}]},"tipo":{"type":"string","example":"RECIBO_DIGITAL","description":"Tipo do anexo","enum":["RECIBO_DIGITAL","RECIBO"]},"tipo_conteudo":{"type":"string","example":"FILE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo de conteúdo do anexo"},"children":[]}]}]}],"enum":["FILE","URL"]},"url":{"type":"string","example":"https://example.com/attachment.pdf","description":"URL do anexo"}}}},"components/schemas/ValorComposicaoDTO":{"id":"components/schemas/ValorComposicaoDTO","kind":"json-schema","title":"ValorComposicaoDTO","data":{"type":"object","required":["valor_bruto"],"properties":{"multa":{"type":"number","format":"double","example":5,"description":"Valor da multa, deve ser maior ou igual a zero"},"juros":{"type":"number","format":"double","example":2.5,"description":"Valor dos juros, deve ser maior ou igual a zero"},"valor_bruto":{"type":"number","format":"double","example":150,"description":"Valor bruto, deve ser informado e maior ou igual a zero"},"desconto":{"type":"number","format":"double","example":10,"description":"Valor do desconto, deve ser maior ou igual a zero"},"taxa":{"type":"number","format":"double","example":3.75,"description":"Valor da taxa, deve ser maior ou igual a zero"}}}},"components/schemas/BaixaAtualizacaoRequestDTO":{"id":"components/schemas/BaixaAtualizacaoRequestDTO","kind":"json-schema","title":"BaixaAtualizacaoRequestDTO","data":{"type":"object","required":["versao"],"properties":{"versao":{"type":"integer","format":"int64","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versão atual do registro. Este valor será incrementado após sucesso na atualização"},"children":[]}]}]}]},"data_pagamento":{"type":"string","format":"date","example":"2023-10-01","description":"Data do pagamento"},"composicao_valor":{"$ref":"#/components/schemas/ValorComposicaoDTO"},"conta_financeira":{"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 conta financeira"},"children":[]}]}]}]},"metodo_pagamento":{"type":"string","example":"CARTAO_CREDITO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Método de pagamento"},"children":[]}]}]}],"enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUA","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO"]},"observacao":{"type":"string","example":"Pagamento referente à fatura #1234.","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observação adicional"},"children":[]}]}]}]},"nsu":{"type":"string","example":"1234567890","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número sequencial único"},"children":[]}]}]}]}}}},"schema_148":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BaixaResponseDTO"}},"id":"schema_149"}},"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/acquittance-apis-openapi","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/docs/acquittance-apis-openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/acquittance-apis-openapi.json?download"},{"url":"/_bundle/docs/acquittance-apis-openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Baixas","description":"A API de Baixas tem como objetivo automatizar e simplificar o processo de conciliação financeira, permitindo o registro e o acompanhamento de pagamentos recebidos. Com ela, é possível criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa, deletar uma baixa e retornar a baixa, garantindo que o status financeiro das cobranças seja atualizado de maneira precisa e em tempo real, reduzindo o retrabalho e evitando inconsistências entre sistemas.\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**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/acquittance-apis-openapi","routesMapping":{}}