{"items":[{"type":"link","label":"Financeiro","link":"/open-api-docs/open-api-finance","routeSlug":"/open-api-docs/open-api-finance","content":{"contentType":"overview","meta":{"name":"Financeiro"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"open-api-finance.json","url":"/_bundle/open-api-docs/open-api-finance.json?download"},{"kind":"download","label":"open-api-finance.yaml","url":"/_bundle/open-api-docs/open-api-finance.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/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Financeiro (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A API de Financeiro tem como objetivo oferecer um conjunto de recursos para gerenciar de forma programática os principais aspectos financeiros de uma empresa, desde a criação de eventos de contas a receber ou pagar, passando pela gestão de contas financeiras, centros de custo, categorias, até a consulta de saldos. Com esta API, sistemas podem integrar de forma fluida com o módulo financeiro da Conta Azul, garantindo que lançamentos, saldos, classificações e relatórios estejam sempre sincronizados."},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, consulte nossa Central de Ajuda:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","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","inline":true,"attributes":{"content":"Contas a pagar e receber"},"children":[],"type":"text"}],"type":"link"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cadastro e gestão de contas financeiras"},"children":[],"type":"text"}],"type":"link"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Categorias financeiras e centro de custos"},"children":[],"type":"text"}],"type":"link"}],"type":"item"}],"type":"list"}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Centro de Custo","link":"/open-api-docs/open-api-finance/centro-de-custo","routeSlug":"/open-api-docs/open-api-finance/centro-de-custo","items":[{"label":"Retornar os centros de custo por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/centro-de-custo/obtercentrosdecustoporfiltro","routeSlug":"/open-api-docs/open-api-finance/centro-de-custo/obtercentrosdecustoporfiltro","metadata":{"seo":{"title":"Retornar os centros de custo por filtro","description":"Retornar os centros de custo por filtro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterCentrosDeCustoPorFiltro","name":"Retornar os centros de custo por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1centros-de-custo/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar os centros de custo por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ordenação ascendente (case-insensitive)"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_2","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ordenação descendente (case-insensitive)"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"busca","in":"query","schemaId":"schema_3","description":"Busca textual"},{"name":"filtro_rapido","in":"query","schemaId":"schema_4","description":"Status do centro de custo"}],"pointer":"/paths/~1v1~1financeiro~1centros-de-custo/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/centros-de-custo","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_1"},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_2"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_2"},{"name":"busca","in":"query","schemaId":"schema_3"},{"name":"filtro_rapido","in":"query","schemaId":"schema_4"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/centros-de-custo","href":"centro-de-custo/obtercentrosdecustoporfiltro","openApiOperationId":"obterCentrosDeCustoPorFiltro","summary":"Retornar os centros de custo por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListagemCentroDeCusto"}},"schemaId":"components/schemas/ListagemCentroDeCusto"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1centros-de-custo/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListagemCentroDeCusto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListagemCentroDeCusto"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/centro-de-custo/obtercentrosdecustoporfiltro"}],"panels":[]}]},"httpPath":"/v1/financeiro/centros-de-custo"},{"label":"Criar um novo centro de custo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/centro-de-custo/criarnovocentrodecusto","routeSlug":"/open-api-docs/open-api-finance/centro-de-custo/criarnovocentrodecusto","metadata":{"seo":{"title":"Criar um novo centro de custo","description":"Criar um novo centro de custo"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarNovoCentroDeCusto","name":"Criar um novo centro de custo","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1centros-de-custo/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar um novo centro de custo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoCentroCusto"}},"schemaId":"components/schemas/CriacaoCentroCusto","pointer":"/paths/~1v1~1financeiro~1centros-de-custo/post/requestBody","description":"Dados do centro de custo a ser criado"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/centros-de-custo","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriacaoCentroCusto"}},"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/centros-de-custo","href":"centro-de-custo/criarnovocentrodecusto","openApiOperationId":"criarNovoCentroDeCusto","summary":"Criar um novo centro de custo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoCentroCusto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoCentroCusto"}},"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/CentroCustoResposta"}},"schemaId":"components/schemas/CentroCustoResposta"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1centros-de-custo/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CentroCustoResposta","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CentroCustoResposta"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/centro-de-custo/criarnovocentrodecusto"}],"panels":[]}]},"httpPath":"/v1/financeiro/centros-de-custo"},{"label":"Atualizar parcialmente um centro de custo","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/centro-de-custo/atualizarcentrodecusto","routeSlug":"/open-api-docs/open-api-finance/centro-de-custo/atualizarcentrodecusto","metadata":{"seo":{"title":"Atualizar parcialmente um centro de custo","description":"Atualizar parcialmente um centro de custo"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"atualizarCentroDeCusto","name":"Atualizar parcialmente um centro de custo","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1centros-de-custo~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualizar parcialmente um centro de custo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":"ID do centro de custo","required":true}],"pointer":"/paths/~1v1~1financeiro~1centros-de-custo~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoCentroCusto"}},"schemaId":"components/schemas/AtualizacaoCentroCusto","pointer":"/paths/~1v1~1financeiro~1centros-de-custo~1{id}/patch/requestBody","description":"Dados do centro de custo a ser atualizado"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/financeiro/centros-de-custo/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AtualizacaoCentroCusto"}},"responseCodes":["204","400","404","500"],"pointer":"/v1/financeiro/centros-de-custo/{id}","href":"centro-de-custo/atualizarcentrodecusto","openApiOperationId":"atualizarCentroDeCusto","summary":"Atualizar parcialmente um centro de custo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AtualizacaoCentroCusto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoCentroCusto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Centro de custo atualizado com sucesso"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1centros-de-custo~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/centro-de-custo/atualizarcentrodecusto"}],"panels":[]}]},"httpPath":"/v1/financeiro/centros-de-custo/{id}"}],"content":{"contentType":"group","meta":{"name":"Centro de Custo"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Centro de Custo","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Consulta e gestão de centros de custo, usados para organizar e classificar os custos da empresa e viabilizar análises orçamentárias."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/centros-de-custo","summary":"Retornar os centros de custo por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/centro-de-custo/obtercentrosdecustoporfiltro","deprecated":false},{"title":"/v1/financeiro/centros-de-custo","summary":"Criar um novo centro de custo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/centro-de-custo/criarnovocentrodecusto","deprecated":false},{"title":"/v1/financeiro/centros-de-custo/{id}","summary":"Atualizar parcialmente um centro de custo","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/centro-de-custo/atualizarcentrodecusto","deprecated":false}]}]}]}]}},{"type":"group","label":"Categorias","link":"/open-api-docs/open-api-finance/categorias","routeSlug":"/open-api-docs/open-api-finance/categorias","items":[{"label":"Retornar as categorias por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/categorias/obtercategoriasfinanceirasporfiltro","routeSlug":"/open-api-docs/open-api-finance/categorias/obtercategoriasfinanceirasporfiltro","metadata":{"seo":{"title":"Retornar as categorias por filtro","description":"Retornar as categorias por filtro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterCategoriasFinanceirasPorFiltro","name":"Retornar as categorias por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1categorias/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as categorias por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ordenação ascendente (case-insensitive)"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_5","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ordenação descendente (case-insensitive)"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"apenas_filhos","in":"query","schemaId":"schema_6","description":"Filtrar apenas categorias filhas"},{"name":"permite_apenas_filhos","in":"query","schemaId":"schema_6","description":"Permite apenas categorias filhas"},{"name":"tipo","in":"query","schemaId":"schema_7","description":"Tipo da categoria financeira"},{"name":"nome","in":"query","schemaId":"schema_3","description":"Nome da categoria financeira"},{"name":"busca","in":"query","schemaId":"schema_3","description":"Busca textual pela categoria"}],"pointer":"/paths/~1v1~1financeiro~1categorias/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/categorias","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_1"},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_5"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_5"},{"name":"apenas_filhos","in":"query","schemaId":"schema_6"},{"name":"permite_apenas_filhos","in":"query","schemaId":"schema_6"},{"name":"tipo","in":"query","schemaId":"schema_7"},{"name":"nome","in":"query","schemaId":"schema_3"},{"name":"busca","in":"query","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/categorias","href":"categorias/obtercategoriasfinanceirasporfiltro","openApiOperationId":"obterCategoriasFinanceirasPorFiltro","summary":"Retornar as categorias por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/CategoriasFinanceiras"}},"schemaId":"components/schemas/CategoriasFinanceiras"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1categorias/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoriasFinanceiras","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoriasFinanceiras"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categorias/obtercategoriasfinanceirasporfiltro"}],"panels":[]}]},"httpPath":"/v1/financeiro/categorias"},{"label":"Retornar a configuração de de-para de categorias","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/categorias/obterconfiguracaopadraocategorias","routeSlug":"/open-api-docs/open-api-finance/categorias/obterconfiguracaopadraocategorias","metadata":{"seo":{"title":"Retornar a configuração de de-para de categorias","description":"Retornar a configuração de de-para de categorias"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterConfiguracaoPadraoCategorias","name":"Retornar a configuração de de-para de categorias","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1categorias~1configuracao-padrao/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a configuração de de-para de categorias","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sugestao_padrao","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Inclui a sugestão padrão no retorno"},"children":[],"type":"text"}],"type":"paragraph"}]}],"pointer":"/paths/~1v1~1financeiro~1categorias~1configuracao-padrao/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/categorias/configuracao-padrao","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"sugestao_padrao","in":"query","schemaId":"schema_8"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/categorias/configuracao-padrao","href":"categorias/obterconfiguracaopadraocategorias","openApiOperationId":"obterConfiguracaoPadraoCategorias","summary":"Retornar a configuração de de-para de categorias"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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_9"}},"schemaId":"schema_9"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1categorias~1configuracao-padrao/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_9"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categorias/obterconfiguracaopadraocategorias"}],"panels":[]}]},"httpPath":"/v1/financeiro/categorias/configuracao-padrao"},{"label":"Retornar a categoria por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/categorias/obtercategoriafinanceiraporid","routeSlug":"/open-api-docs/open-api-finance/categorias/obtercategoriafinanceiraporid","metadata":{"seo":{"title":"Retornar a categoria por id","description":"Retornar a categoria por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterCategoriaFinanceiraPorId","name":"Retornar a categoria por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1categorias~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a categoria por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":"ID da categoria financeira","required":true}],"pointer":"/paths/~1v1~1financeiro~1categorias~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/categorias/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/categorias/{id}","href":"categorias/obtercategoriafinanceiraporid","openApiOperationId":"obterCategoriaFinanceiraPorId","summary":"Retornar a categoria por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/CategoriaFinanceira"}},"schemaId":"components/schemas/CategoriaFinanceira"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1categorias~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoriaFinanceira","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoriaFinanceira"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categorias/obtercategoriafinanceiraporid"}],"panels":[]}]},"httpPath":"/v1/financeiro/categorias/{id}"}],"content":{"contentType":"group","meta":{"name":"Categorias"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Categorias","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Consulta de categorias financeiras (classificação de receitas e despesas) e da configuração padrão de categorias por operação, apoiando o agrupamento e a geração de relatórios."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/categorias","summary":"Retornar as categorias por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categorias/obtercategoriasfinanceirasporfiltro","deprecated":false},{"title":"/v1/financeiro/categorias/configuracao-padrao","summary":"Retornar a configuração de de-para de categorias","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categorias/obterconfiguracaopadraocategorias","deprecated":false},{"title":"/v1/financeiro/categorias/{id}","summary":"Retornar a categoria por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categorias/obtercategoriafinanceiraporid","deprecated":false}]}]}]}]}},{"type":"group","label":"Categorias DRE","link":"/open-api-docs/open-api-finance/categorias-dre","routeSlug":"/open-api-docs/open-api-finance/categorias-dre","items":[{"label":"Retornar as categorias DRE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/categorias-dre/obtercategoriasdre","routeSlug":"/open-api-docs/open-api-finance/categorias-dre/obtercategoriasdre","metadata":{"seo":{"title":"Retornar as categorias DRE","description":"Retornar as categorias DRE"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterCategoriasDRE","name":"Retornar as categorias DRE","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1categorias-dre/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as categorias DRE","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/categorias-dre","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/categorias-dre","href":"categorias-dre/obtercategoriasdre","openApiOperationId":"obterCategoriasDRE","summary":"Retornar as categorias DRE"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/EstruturaDRE"}},"schemaId":"components/schemas/EstruturaDRE"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1categorias-dre/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EstruturaDRE","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EstruturaDRE"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categorias-dre/obtercategoriasdre"}],"panels":[]}]},"httpPath":"/v1/financeiro/categorias-dre"}],"content":{"contentType":"group","meta":{"name":"Categorias DRE"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Categorias DRE","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estrutura de categorias da DRE (Demonstração do Resultado do Exercício), usada para o fechamento contábil-financeiro da empresa."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/categorias-dre","summary":"Retornar as categorias DRE","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categorias-dre/obtercategoriasdre","deprecated":false}]}]}]}]}},{"type":"group","label":"Conta Financeira","link":"/open-api-docs/open-api-finance/conta-financeira","routeSlug":"/open-api-docs/open-api-finance/conta-financeira","items":[{"label":"Retornar as contas financeiras por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/conta-financeira/obtercontasfinanceirasporfiltro","routeSlug":"/open-api-docs/open-api-finance/conta-financeira/obtercontasfinanceirasporfiltro","metadata":{"seo":{"title":"Retornar as contas financeiras por filtro","description":"Retornar as contas financeiras por filtro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterContasFinanceirasPorFiltro","name":"Retornar as contas financeiras por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-financeiras/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as contas financeiras por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_1","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_10","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ordenação ascendente"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_10","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Ordenação descendente"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tipos","in":"query","style":"form","explode":false,"schemaId":"schema_11","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipos de conta financeira, separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"nome","in":"query","schemaId":"schema_3","description":"Nome da conta financeira"},{"name":"apenas_ativo","in":"query","schemaId":"schema_6","description":"Filtrar apenas contas ativas"},{"name":"esconde_conta_digital","in":"query","schemaId":"schema_6","description":"Esconder contas digitais"},{"name":"mostrar_caixinha","in":"query","schemaId":"schema_6","description":"Mostrar contas de caixa"}],"pointer":"/paths/~1v1~1financeiro~1contas-financeiras/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/contas-financeiras","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_1"},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_10"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_10"},{"name":"tipos","in":"query","schemaId":"schema_11","style":"form","explode":false},{"name":"nome","in":"query","schemaId":"schema_3"},{"name":"apenas_ativo","in":"query","schemaId":"schema_6"},{"name":"esconde_conta_digital","in":"query","schemaId":"schema_6"},{"name":"mostrar_caixinha","in":"query","schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/contas-financeiras","href":"conta-financeira/obtercontasfinanceirasporfiltro","openApiOperationId":"obterContasFinanceirasPorFiltro","summary":"Retornar as contas financeiras por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListaContasFinanceiras"}},"schemaId":"components/schemas/ListaContasFinanceiras"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-financeiras/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListaContasFinanceiras","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListaContasFinanceiras"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conta-financeira/obtercontasfinanceirasporfiltro"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-financeiras"},{"label":"Retornar os saldos iniciais das contas financeiras","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/conta-financeira/obtersaldosiniciais","routeSlug":"/open-api-docs/open-api-finance/conta-financeira/obtersaldosiniciais","metadata":{"seo":{"title":"Retornar os saldos iniciais das contas financeiras","description":"Retornar os saldos iniciais das contas financeiras"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterSaldosIniciais","name":"Retornar os saldos iniciais das contas financeiras","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-financeiras~1saldo-inicial/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar os saldos iniciais das contas financeiras","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_inicio","in":"query","schemaId":"schema_3","description":"Data inicial (ISO 8601 date-time)","required":true,"example":"2025-01-01T00:00:00"},{"name":"data_fim","in":"query","schemaId":"schema_3","description":"Data final (ISO 8601 date-time)","required":true,"example":"2025-01-31T23:59:59"}],"pointer":"/paths/~1v1~1financeiro~1contas-financeiras~1saldo-inicial/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/contas-financeiras/saldo-inicial","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12"},{"name":"data_inicio","in":"query","required":true,"example":"2025-01-01T00:00:00","schemaId":"schema_3"},{"name":"data_fim","in":"query","required":true,"example":"2025-01-31T23:59:59","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/contas-financeiras/saldo-inicial","href":"conta-financeira/obtersaldosiniciais","openApiOperationId":"obterSaldosIniciais","summary":"Retornar os saldos iniciais das contas financeiras"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListaSaldosIniciais"}},"schemaId":"components/schemas/ListaSaldosIniciais"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-financeiras~1saldo-inicial/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListaSaldosIniciais","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListaSaldosIniciais"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conta-financeira/obtersaldosiniciais"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-financeiras/saldo-inicial"},{"label":"Retornar o saldo atual pelo id da conta financeira","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/conta-financeira/obtersaldocontafinanceira","routeSlug":"/open-api-docs/open-api-finance/conta-financeira/obtersaldocontafinanceira","metadata":{"seo":{"title":"Retornar o saldo atual pelo id da conta financeira","description":"Retornar o saldo atual pelo id da conta financeira"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterSaldoContaFinanceira","name":"Retornar o saldo atual pelo id da conta financeira","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-financeiras~1{id_conta_financeira}~1saldo-atual/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o saldo atual pelo id da conta financeira","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id_conta_financeira","in":"path","schemaId":"schema_3","description":"ID da conta financeira","required":true}],"pointer":"/paths/~1v1~1financeiro~1contas-financeiras~1{id_conta_financeira}~1saldo-atual/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/contas-financeiras/{id_conta_financeira}/saldo-atual","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id_conta_financeira","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/contas-financeiras/{id_conta_financeira}/saldo-atual","href":"conta-financeira/obtersaldocontafinanceira","openApiOperationId":"obterSaldoContaFinanceira","summary":"Retornar o saldo atual pelo id da conta financeira"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/SaldoContaFinanceira"}},"schemaId":"components/schemas/SaldoContaFinanceira"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-financeiras~1{id_conta_financeira}~1saldo-atual/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SaldoContaFinanceira","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SaldoContaFinanceira"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/conta-financeira/obtersaldocontafinanceira"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-financeiras/{id_conta_financeira}/saldo-atual"}],"content":{"contentType":"group","meta":{"name":"Conta Financeira"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Conta Financeira","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Consulta de contas financeiras (bancárias, cartões, poupança, etc.) e do saldo atual de cada conta, para monitoramento em tempo real."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/contas-financeiras","summary":"Retornar as contas financeiras por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conta-financeira/obtercontasfinanceirasporfiltro","deprecated":false},{"title":"/v1/financeiro/contas-financeiras/saldo-inicial","summary":"Retornar os saldos iniciais das contas financeiras","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conta-financeira/obtersaldosiniciais","deprecated":false},{"title":"/v1/financeiro/contas-financeiras/{id_conta_financeira}/saldo-atual","summary":"Retornar o saldo atual pelo id da conta financeira","prefix":{"name":"get","color":"get"},"badges":[],"link":"/conta-financeira/obtersaldocontafinanceira","deprecated":false}]}]}]}]}},{"type":"group","label":"Transferências","link":"/open-api-docs/open-api-finance/transferencias","routeSlug":"/open-api-docs/open-api-finance/transferencias","items":[{"label":"Retornar as transferências entre contas financeiras por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/transferencias/obtertransferencias","routeSlug":"/open-api-docs/open-api-finance/transferencias/obtertransferencias","metadata":{"seo":{"title":"Retornar as transferências entre contas financeiras por filtro","description":"Retornar as transferências entre contas financeiras por filtro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterTransferencias","name":"Retornar as transferências entre contas financeiras por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1transferencias/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as transferências entre contas financeiras por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_conta_financeira","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs das contas financeiras (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_inicio","in":"query","schemaId":"schema_14","description":"Data inicial","required":true,"example":"2025-01-01"},{"name":"data_fim","in":"query","schemaId":"schema_14","description":"Data final","required":true,"example":"2025-01-31"}],"pointer":"/paths/~1v1~1financeiro~1transferencias/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/transferencias","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12"},{"name":"ids_conta_financeira","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"data_inicio","in":"query","required":true,"example":"2025-01-01","schemaId":"schema_14"},{"name":"data_fim","in":"query","required":true,"example":"2025-01-31","schemaId":"schema_14"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/transferencias","href":"transferencias/obtertransferencias","openApiOperationId":"obterTransferencias","summary":"Retornar as transferências entre contas financeiras por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListaTransferencias"}},"schemaId":"components/schemas/ListaTransferencias"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1transferencias/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListaTransferencias","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListaTransferencias"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transferencias/obtertransferencias"}],"panels":[]}]},"httpPath":"/v1/financeiro/transferencias"}],"content":{"contentType":"group","meta":{"name":"Transferências"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transferências","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Consulta de transferências entre contas financeiras (exportação contábil), apoiando a conciliação e a sincronização das movimentações."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/transferencias","summary":"Retornar as transferências entre contas financeiras por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transferencias/obtertransferencias","deprecated":false}]}]}]}]}},{"type":"group","label":"Eventos Financeiros","link":"/open-api-docs/open-api-finance/eventos-financeiros","routeSlug":"/open-api-docs/open-api-finance/eventos-financeiros","items":[{"label":"Criar um novo evento financeiro de contas a pagar","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/eventos-financeiros/criardespesa","routeSlug":"/open-api-docs/open-api-finance/eventos-financeiros/criardespesa","metadata":{"seo":{"title":"Criar um novo evento financeiro de contas a pagar","description":"Criar um novo evento financeiro de contas a pagar"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarDespesa","name":"Criar um novo evento financeiro de contas a pagar","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-a-pagar/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar um novo evento financeiro de contas a pagar","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoEventoFinanceiroContasPagar"}},"schemaId":"components/schemas/CriacaoEventoFinanceiroContasPagar","pointer":"/paths/~1v1~1financeiro~1contas-a-pagar/post/requestBody","description":"Dados do evento financeiro a ser criado"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/contas-a-pagar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriacaoEventoFinanceiroContasPagar"}},"responseCodes":["201","400","500"],"pointer":"/v1/financeiro/contas-a-pagar","href":"eventos-financeiros/criardespesa","openApiOperationId":"criarDespesa","summary":"Criar um novo evento financeiro de contas a pagar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoEventoFinanceiroContasPagar","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoEventoFinanceiroContasPagar"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroCriado"}},"schemaId":"components/schemas/EventoFinanceiroCriado"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-a-pagar/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EventoFinanceiroCriado","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroCriado"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eventos-financeiros/criardespesa"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-a-pagar"},{"label":"Criar um novo evento financeiro de contas a receber","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/eventos-financeiros/criarreceita","routeSlug":"/open-api-docs/open-api-finance/eventos-financeiros/criarreceita","metadata":{"seo":{"title":"Criar um novo evento financeiro de contas a receber","description":"Criar um novo evento financeiro de contas a receber"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarReceita","name":"Criar um novo evento financeiro de contas a receber","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-a-receber/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar um novo evento financeiro de contas a receber","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoEventoFinanceiroContasReceber"}},"schemaId":"components/schemas/CriacaoEventoFinanceiroContasReceber","pointer":"/paths/~1v1~1financeiro~1contas-a-receber/post/requestBody","description":"Dados do evento financeiro a ser criado"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/contas-a-receber","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriacaoEventoFinanceiroContasReceber"}},"responseCodes":["201","400","500"],"pointer":"/v1/financeiro/contas-a-receber","href":"eventos-financeiros/criarreceita","openApiOperationId":"criarReceita","summary":"Criar um novo evento financeiro de contas a receber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoEventoFinanceiroContasReceber","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoEventoFinanceiroContasReceber"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroCriado"}},"schemaId":"components/schemas/EventoFinanceiroCriado"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-a-receber/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EventoFinanceiroCriado","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroCriado"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eventos-financeiros/criarreceita"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-a-receber"},{"label":"Retornar os IDs dos eventos financeiros alterados em um período","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/eventos-financeiros/obtereventosfinanceirosporalteracao","routeSlug":"/open-api-docs/open-api-finance/eventos-financeiros/obtereventosfinanceirosporalteracao","metadata":{"seo":{"title":"Retornar os IDs dos eventos financeiros alterados em um período","description":"Retornar os IDs dos eventos financeiros alterados em um período"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterEventosFinanceirosPorAlteracao","name":"Retornar os IDs dos eventos financeiros alterados em um período","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1alteracoes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar os IDs dos eventos financeiros alterados em um período","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_inicio","in":"query","schemaId":"schema_3","description":"Data inicial (ISO 8601 date-time)","required":true,"example":"2025-01-01T00:00:00"},{"name":"data_fim","in":"query","schemaId":"schema_3","description":"Data final (ISO 8601 date-time)","required":true,"example":"2025-01-31T23:59:59"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1alteracoes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/alteracoes","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12"},{"name":"data_inicio","in":"query","required":true,"example":"2025-01-01T00:00:00","schemaId":"schema_3"},{"name":"data_fim","in":"query","required":true,"example":"2025-01-31T23:59:59","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/eventos-financeiros/alteracoes","href":"eventos-financeiros/obtereventosfinanceirosporalteracao","openApiOperationId":"obterEventosFinanceirosPorAlteracao","summary":"Retornar os IDs dos eventos financeiros alterados em um período"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListaEventosFinanceiros"}},"schemaId":"components/schemas/ListaEventosFinanceiros"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1alteracoes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListaEventosFinanceiros","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListaEventosFinanceiros"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/eventos-financeiros/obtereventosfinanceirosporalteracao"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/alteracoes"}],"content":{"contentType":"group","meta":{"name":"Eventos Financeiros"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Eventos Financeiros","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Criação de eventos financeiros de contas a receber e a pagar, além da consulta de eventos alterados por período e dos saldos iniciais das contas."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/contas-a-pagar","summary":"Criar um novo evento financeiro de contas a pagar","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eventos-financeiros/criardespesa","deprecated":false},{"title":"/v1/financeiro/contas-a-receber","summary":"Criar um novo evento financeiro de contas a receber","prefix":{"name":"post","color":"post"},"badges":[],"link":"/eventos-financeiros/criarreceita","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/alteracoes","summary":"Retornar os IDs dos eventos financeiros alterados em um período","prefix":{"name":"get","color":"get"},"badges":[],"link":"/eventos-financeiros/obtereventosfinanceirosporalteracao","deprecated":false}]}]}]}]}},{"type":"group","label":"Parcelas","link":"/open-api-docs/open-api-finance/parcelas","routeSlug":"/open-api-docs/open-api-finance/parcelas","items":[{"label":"Retornar as despesas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/parcelas/obterdespesasporfiltro","routeSlug":"/open-api-docs/open-api-finance/parcelas/obterdespesasporfiltro","metadata":{"seo":{"title":"Retornar as despesas por filtro","description":"Retornar as despesas por filtro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterDespesasPorFiltro","name":"Retornar as despesas por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-a-pagar/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as despesas por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"descricao","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_vencimento_de","in":"query","schemaId":"schema_14","description":"Data de vencimento de","required":true,"example":"2025-01-01"},{"name":"data_vencimento_ate","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de vencimento até, não pode ser anterior a data_vencimento_de"},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"2025-01-31"},{"name":"data_competencia_de","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência de, exige data_competencia_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01"},{"name":"data_competencia_ate","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência até, exige data_competencia_de e não pode ser anterior a ela"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31"},{"name":"data_pagamento_de","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de pagamento de, exige data_pagamento_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01"},{"name":"data_pagamento_ate","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de pagamento até, exige data_pagamento_de e não pode ser anterior a ela"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31"},{"name":"valor_de","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor de, decimal com até duas casas e ponto como separador"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"100.00"},{"name":"valor_ate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor até, decimal com até duas casas e ponto como separador"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"999.99"},{"name":"status","in":"query","style":"form","explode":false,"schemaId":"schema_15","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status da parcela, separados por vírgula ou repetindo o parâmetro. Os equivalentes em inglês (LOST, ACQUITTED, PENDING, RENEGOTIATED, PARTIAL e OVERDUE) também são aceitos, em qualquer caixa"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_contas_financeiras","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de contas financeiras (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_categorias","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de categorias (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_centros_de_custo","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de centros de custo (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"metodos_pagamento","in":"query","style":"form","explode":false,"schemaId":"schema_16","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Formas de pagamento, separadas por vírgula ou repetindo o parâmetro. O nome em inglês usado pela API também é aceito, em qualquer caixa (por exemplo BANKING_BILLET para BOLETO_BANCARIO). NENHUMA seleciona as parcelas sem forma de pagamento, o que é diferente de omitir o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"referencias","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referências, separadas por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_criacao_de","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de criação de (ISO 8601 sem timezone, hora de São Paulo, com ou sem os segundos), exige data_criacao_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01T00:00:00"},{"name":"data_criacao_ate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de criação até, exige data_criacao_de e não pode ser anterior a ela"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31T23:59:59"},{"name":"data_alteracao_de","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração de (ISO 8601 sem timezone, hora de São Paulo, com ou sem os segundos), exige data_alteracao_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01T00:00:00"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração até, exige data_alteracao_de, não pode ser anterior a ela e o intervalo entre as duas não pode passar de 365 dias"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31T23:59:59"}],"pointer":"/paths/~1v1~1financeiro~1contas-a-pagar/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/contas-a-pagar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12"},{"name":"descricao","in":"query","schemaId":"schema_3"},{"name":"data_vencimento_de","in":"query","required":true,"example":"2025-01-01","schemaId":"schema_14"},{"name":"data_vencimento_ate","in":"query","required":true,"example":"2025-01-31","schemaId":"schema_14"},{"name":"data_competencia_de","in":"query","example":"2025-01-01","schemaId":"schema_14"},{"name":"data_competencia_ate","in":"query","example":"2025-01-31","schemaId":"schema_14"},{"name":"data_pagamento_de","in":"query","example":"2025-01-01","schemaId":"schema_14"},{"name":"data_pagamento_ate","in":"query","example":"2025-01-31","schemaId":"schema_14"},{"name":"valor_de","in":"query","example":"100.00","schemaId":"schema_3"},{"name":"valor_ate","in":"query","example":"999.99","schemaId":"schema_3"},{"name":"status","in":"query","schemaId":"schema_15","style":"form","explode":false},{"name":"ids_contas_financeiras","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"ids_categorias","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"ids_centros_de_custo","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"metodos_pagamento","in":"query","schemaId":"schema_16","style":"form","explode":false},{"name":"referencias","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"data_criacao_de","in":"query","example":"2025-01-01T00:00:00","schemaId":"schema_3"},{"name":"data_criacao_ate","in":"query","example":"2025-01-31T23:59:59","schemaId":"schema_3"},{"name":"data_alteracao_de","in":"query","example":"2025-01-01T00:00:00","schemaId":"schema_3"},{"name":"data_alteracao_ate","in":"query","example":"2025-01-31T23:59:59","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/contas-a-pagar","href":"parcelas/obterdespesasporfiltro","openApiOperationId":"obterDespesasPorFiltro","summary":"Retornar as despesas por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListaContasAPagar"}},"schemaId":"components/schemas/ListaContasAPagar"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-a-pagar/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListaContasAPagar","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListaContasAPagar"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parcelas/obterdespesasporfiltro"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-a-pagar"},{"label":"Retornar as receitas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/parcelas/obterreceitasporfiltro","routeSlug":"/open-api-docs/open-api-finance/parcelas/obterreceitasporfiltro","metadata":{"seo":{"title":"Retornar as receitas por filtro","description":"Retornar as receitas por filtro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterReceitasPorFiltro","name":"Retornar as receitas por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1contas-a-receber/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as receitas por filtro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tamanho da página"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"descricao","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_vencimento_de","in":"query","schemaId":"schema_14","description":"Data de vencimento de","required":true,"example":"2025-01-01"},{"name":"data_vencimento_ate","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de vencimento até, não pode ser anterior a data_vencimento_de"},"children":[],"type":"text"}],"type":"paragraph"}],"required":true,"example":"2025-01-31"},{"name":"data_competencia_de","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência de, exige data_competencia_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01"},{"name":"data_competencia_ate","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência até, exige data_competencia_de e não pode ser anterior a ela"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31"},{"name":"data_pagamento_de","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de pagamento de, exige data_pagamento_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01"},{"name":"data_pagamento_ate","in":"query","schemaId":"schema_14","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de pagamento até, exige data_pagamento_de e não pode ser anterior a ela"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31"},{"name":"valor_de","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor de, decimal com até duas casas e ponto como separador"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"100.00"},{"name":"valor_ate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor até, decimal com até duas casas e ponto como separador"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"999.99"},{"name":"status","in":"query","style":"form","explode":false,"schemaId":"schema_15","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status da parcela, separados por vírgula ou repetindo o parâmetro. Os equivalentes em inglês (LOST, ACQUITTED, PENDING, RENEGOTIATED, PARTIAL e OVERDUE) também são aceitos, em qualquer caixa"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_contas_financeiras","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de contas financeiras (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_categorias","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de categorias (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_centros_de_custo","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de centros de custo (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"ids_clientes","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs de clientes (UUID), separados por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"metodos_pagamento","in":"query","style":"form","explode":false,"schemaId":"schema_16","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Formas de pagamento, separadas por vírgula ou repetindo o parâmetro. O nome em inglês usado pela API também é aceito, em qualquer caixa (por exemplo BANKING_BILLET para BOLETO_BANCARIO). NENHUMA seleciona as parcelas sem forma de pagamento, o que é diferente de omitir o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"referencias","in":"query","style":"form","explode":false,"schemaId":"schema_13","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referências, separadas por vírgula ou repetindo o parâmetro"},"children":[],"type":"text"}],"type":"paragraph"}]},{"name":"data_criacao_de","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de criação de (ISO 8601 sem timezone, hora de São Paulo, com ou sem os segundos), exige data_criacao_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01T00:00:00"},{"name":"data_criacao_ate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de criação até, exige data_criacao_de e não pode ser anterior a ela"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31T23:59:59"},{"name":"data_alteracao_de","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração de (ISO 8601 sem timezone, hora de São Paulo, com ou sem os segundos), exige data_alteracao_ate"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-01T00:00:00"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração até, exige data_alteracao_de, não pode ser anterior a ela e o intervalo entre as duas não pode passar de 365 dias"},"children":[],"type":"text"}],"type":"paragraph"}],"example":"2025-01-31T23:59:59"}],"pointer":"/paths/~1v1~1financeiro~1contas-a-receber/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/contas-a-receber","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","schemaId":"schema_0"},{"name":"tamanho_pagina","in":"query","schemaId":"schema_12"},{"name":"descricao","in":"query","schemaId":"schema_3"},{"name":"data_vencimento_de","in":"query","required":true,"example":"2025-01-01","schemaId":"schema_14"},{"name":"data_vencimento_ate","in":"query","required":true,"example":"2025-01-31","schemaId":"schema_14"},{"name":"data_competencia_de","in":"query","example":"2025-01-01","schemaId":"schema_14"},{"name":"data_competencia_ate","in":"query","example":"2025-01-31","schemaId":"schema_14"},{"name":"data_pagamento_de","in":"query","example":"2025-01-01","schemaId":"schema_14"},{"name":"data_pagamento_ate","in":"query","example":"2025-01-31","schemaId":"schema_14"},{"name":"valor_de","in":"query","example":"100.00","schemaId":"schema_3"},{"name":"valor_ate","in":"query","example":"999.99","schemaId":"schema_3"},{"name":"status","in":"query","schemaId":"schema_15","style":"form","explode":false},{"name":"ids_contas_financeiras","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"ids_categorias","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"ids_centros_de_custo","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"ids_clientes","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"metodos_pagamento","in":"query","schemaId":"schema_16","style":"form","explode":false},{"name":"referencias","in":"query","schemaId":"schema_13","style":"form","explode":false},{"name":"data_criacao_de","in":"query","example":"2025-01-01T00:00:00","schemaId":"schema_3"},{"name":"data_criacao_ate","in":"query","example":"2025-01-31T23:59:59","schemaId":"schema_3"},{"name":"data_alteracao_de","in":"query","example":"2025-01-01T00:00:00","schemaId":"schema_3"},{"name":"data_alteracao_ate","in":"query","example":"2025-01-31T23:59:59","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/contas-a-receber","href":"parcelas/obterreceitasporfiltro","openApiOperationId":"obterReceitasPorFiltro","summary":"Retornar as receitas por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/ListaContasAReceber"}},"schemaId":"components/schemas/ListaContasAReceber"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1contas-a-receber/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListaContasAReceber","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListaContasAReceber"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parcelas/obterreceitasporfiltro"}],"panels":[]}]},"httpPath":"/v1/financeiro/contas-a-receber"},{"label":"Retornar as parcelas pelo id do evento financeiro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/parcelas/listarparcelasporevento","routeSlug":"/open-api-docs/open-api-finance/parcelas/listarparcelasporevento","metadata":{"seo":{"title":"Retornar as parcelas pelo id do evento financeiro","description":"Retornar as parcelas pelo id do evento financeiro"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listarParcelasPorEvento","name":"Retornar as parcelas pelo id do evento financeiro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1parcelas/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as parcelas pelo id do evento financeiro","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id_evento","in":"query","schemaId":"schema_17","description":"ID do evento financeiro","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1parcelas/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/parcelas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"id_evento","in":"query","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_17"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/parcelas","href":"parcelas/listarparcelasporevento","openApiOperationId":"listarParcelasPorEvento","summary":"Retornar as parcelas pelo id do evento financeiro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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_18"}},"schemaId":"schema_18"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1parcelas/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_18"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parcelas/listarparcelasporevento"}],"panels":[]}]},"httpPath":"/v1/financeiro/parcelas"},{"label":"Retornar a parcela por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/parcelas/obterparcelaporid","routeSlug":"/open-api-docs/open-api-finance/parcelas/obterparcelaporid","metadata":{"seo":{"title":"Retornar a parcela por id","description":"Retornar a parcela por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterParcelaPorId","name":"Retornar a parcela por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a parcela por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_17","description":"ID da parcela","required":true,"example":"9986f173-f531-4660-96ae-04b71c879264"}],"pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/parcelas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9986f173-f531-4660-96ae-04b71c879264","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/parcelas/{id}","href":"parcelas/obterparcelaporid","openApiOperationId":"obterParcelaPorId","summary":"Retornar a parcela por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/Parcela"}},"schemaId":"components/schemas/Parcela"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Parcela","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Parcela"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parcelas/obterparcelaporid"}],"panels":[]}]},"httpPath":"/v1/financeiro/parcelas/{id}"},{"label":"Atualizar parcialmente uma parcela por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/parcelas/atualizarparcela","routeSlug":"/open-api-docs/open-api-finance/parcelas/atualizarparcela","metadata":{"seo":{"title":"Atualizar parcialmente uma parcela por id","description":"Atualizar parcialmente uma parcela por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"atualizarParcela","name":"Atualizar parcialmente uma parcela por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualizar parcialmente uma parcela por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_17","description":"ID da parcela","required":true,"example":"9986f173-f531-4660-96ae-04b71c879264"}],"pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoParcela"}},"schemaId":"components/schemas/AtualizacaoParcela","pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/patch/requestBody","description":"Dados da parcela a ser atualizada (patch parcial)"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/financeiro/parcelas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9986f173-f531-4660-96ae-04b71c879264","schemaId":"schema_17"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AtualizacaoParcela"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/parcelas/{id}","href":"parcelas/atualizarparcela","openApiOperationId":"atualizarParcela","summary":"Atualizar parcialmente uma parcela por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AtualizacaoParcela","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoParcela"}},"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/ParcelaAtualizada"}},"schemaId":"components/schemas/ParcelaAtualizada"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1parcelas~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ParcelaAtualizada","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ParcelaAtualizada"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/parcelas/atualizarparcela"}],"panels":[]}]},"httpPath":"/v1/financeiro/parcelas/{id}"}],"content":{"contentType":"group","meta":{"name":"Parcelas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Parcelas","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Consulta e atualização de parcelas de eventos financeiros: buscar por id, atualizar parcialmente, listar por evento e buscar as parcelas de contas a pagar e a receber."},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/contas-a-pagar","summary":"Retornar as despesas por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parcelas/obterdespesasporfiltro","deprecated":false},{"title":"/v1/financeiro/contas-a-receber","summary":"Retornar as receitas por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parcelas/obterreceitasporfiltro","deprecated":false},{"title":"/v1/financeiro/parcelas","summary":"Retornar as parcelas pelo id do evento financeiro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parcelas/listarparcelasporevento","deprecated":false},{"title":"/v1/financeiro/parcelas/{id}","summary":"Retornar a parcela por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/parcelas/obterparcelaporid","deprecated":false},{"title":"/v1/financeiro/parcelas/{id}","summary":"Atualizar parcialmente uma parcela por id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/parcelas/atualizarparcela","deprecated":false}]}]}]}]}},{"type":"group","label":"Baixas","link":"/open-api-docs/open-api-finance/baixas","routeSlug":"/open-api-docs/open-api-finance/baixas","items":[{"label":"Retornar as baixas pelo id da parcela","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/baixas/listarbaixasporparcela","routeSlug":"/open-api-docs/open-api-finance/baixas/listarbaixasporparcela","metadata":{"seo":{"title":"Retornar as baixas pelo id da parcela","description":"Retornar as baixas pelo id da parcela"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listarBaixasPorParcela","name":"Retornar as baixas pelo id da parcela","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1baixas/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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id_parcela","in":"query","schemaId":"schema_3","description":"ID da parcela","required":true}],"pointer":"/paths/~1v1~1financeiro~1baixas/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/baixas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"id_parcela","in":"query","required":true,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/v1/financeiro/baixas","href":"baixas/listarbaixasporparcela","openApiOperationId":"listarBaixasPorParcela","summary":"Retornar as baixas pelo id da parcela"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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_19"}},"schemaId":"schema_19"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1baixas/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/baixas/listarbaixasporparcela"}],"panels":[]}]},"httpPath":"/v1/financeiro/baixas"},{"label":"Criar uma nova baixa","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/baixas/criarbaixa","routeSlug":"/open-api-docs/open-api-finance/baixas/criarbaixa","metadata":{"seo":{"title":"Criar uma nova baixa","description":"Criar uma nova baixa"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarBaixa","name":"Criar uma nova baixa","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1baixas/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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoBaixa"}},"schemaId":"components/schemas/CriacaoBaixa","pointer":"/paths/~1v1~1financeiro~1baixas/post/requestBody","description":"Dados da baixa a ser criada"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/baixas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriacaoBaixa"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/baixas","href":"baixas/criarbaixa","openApiOperationId":"criarBaixa","summary":"Criar uma nova baixa"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoBaixa","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoBaixa"}},"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/BaixaCriada"}},"schemaId":"components/schemas/BaixaCriada"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1baixas/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaixaCriada","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaixaCriada"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/baixas/criarbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/baixas"},{"label":"Retornar a baixa por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/baixas/obterbaixaporid","routeSlug":"/open-api-docs/open-api-finance/baixas/obterbaixaporid","metadata":{"seo":{"title":"Retornar a baixa por id","description":"Retornar a baixa por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterBaixaPorId","name":"Retornar a baixa por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1baixas~1{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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":"ID da baixa","required":true}],"pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/baixas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/baixas/{id}","href":"baixas/obterbaixaporid","openApiOperationId":"obterBaixaPorId","summary":"Retornar a baixa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/Baixa"}},"schemaId":"components/schemas/Baixa"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Baixa","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Baixa"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/baixas/obterbaixaporid"}],"panels":[]}]},"httpPath":"/v1/financeiro/baixas/{id}"},{"label":"Deletar baixa por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/baixas/excluirbaixa","routeSlug":"/open-api-docs/open-api-finance/baixas/excluirbaixa","metadata":{"seo":{"title":"Deletar baixa por id","description":"Deletar baixa por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"excluirBaixa","name":"Deletar baixa por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1baixas~1{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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":"ID da baixa","required":true}],"pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/financeiro/baixas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/baixas/{id}","href":"baixas/excluirbaixa","openApiOperationId":"excluirBaixa","summary":"Deletar baixa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Baixa excluída com sucesso"},"children":[],"type":"text"}],"type":"paragraph"}]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/baixas/excluirbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/baixas/{id}"},{"label":"Atualizar parcialmente uma baixa por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/baixas/atualizarbaixa","routeSlug":"/open-api-docs/open-api-finance/baixas/atualizarbaixa","metadata":{"seo":{"title":"Atualizar parcialmente uma baixa por id","description":"Atualizar parcialmente uma baixa por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"atualizarBaixa","name":"Atualizar parcialmente uma baixa por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1baixas~1{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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":"ID da baixa","required":true}],"pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoBaixa"}},"schemaId":"components/schemas/AtualizacaoBaixa","pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/patch/requestBody","description":"Dados da baixa a ser atualizada (patch parcial)"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/financeiro/baixas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AtualizacaoBaixa"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/baixas/{id}","href":"baixas/atualizarbaixa","openApiOperationId":"atualizarBaixa","summary":"Atualizar parcialmente uma baixa por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/AtualizacaoBaixa","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AtualizacaoBaixa"}},"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/BaixaCriada"}},"schemaId":"components/schemas/BaixaCriada"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1baixas~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BaixaCriada","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BaixaCriada"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/baixas/atualizarbaixa"}],"panels":[]}]},"httpPath":"/v1/financeiro/baixas/{id}"}],"content":{"contentType":"group","meta":{"name":"Baixas"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Baixas","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","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":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, consulte nossa Central de Ajuda:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","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","inline":true,"attributes":{"content":"Lançamentos Financeiros"},"children":[],"type":"text"}],"type":"link"}],"type":"item"}],"type":"list"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/baixas","summary":"Retornar as baixas pelo id da parcela","prefix":{"name":"get","color":"get"},"badges":[],"link":"/baixas/listarbaixasporparcela","deprecated":false},{"title":"/v1/financeiro/baixas","summary":"Criar uma nova baixa","prefix":{"name":"post","color":"post"},"badges":[],"link":"/baixas/criarbaixa","deprecated":false},{"title":"/v1/financeiro/baixas/{id}","summary":"Retornar a baixa por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/baixas/obterbaixaporid","deprecated":false},{"title":"/v1/financeiro/baixas/{id}","summary":"Deletar baixa por id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/baixas/excluirbaixa","deprecated":false},{"title":"/v1/financeiro/baixas/{id}","summary":"Atualizar parcialmente uma baixa por id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/baixas/atualizarbaixa","deprecated":false}]}]}]}]}},{"type":"group","label":"Cobranças","link":"/open-api-docs/open-api-finance/cobrancas","routeSlug":"/open-api-docs/open-api-finance/cobrancas","items":[{"label":"Criar uma nova cobrança","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/cobrancas/gerarcobranca","routeSlug":"/open-api-docs/open-api-finance/cobrancas/gerarcobranca","metadata":{"seo":{"title":"Criar uma nova cobrança","description":"Criar uma nova cobrança"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"gerarCobranca","name":"Criar uma nova cobrança","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1cobrancas/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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoCobranca"}},"schemaId":"components/schemas/CriacaoCobranca","pointer":"/paths/~1v1~1financeiro~1cobrancas/post/requestBody","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Dados da cobrança a ser gerada"},"children":[],"type":"text"}],"type":"paragraph"}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/cobrancas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriacaoCobranca"}},"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/cobrancas","href":"cobrancas/gerarcobranca","openApiOperationId":"gerarCobranca","summary":"Criar uma nova cobrança"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoCobranca","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoCobranca"}},"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/Cobranca"}},"schemaId":"components/schemas/Cobranca"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1cobrancas/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cobranca","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cobranca"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cobrancas/gerarcobranca"}],"panels":[]}]},"httpPath":"/v1/financeiro/cobrancas"},{"label":"Retornar a cobrança por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/cobrancas/obtercobrancaporid","routeSlug":"/open-api-docs/open-api-finance/cobrancas/obtercobrancaporid","metadata":{"seo":{"title":"Retornar a cobrança por id","description":"Retornar a cobrança por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterCobrancaPorId","name":"Retornar a cobrança por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}/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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"required":true}],"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/cobrancas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/cobrancas/{id}","href":"cobrancas/obtercobrancaporid","openApiOperationId":"obterCobrancaPorId","summary":"Retornar a cobrança por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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/Cobranca"}},"schemaId":"components/schemas/Cobranca"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Cobranca","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Cobranca"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cobrancas/obtercobrancaporid"}],"panels":[]}]},"httpPath":"/v1/financeiro/cobrancas/{id}"},{"label":"Deletar cobrança por id","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/cobrancas/cancelarcobranca","routeSlug":"/open-api-docs/open-api-finance/cobrancas/cancelarcobranca","metadata":{"seo":{"title":"Deletar cobrança por id","description":"Deletar cobrança por id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelarCobranca","name":"Deletar cobrança por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}/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":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"required":true}],"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/financeiro/cobrancas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/financeiro/cobrancas/{id}","href":"cobrancas/cancelarcobranca","openApiOperationId":"cancelarCobranca","summary":"Deletar cobrança por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cobrança cancelada com sucesso"},"children":[],"type":"text"}],"type":"paragraph"}]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cobrancas/cancelarcobranca"}],"panels":[]}]},"httpPath":"/v1/financeiro/cobrancas/{id}"},{"label":"Retornar o PDF da cobrança","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/open-api-docs/open-api-finance/cobrancas/imprimircobrancapdf","routeSlug":"/open-api-docs/open-api-finance/cobrancas/imprimircobrancapdf","metadata":{"seo":{"title":"Retornar o PDF da cobrança","description":"Gera e retorna o arquivo PDF de uma cobrança do tipo boleto. Cobranças do tipo Pix ou link de pagamento não possuem arquivo para download."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"imprimirCobrancaPdf","name":"Retornar o PDF da cobrança","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}~1imprimir/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o PDF da 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","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Gera e retorna o arquivo PDF de uma cobrança do tipo boleto. Cobranças do tipo Pix ou link de pagamento não possuem arquivo para download."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"required":true}],"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}~1imprimir/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/cobrancas/{id}/imprimir","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","404","422","500"],"pointer":"/v1/financeiro/cobrancas/{id}/imprimir","href":"cobrancas/imprimircobrancapdf","openApiOperationId":"imprimirCobrancaPdf","summary":"Retornar o PDF da cobrança"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","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":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"PDF da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/pdf","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_20"},"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20","headers":{"Content-Disposition":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"attachment; filename=\"<descrição da cobrança>.pdf\\"},"children":[],"type":"text"}],"type":"paragraph"}],"schema":{"type":"string"}}},"headerSchemaId":"schema_21"},{"code":"400","description":"Bad Request","mediaType":"application/pdf","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/pdf","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"422","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A forma de pagamento da cobrança não possui arquivo para download"},"children":[],"type":"text"}],"type":"paragraph"}],"mediaType":"application/pdf","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/pdf","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1financeiro~1cobrancas~1{id}~1imprimir/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_20"},"application/json":{"schemaId":"schema_20"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"422","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/pdf","application/json"],"mediaTypeContent":{"application/pdf":{"schemaId":"components/schemas/ErroAPI"},"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cobrancas/imprimircobrancapdf"}],"panels":[]}]},"httpPath":"/v1/financeiro/cobrancas/{id}/imprimir"}],"content":{"contentType":"group","meta":{"name":"Cobranças"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cobranças","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"A API de Cobranças tem como objetivo automatizar e centralizar o processo de emissão, consulta, download do PDF 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":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, consulte nossa Central de Ajuda:"},"children":[],"type":"text"}],"type":"paragraph"},{"$$mdtype":"Node","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/19712368690189-Cobran%C3%A7as"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Cobranças"},"children":[],"type":"text"}],"type":"link"}],"type":"item"},{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","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","inline":true,"attributes":{"content":"Lançamentos Financeiros"},"children":[],"type":"text"}],"type":"link"}],"type":"item"}],"type":"list"}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/financeiro/cobrancas","summary":"Criar uma nova cobrança","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cobrancas/gerarcobranca","deprecated":false},{"title":"/v1/financeiro/cobrancas/{id}","summary":"Retornar a cobrança por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cobrancas/obtercobrancaporid","deprecated":false},{"title":"/v1/financeiro/cobrancas/{id}","summary":"Deletar cobrança por id","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cobrancas/cancelarcobranca","deprecated":false},{"title":"/v1/financeiro/cobrancas/{id}/imprimir","summary":"Retornar o PDF da cobrança","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cobrancas/imprimircobrancapdf","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AnexoBaixa":{"id":"components/schemas/AnexoBaixa","kind":"json-schema","title":"AnexoBaixa","data":{"description":"Anexo da baixa","type":"object","properties":{"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição do anexo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Descrição do documento"},"id":{"description":"ID do anexo","type":"string","example":"6323d5e1-b1db-44d3-839f-a0efcd8f0c34"},"nome":{"description":"Nome do arquivo","type":"string","example":"documento.pdf"},"referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência do anexo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"tipo":{"description":"Tipo do anexo","allOf":[{"$ref":"#/components/schemas/TipoDeAnexo"}],"example":"RECIBO"},"tipo_conteudo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo de conteúdo do anexo"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TipoDeConteudoDoAnexo"}],"example":"URL"},"url":{"description":"URL do anexo","type":"string","example":"https://example.com/documento.pdf"}}}},"components/schemas/AtualizacaoBaixa":{"id":"components/schemas/AtualizacaoBaixa","kind":"json-schema","title":"AtualizacaoBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de requisição para atualização de baixa (patch parcial: apenas os campos enviados são alterados)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["versao"],"properties":{"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorAtualizacaoBaixa"}]},"conta_financeira":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"data_pagamento":{"description":"Data de pagamento da baixa","type":"string","example":"2025-01-01"},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Forma de pagamento da baixa. O valor pode ser enviado em maiúsculas ou minúsculas (ex.: PIX_COBRANCA ou pix_cobranca)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"PIX_COBRANCA"},"nsu":{"description":"NSU da baixa","type":"string","example":"000215783210"},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Observação da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Pagamento referente à fatura de janeiro"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão atual da baixa. Obrigatória: a atualização é recusada quando a versão não é informada ou não corresponde à versão atual do registro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/AtualizacaoCentroCusto":{"id":"components/schemas/AtualizacaoCentroCusto","kind":"json-schema","title":"AtualizacaoCentroCusto","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"representa o modelo de atualização de um centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"ativo":{"description":"status do centro de custo","type":"boolean","example":true},"nome":{"description":"nome do centro de custo","type":"string","example":"Centro de Custo 1"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"versão atual do centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/AtualizacaoParcela":{"id":"components/schemas/AtualizacaoParcela","kind":"json-schema","title":"AtualizacaoParcela","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de atualização (patch parcial) de parcela — apenas os campos enviados são alterados"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["versao"],"properties":{"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/AtualizacaoParcelaComposicaoValor"}]},"data_pagamento_esperado":{"description":"Data prevista de pagamento","type":"string","example":"2025-01-31"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Parcela 1/1"},"id_conta_financeira":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Método de pagamento"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"nota":{"description":"Nota","type":"string","example":"Observação"},"nsu":{"description":"NSU","type":"string","example":"000215783210"},"pagamento_agendado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Pagamento agendado (só é alterado quando informado)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"perda":{"description":"Perda","allOf":[{"$ref":"#/components/schemas/AtualizacaoParcelaPerda"}]},"vencimento":{"description":"Data de vencimento","type":"string","example":"2025-01-31"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão atual da parcela (controle otimista). Obrigatória: a atualização é recusada quando a versão não é informada ou não corresponde à versão atual do registro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/AtualizacaoParcelaComposicaoValor":{"id":"components/schemas/AtualizacaoParcelaComposicaoValor","kind":"json-schema","title":"AtualizacaoParcelaComposicaoValor","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor na atualização da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"Desconto (default 0 quando omitido)","type":"number","example":0},"juros":{"description":"Juros (default 0 quando omitido)","type":"number","example":0},"multa":{"description":"Multa (default 0 quando omitida)","type":"number","example":0},"taxa":{"description":"Taxa (default 0 quando omitida)","type":"number","example":0},"valor_bruto":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor bruto (não alterado quando omitido)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100},"valor_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor líquido (não alterado quando omitido)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100}}}},"components/schemas/AtualizacaoParcelaPerda":{"id":"components/schemas/AtualizacaoParcelaPerda","kind":"json-schema","title":"AtualizacaoParcelaPerda","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Perda na atualização da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data":{"description":"Data da perda","type":"string","example":"2025-01-31"},"valor":{"description":"Valor da perda","type":"number","example":0}}}},"components/schemas/Baixa":{"id":"components/schemas/Baixa","kind":"json-schema","title":"Baixa","data":{"description":"Modelo de resposta para busca de baixa","type":"object","properties":{"anexos":{"description":"Anexos da baixa","type":"array","items":{"$ref":"#/components/schemas/AnexoBaixa"}},"atualizado_em":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de atualização da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-08-06T17:29:39"},"conta_financeira":{"description":"Conta financeira da baixa","allOf":[{"$ref":"#/components/schemas/ContaFinanceiraBaixa"}]},"data_pagamento":{"description":"Data de pagamento da baixa","type":"string","example":"2023-01-01"},"id":{"description":"ID da baixa","type":"string","example":"edeab29a-aa8a-43de-9ccd-6ded5e17b757"},"id_parcela":{"description":"ID da parcela","type":"string","example":"2f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_recibo_digital":{"description":"ID do recibo digital","type":"string","example":"4f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_reconciliacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da conciliação"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID de referência da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"0fc50efe-274b-4ba7-ac16-a9203f188149"},"id_solicitacao_cobranca":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"3f6029f4-19ed-4b97-bd5b-302d3b76d654"},"metodo_pagamento":{"description":"Forma de pagamento da baixa","allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"nsu":{"description":"NSU da baixa","type":"string","example":"000215783210"},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Observação da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Pagamento referente à fatura de janeiro"},"origem":{"description":"Origem da baixa","allOf":[{"$ref":"#/components/schemas/OrigemDoLancamento"}],"example":"VENDA"},"tipo_evento_financeiro":{"description":"Tipo da baixa","allOf":[{"$ref":"#/components/schemas/TipoDeCategoriaFinanceira"}],"example":"RECEITA"},"valor_composicao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorBaixa"}]},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/BaixaCriada":{"id":"components/schemas/BaixaCriada","kind":"json-schema","title":"BaixaCriada","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de resposta para criação/atualização de baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorBaixaCriada"}]},"conta_financeira":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"data_pagamento":{"description":"Data de pagamento da baixa","type":"string","example":"2025-01-01"},"id":{"description":"ID da baixa","type":"string","example":"edeab29a-aa8a-43de-9ccd-6ded5e17b757"},"metodo_pagamento":{"description":"Forma de pagamento da baixa","allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"PIX_COBRANCA"},"nsu":{"description":"NSU da baixa","type":"string","example":"000215783210"},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Observação da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Pagamento referente à fatura de janeiro"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/BaixaDaParcelaDaVenda":{"id":"components/schemas/BaixaDaParcelaDaVenda","kind":"json-schema","title":"BaixaDaParcelaDaVenda","data":{"description":"Baixa de uma parcela da venda","type":"object","properties":{"data_pagamento":{"description":"Data do pagamento (null quando ausente)","type":"string","example":"2026-09-01"},"id":{"type":"string","example":"edeab29a-aa8a-43de-9ccd-6ded5e17b757"},"id_conta_financeira":{"description":"ID da conta financeira (null quando ausente)","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"id_reconciliacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da conciliação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"9c4e1d77-3a52-4f8b-b1c6-2ad9e0f4517a"},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Método de pagamento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"valor_composicao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Bruto, multa, juros, desconto, taxa e líquido (RT-06)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorBaixaDaParcelaDaVenda"}]}}}},"components/schemas/CategoriaDRE":{"id":"components/schemas/CategoriaDRE","kind":"json-schema","title":"CategoriaDRE","data":{"description":"Item da estrutura DRE (recursivo via subitens)","type":"object","properties":{"categorias_financeiras":{"description":"Categorias financeiras associadas","type":"array","items":{"$ref":"#/components/schemas/CategoriaFinanceiraDRE"}},"codigo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código do item"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"01"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição do item"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Receita Operacional Bruta"},"id":{"description":"ID do item","type":"string","example":"0fc50efe-274b-4ba7-ac16-a9203f188149"},"indica_totalizador":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indica se o item é totalizador"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"posicao":{"description":"Ordem de posicionamento","type":"integer","example":1},"representa_soma_custo_medio":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Representa soma do custo médio do produto"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"subitens":{"description":"Subitens aninhados","type":"array","items":{"$ref":"#/components/schemas/CategoriaDRE"}}}}},"components/schemas/CategoriaFinanceira":{"id":"components/schemas/CategoriaFinanceira","kind":"json-schema","title":"CategoriaFinanceira","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de item de categorias financeira, representando uma categoria específica"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"categoria_pai":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da categoria pai (null quando é categoria raiz)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"123e4567-e89b-12d3-a456-426614174001"},"considera_custo_dre":{"description":"Indica se a categoria deve ser considerada no custo do DRE","type":"boolean","example":true},"entrada_dre":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Entrada no DRE (null quando ausente ou não mapeada)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/EntradaDRE"}],"example":"DESPESAS_ADMINISTRATIVAS"},"id":{"description":"ID da categoria financeira","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"description":"Nome da categoria financeira","type":"string","example":"Água e Saneamento"},"tipo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo da categoria financeira (null quando não mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TipoDeCategoriaFinanceira"}],"example":"RECEITA"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão da categoria financeira"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/CategoriaFinanceiraDRE":{"id":"components/schemas/CategoriaFinanceiraDRE","kind":"json-schema","title":"CategoriaFinanceiraDRE","data":{"description":"Categoria financeira associada a um item do DRE","type":"object","properties":{"ativo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indica se a categoria está ativa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"codigo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código da categoria financeira"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1.01"},"id":{"description":"ID da categoria financeira","type":"string","example":"1f6029f4-19ed-4b97-bd5b-302d3b76d654"},"nome":{"description":"Nome da categoria financeira","type":"string","example":"Vendas de produtos"}}}},"components/schemas/CategoriasFinanceiras":{"id":"components/schemas/CategoriasFinanceiras","kind":"json-schema","title":"CategoriasFinanceiras","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de resposta para categorias financeiras contendo todas as informações necessárias"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"itens":{"description":"Itens de categorias financeiras","type":"array","items":{"$ref":"#/components/schemas/CategoriaFinanceira"}},"itens_totais":{"description":"Total de itens encontrados","type":"integer","example":100}}}},"components/schemas/CentroCustoResposta":{"id":"components/schemas/CentroCustoResposta","kind":"json-schema","title":"CentroCustoResposta","data":{"description":"representa o modelo de resposta de um centro de custo","type":"object","required":["nome"],"properties":{"ativo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"indica se o centro de custo está ativo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"codigo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"código do centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"CC001"},"id":{"description":"ID do centro de custo","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"description":"nome do centro de custo","type":"string","example":"Centro de Custo 1"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"versão do centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/CentroCustoTotais":{"id":"components/schemas/CentroCustoTotais","kind":"json-schema","title":"CentroCustoTotais","data":{"description":"modelo de totalizadores de centros de custo","type":"object","properties":{"ativo":{"description":"total de centros de custo ativos","type":"integer","example":10},"inativo":{"description":"total de centros de custo inativos","type":"integer","example":5},"todos":{"description":"total geral de centros de custo","type":"integer","example":15}}}},"components/schemas/CentroDeCusto":{"id":"components/schemas/CentroDeCusto","kind":"json-schema","title":"CentroDeCusto","data":{"description":"modelo de centro de custo","type":"object","properties":{"ativo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"indica se o centro de custo está ativo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"codigo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"código do centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"CC001"},"id":{"description":"ID do centro de custo","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"description":"nome do centro de custo","type":"string","example":"Centro de Custo 1"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"versão do centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer"}}}},"components/schemas/Cobranca":{"id":"components/schemas/Cobranca","kind":"json-schema","title":"Cobranca","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de resposta para criação e busca de cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"status":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/StatusDaCobranca"}],"example":"QUITADO"},"url":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"URL da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"https://example.com/charge"}}}},"components/schemas/ComposicaoValor":{"id":"components/schemas/ComposicaoValor","kind":"json-schema","title":"ComposicaoValor","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ComposicaoValor representa a composição do valor de uma parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["valor_bruto"],"properties":{"desconto":{"description":"Desconto aplicado na parcela","type":"number","minimum":0,"example":0},"juros":{"description":"Juros aplicados na parcela","type":"number","minimum":0,"example":0},"multa":{"description":"Multa aplicada na parcela","type":"number","minimum":0,"example":0},"taxa":{"description":"Taxa aplicada na parcela","type":"number","minimum":0,"example":0},"valor_bruto":{"description":"Valor bruto da parcela","type":"number","minimum":0,"example":100}}}},"components/schemas/ComposicaoValorAtualizacaoBaixa":{"id":"components/schemas/ComposicaoValorAtualizacaoBaixa","kind":"json-schema","title":"ComposicaoValorAtualizacaoBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa a ser atualizada (patch parcial por subcampo). Todos os valores devem ser maiores ou iguais a zero e a soma das baixas da parcela não pode exceder o valor bruto dela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"Desconto da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"juros":{"description":"Juros da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"multa":{"description":"Multa da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"taxa":{"description":"Taxa da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"valor_bruto":{"description":"Valor bruto da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":100}}}},"components/schemas/ComposicaoValorBaixa":{"id":"components/schemas/ComposicaoValorBaixa","kind":"json-schema","title":"ComposicaoValorBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"Desconto da baixa","type":"number","example":2},"juros":{"description":"Juros da baixa","type":"number","example":5},"multa":{"description":"Multa da baixa","type":"number","example":10},"taxa":{"description":"Taxa da baixa","type":"number","example":1},"valor_bruto":{"description":"Valor bruto da baixa","type":"number","example":100},"valor_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor líquido da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":92}}}},"components/schemas/ComposicaoValorBaixaCriada":{"id":"components/schemas/ComposicaoValorBaixaCriada","kind":"json-schema","title":"ComposicaoValorBaixaCriada","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa criada/atualizada"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"Desconto da baixa","type":"number","example":0},"juros":{"description":"Juros da baixa","type":"number","example":0},"multa":{"description":"Multa da baixa","type":"number","example":0},"taxa":{"description":"Taxa da baixa","type":"number","example":0},"valor_bruto":{"description":"Valor bruto da baixa","type":"number","example":100}}}},"components/schemas/ComposicaoValorBaixaDaParcelaDaVenda":{"id":"components/schemas/ComposicaoValorBaixaDaParcelaDaVenda","kind":"json-schema","title":"ComposicaoValorBaixaDaParcelaDaVenda","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa da parcela da venda"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"Desconto (null quando ausente)","type":"number","example":0},"juros":{"description":"Juros (null quando ausente)","type":"number","example":2},"multa":{"description":"Multa (null quando ausente)","type":"number","example":3},"taxa":{"description":"Taxa (null quando ausente)","type":"number","example":0},"valor_bruto":{"description":"Valor bruto (null quando ausente)","type":"number","example":300},"valor_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor líquido (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":305}}}},"components/schemas/ComposicaoValorCriacaoBaixa":{"id":"components/schemas/ComposicaoValorCriacaoBaixa","kind":"json-schema","title":"ComposicaoValorCriacaoBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa a ser criada. Todos os valores devem ser maiores ou iguais a zero e a soma das baixas da parcela não pode exceder o valor bruto dela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["valor_bruto"],"properties":{"desconto":{"description":"Desconto da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"juros":{"description":"Juros da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"multa":{"description":"Multa da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"taxa":{"description":"Taxa da baixa. Deve ser maior ou igual a zero","type":"number","minimum":0,"example":0},"valor_bruto":{"description":"Valor bruto da baixa. Deve ser informado e maior ou igual a zero","type":"number","minimum":0,"example":100}}}},"components/schemas/ConciliacaoPendente":{"id":"components/schemas/ConciliacaoPendente","kind":"json-schema","title":"ConciliacaoPendente","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lançamento de extrato pendente de conciliação"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data":{"type":"string","example":"2026-08-03"},"descricao":{"type":"string","example":"PIX RECEBIDO JOAO DA SILVA"},"id":{"type":"string","example":"d41c8f2e-7b90-4a63-8e15-6f0d9c3b2a77"},"origem":{"allOf":[{"$ref":"#/components/schemas/OrigemDoExtrato"}],"example":"INTEGRACAO_BANCARIA"},"valor":{"type":"number","example":1520}}}},"components/schemas/ConciliacoesPendentes":{"id":"components/schemas/ConciliacoesPendentes","kind":"json-schema","title":"ConciliacoesPendentes","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lançamentos de extrato pendentes de conciliação de uma conta financeira num período"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"conta_financeira":{"$ref":"#/components/schemas/ContaFinanceiraConciliacoesPendentes"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ConciliacaoPendente"}},"itens_totais":{"type":"integer","example":37},"periodo":{"$ref":"#/components/schemas/PeriodoConciliacoesPendentes"},"possui_conciliacoes_pendentes":{"type":"boolean","example":true}}}},"components/schemas/CondicaoPagamento":{"id":"components/schemas/CondicaoPagamento","kind":"json-schema","title":"CondicaoPagamento","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CondicaoPagamento representa a condição de pagamento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["parcelas"],"properties":{"parcelas":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lista de parcelas da condição de pagamento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/CondicaoPagamentoParcela"}}}}},"components/schemas/CondicaoPagamentoParcela":{"id":"components/schemas/CondicaoPagamentoParcela","kind":"json-schema","title":"CondicaoPagamentoParcela","data":{"description":"Parcela representa uma parcela de um evento financeiro","type":"object","required":["conta_financeira","data_vencimento","descricao","detalhe_valor"],"properties":{"conta_financeira":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da conta financeira associada à parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"data_vencimento":{"description":"Data de vencimento da parcela","type":"string","example":"2025-01-01"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Parcela 1"},"detalhe_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValor"}]},"metodo_pagamento":{"description":"Metodo de pagamento da parcela","allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"CARTAO_CREDITO"},"nota":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Nota associada à parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Pagamento referente à fatura"}}}},"components/schemas/ConfiguracaoPadraoCategoria":{"id":"components/schemas/ConfiguracaoPadraoCategoria","kind":"json-schema","title":"ConfiguracaoPadraoCategoria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Configuração padrão de categoria"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id_categoria":{"description":"ID da categoria (null quando ausente)","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"nome_categoria":{"description":"Nome da categoria (null quando ausente)","type":"string","example":"Fretes"},"sugestao_padrao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sugestão padrão (null quando ausente ou desabilitada)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/SugestaoPadraoCategoria"}]},"tipo_operacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo de operação (null quando não mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TipoOperacao"}],"example":"FRETES_RECEBIDOS"}}}},"components/schemas/ContaAPagar":{"id":"components/schemas/ContaAPagar","kind":"json-schema","title":"ContaAPagar","data":{"description":"Conta a pagar","type":"object","properties":{"categorias":{"description":"Categorias associadas","type":"array","items":{"$ref":"#/components/schemas/ContaCategoria"}},"centros_de_custo":{"description":"Centros de custo associados","type":"array","items":{"$ref":"#/components/schemas/ContaCentroCusto"}},"data_alteracao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-08-15T14:30:00"},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-03-16"},"data_criacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de criação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-08-15T14:30:00"},"data_vencimento":{"description":"Data de vencimento (null quando ausente)","type":"string","example":"2025-08-15"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Aluguel do escritório"},"fornecedor":{"description":"Fornecedor (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ContaNegociador"}]},"id":{"description":"ID da parcela (null quando ausente)","type":"string","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"nao_pago":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor não pago (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":213023.79},"pago":{"description":"Valor pago (null quando ausente)","type":"number","example":0},"status":{"description":"Status (valor original, null quando ausente)","type":"string","example":"OVERDUE"},"status_traduzido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status traduzido (PT, null quando ausente ou não mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"ATRASADO"},"total":{"description":"Valor total (null quando ausente)","type":"number","example":781201.79}}}},"components/schemas/ContaAReceber":{"id":"components/schemas/ContaAReceber","kind":"json-schema","title":"ContaAReceber","data":{"description":"Conta a receber","type":"object","properties":{"categorias":{"description":"Categorias associadas","type":"array","items":{"$ref":"#/components/schemas/ContaCategoria"}},"centros_de_custo":{"description":"Centros de custo associados","type":"array","items":{"$ref":"#/components/schemas/ContaCentroCusto"}},"cliente":{"description":"Cliente (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ContaNegociador"}]},"data_alteracao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-08-15T14:30:00"},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-03-16"},"data_criacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de criação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-08-15T14:30:00"},"data_vencimento":{"description":"Data de vencimento (null quando ausente)","type":"string","example":"2025-08-15"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Venda de Produtos"},"id":{"description":"ID da parcela (null quando ausente)","type":"string","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"nao_pago":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor não pago (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":213023.79},"pago":{"description":"Valor pago (null quando ausente)","type":"number","example":0},"renegociacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Renegociação (null quando não houver)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ParcelaRenegociacao"}]},"status":{"description":"Status (valor original, null quando ausente)","type":"string","example":"OVERDUE"},"status_traduzido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status traduzido (PT, null quando ausente ou não mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"ATRASADO"},"total":{"description":"Valor total (null quando ausente)","type":"number","example":781201.79}}}},"components/schemas/ContaCategoria":{"id":"components/schemas/ContaCategoria","kind":"json-schema","title":"ContaCategoria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Categoria associada à conta a receber/pagar"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":"ID da categoria (null quando ausente)","type":"string","example":"b134ec6b-30f8-4edc-9a8f-4787fd3381ac"},"nome":{"description":"Nome da categoria (null quando ausente)","type":"string","example":"Adiantamento Salarial"}}}},"components/schemas/ContaCentroCusto":{"id":"components/schemas/ContaCentroCusto","kind":"json-schema","title":"ContaCentroCusto","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Centro de custo associado à conta a receber/pagar"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":"ID do centro de custo (null quando ausente)","type":"string","example":"428389c6-4e74-11ee-a3eb-9b5f0f22a7c1"},"nome":{"description":"Nome do centro de custo (null quando ausente)","type":"string","example":"Centro de custo de Teste"}}}},"components/schemas/ContaFinanceira":{"id":"components/schemas/ContaFinanceira","kind":"json-schema","title":"ContaFinanceira","data":{"description":"modelo de conta financeira","type":"object","properties":{"agencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"agência da conta"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1"},"ativo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"indica se a conta está ativa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"instituição bancária"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/InstituicaoBancaria"}],"example":"BANCO_BRASIL"},"codigo_banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"código do banco"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"conciliacoes_pendentes":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"quantidade de lançamentos do extrato bancário pendentes de conciliação, considerando o histórico da conta. Ausente quando a contagem não está disponível no momento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":3},"conta_padrao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"indica se é a conta padrão"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"id":{"description":"ID da conta financeira (null quando ausente)","type":"string","example":"93d3e187-e238-4a3e-8a7a-c66b1ec85e67"},"nome":{"description":"nome da conta financeira (null quando ausente)","type":"string","example":"BB Integração"},"numero":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"número da conta"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1000"},"possui_config_boleto_bancario":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"indica se possui configuração de boleto bancário"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"tipo":{"description":"tipo da conta financeira","allOf":[{"$ref":"#/components/schemas/TipoDeContaFinanceira"}],"example":"CONTA_CORRENTE"}}}},"components/schemas/ContaFinanceiraBaixa":{"id":"components/schemas/ContaFinanceiraBaixa","kind":"json-schema","title":"ContaFinanceiraBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Conta financeira associada à baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"agencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Agência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1234"},"ativo":{"description":"Status da conta","type":"boolean","example":true},"banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instituição bancária"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/InstituicaoBancaria"}],"example":"BANCO_BRASIL"},"codigo_banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código da instituição bancária"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":123},"conta_padrao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Conta padrão"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"id":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"nome":{"description":"Nome da conta","type":"string","example":"Conta Corrente"},"numero":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"56789"},"possui_config_boleto_bancario":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tem configuração de boleto"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"tipo":{"description":"Tipo da conta","allOf":[{"$ref":"#/components/schemas/TipoDeContaFinanceira"}],"example":"APLICACAO"}}}},"components/schemas/ContaFinanceiraConciliacoesPendentes":{"id":"components/schemas/ContaFinanceiraConciliacoesPendentes","kind":"json-schema","title":"ContaFinanceiraConciliacoesPendentes","data":{"description":"Conta financeira consultada","type":"object","properties":{"id":{"type":"string","example":"8a2f1c40-91b5-4e3a-9d77-2c5b8e1f0a34"}}}},"components/schemas/ContaFinanceiraExtratoImportado":{"id":"components/schemas/ContaFinanceiraExtratoImportado","kind":"json-schema","title":"ContaFinanceiraExtratoImportado","data":{"description":"Conta financeira consultada","type":"object","properties":{"id":{"type":"string","example":"8a2f1c40-91b5-4e3a-9d77-2c5b8e1f0a34"}}}},"components/schemas/ContaNegociador":{"id":"components/schemas/ContaNegociador","kind":"json-schema","title":"ContaNegociador","data":{"description":"Cliente ou fornecedor da conta a receber/pagar","type":"object","properties":{"id":{"description":"ID (null quando ausente)","type":"string","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"nome":{"description":"Nome (null quando ausente)","type":"string","example":"Maria da Silva"}}}},"components/schemas/ContaTotalValor":{"id":"components/schemas/ContaTotalValor","kind":"json-schema","title":"ContaTotalValor","data":{"description":"Valor de um total consolidado","type":"object","properties":{"valor":{"description":"Valor (null quando ausente)","type":"number","example":0}}}},"components/schemas/ContasTotais":{"id":"components/schemas/ContasTotais","kind":"json-schema","title":"ContasTotais","data":{"description":"Totais consolidados das contas a receber/pagar","type":"object","properties":{"aberto":{"description":"Total em aberto","allOf":[{"$ref":"#/components/schemas/ContaTotalValor"}]},"pago":{"description":"Total pago","allOf":[{"$ref":"#/components/schemas/ContaTotalValor"}]},"pendente":{"description":"Total pendente","allOf":[{"$ref":"#/components/schemas/ContaTotalValor"}]},"todos":{"description":"Total geral (null quando ausente)","type":"number","example":1000},"vence_hoje":{"description":"Total que vence hoje","allOf":[{"$ref":"#/components/schemas/ContaTotalValor"}]},"vencido":{"description":"Total vencido","allOf":[{"$ref":"#/components/schemas/ContaTotalValor"}]}}}},"components/schemas/CriacaoBaixa":{"id":"components/schemas/CriacaoBaixa","kind":"json-schema","title":"CriacaoBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de requisição para criação de baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["composicao_valor","conta_financeira","data_pagamento","id_parcela"],"properties":{"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorCriacaoBaixa"}]},"conta_financeira":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"data_pagamento":{"description":"Data de pagamento da baixa","type":"string","example":"2025-01-01"},"id_parcela":{"description":"ID da parcela da baixa","type":"string","example":"2f6029f4-19ed-4b97-bd5b-302d3b76d654"},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Forma de pagamento da baixa. Deve ser enviada em maiúsculas"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"PIX_COBRANCA"},"nsu":{"description":"NSU da baixa","type":"string","example":"000215783210"},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Observação da baixa"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Pagamento referente à fatura de janeiro"}}}},"components/schemas/CriacaoCentroCusto":{"id":"components/schemas/CriacaoCentroCusto","kind":"json-schema","title":"CriacaoCentroCusto","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"representa o modelo de criação de um centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["nome"],"properties":{"codigo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"código do centro de custo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"CC001"},"nome":{"description":"nome do centro de custo","type":"string","example":"Centro de Custo 1"}}}},"components/schemas/CriacaoCobranca":{"id":"components/schemas/CriacaoCobranca","kind":"json-schema","title":"CriacaoCobranca","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"estrutura de dados para criar uma nova cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["conta_bancaria","data_vencimento","descricao_fatura","id_parcela","tipo"],"properties":{"atributos":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Atributos da cobrança (opcional)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/CriacaoCobrancaAtributos"}]},"conta_bancaria":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"UUID da conta bancária. A conta deve ser do tipo COBRANCAS_CONTA_AZUL ou, no caso da Conta PJ Conta Azul, do tipo CONTA_CORRENTE habilitada para cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"550e8400-e29b-41d4-a716-446655440001"},"data_vencimento":{"description":"Data de vencimento, no formato ISO 8601 (YYYY-MM-DD)","type":"string","example":"2023-12-31"},"descricao_fatura":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição da fatura. Não pode conter apenas espaços"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Descrição da fatura"},"id_parcela":{"description":"UUID da parcela","type":"string","example":"550e8400-e29b-41d4-a716-446655440001"},"maximo_parcelas":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Máximo de parcelas (1 a 12), exclusivo para LINK_PAGAMENTO"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","maximum":12,"minimum":1,"example":3},"tipo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo de cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["BOLETO","LINK_PAGAMENTO","PIX_COBRANCA"],"example":"BOLETO"}}}},"components/schemas/CriacaoCobrancaAtributos":{"id":"components/schemas/CriacaoCobrancaAtributos","kind":"json-schema","title":"CriacaoCobrancaAtributos","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"estrutura de dados para os atributos da cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto_antecipado":{"description":"Desconto antecipado (opcional)","allOf":[{"$ref":"#/components/schemas/CriacaoCobrancaAtributosDescontoAntecipado"}]}}}},"components/schemas/CriacaoCobrancaAtributosDescontoAntecipado":{"id":"components/schemas/CriacaoCobrancaAtributosDescontoAntecipado","kind":"json-schema","title":"CriacaoCobrancaAtributosDescontoAntecipado","data":{"description":"estrutura de dados para o desconto antecipado. Deve ser informado apenas um dos campos: valor ou percentual","type":"object","properties":{"dias_antes_vencer":{"description":"Dias antes do vencimento para aplicar o desconto","type":"integer","example":5},"percentual":{"description":"Percentual do desconto antecipado. Quando informado, o campo valor deve ser omitido","type":"number","example":10},"valor":{"description":"Valor do desconto antecipado. Quando informado, o campo percentual deve ser omitido","type":"number","example":100}}}},"components/schemas/CriacaoEventoFinanceiroContasPagar":{"id":"components/schemas/CriacaoEventoFinanceiroContasPagar","kind":"json-schema","title":"CriacaoEventoFinanceiroContasPagar","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CriacaoEventoFinanceiroContasPagar representa o payload para criação de eventos financeiros de contas a pagar"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["condicao_pagamento","conta_financeira","data_competencia","descricao","id_fornecedor","rateio","valor"],"properties":{"condicao_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Condição de pagamento do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/CondicaoPagamento"}]},"conta_financeira":{"description":"ID da conta financeira","type":"string","example":"c89475a2-bdf9-4e6b-ae5b-5a8e96cab946"},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-01"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Conta a pagar - Fornecedor X"},"id_fornecedor":{"description":"ID do fornecedor","type":"string","example":"c89475a2-bdf9-4e6b-ae5b-5a8e96cab946"},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Observação do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Observação"},"rateio":{"description":"Rateio das categorias do evento financeiro","type":"array","items":{"$ref":"#/components/schemas/Rateio"}},"referencia_externa":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência externa do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"valor":{"description":"Valor do evento financeiro (deve ser maior que zero)","type":"number","minimum":0,"example":100}}}},"components/schemas/CriacaoEventoFinanceiroContasReceber":{"id":"components/schemas/CriacaoEventoFinanceiroContasReceber","kind":"json-schema","title":"CriacaoEventoFinanceiroContasReceber","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"CriacaoEventoFinanceiroContasReceber representa o payload para criação de eventos financeiros de contas a receber"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","required":["condicao_pagamento","conta_financeira","data_competencia","descricao","id_cliente","rateio","valor"],"properties":{"condicao_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Condição de pagamento do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/CondicaoPagamento"}]},"conta_financeira":{"description":"ID da conta financeira","type":"string","example":"c89475a2-bdf9-4e6b-ae5b-5a8e96cab946"},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-01"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Conta a receber - Cliente X"},"id_cliente":{"description":"ID do cliente","type":"string","example":"c89475a2-bdf9-4e6b-ae5b-5a8e96cab946"},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Observação do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Observação"},"rateio":{"description":"Rateio das categorias do evento financeiro","type":"array","items":{"$ref":"#/components/schemas/Rateio"}},"referencia_externa":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência externa do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"valor":{"description":"Valor do evento financeiro (deve ser maior que zero)","type":"number","minimum":0,"example":100}}}},"components/schemas/DiaHistoricoImportacao":{"id":"components/schemas/DiaHistoricoImportacao","kind":"json-schema","title":"DiaHistoricoImportacao","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Um dia do histórico de importação. Datas no formato ISO 8601 sem fuso, hora de São Paulo (ex.: 2026-09-16T06:48:29), e campo sem valor vem null"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data":{"type":"string","example":"2026-09-15"},"envios_com_lancamentos":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tentativas do dia que enviaram lançamentos"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":0},"envios_sem_lancamentos":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tentativas do dia que conectaram e o banco não tinha movimento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":2},"situacao":{"allOf":[{"$ref":"#/components/schemas/SituacaoDiaImportacao"}],"example":"SEM_LANCAMENTOS"},"tentativas":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tentativas de sincronização no dia"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":3},"ultima_mensagem":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Texto em português da última tentativa do dia, pronto para exibição"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Horário da última atualização: 07:17 - 15/09/26."},"ultima_tentativa_em":{"type":"string","example":"2026-09-15T07:17:36"},"ultimo_codigo_mensagem":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código da mensagem da última tentativa do dia. Código técnico do bank-integration, repassado sem tradução. Para exibição, use ultima_mensagem"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"UPDATED"},"ultimo_status":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status da última tentativa do dia. Código técnico do bank-integration, repassado sem tradução. Para exibição, use ultima_mensagem"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"NO_STATEMENTS"}}}},"components/schemas/EntradaDRE":{"id":"components/schemas/EntradaDRE","kind":"json-schema","title":"EntradaDRE","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Enum de entrada no DRE (Demonstração do Resultado do Exercício) de uma categoria financeira"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["RECEITA_BRUTA_VENDAS","RECEITAS_OPERACIONAIS","RECEITA_VENDA_PRODUTOS_SERVICOS","RECEITA_FRETES_ENTREGAS","RECEITA_LIQUIDA_VENDAS","DEDUCOES_RECEITA_BRUTA","IMPOSTOS_SOBRE_VENDAS","COMISSOES_SOBRE_VENDAS","DESCONTOS_INCONDICIONAIS","DEVOLUCOES_DE_VENDAS","LUCRO_BRUTO","CUSTOS_OPERACIONAIS","CUSTO_PRODUTOS_VENDIDOS","CUSTO_VENDAS_PRODUTOS","CUSTO_SERVICOS_PRESTADOS","LUCRO_PREJUIZO_OPERACIONAL","DESPESAS_OPERACIONAIS_NIVEL_1","DESPESAS_COMERCIAIS","DESPESAS_ADMINISTRATIVAS","DESPESAS_OPERACIONAIS_NIVEL_2","LUCRO_PREJUIZO_LIQUIDO","RECEITAS_DESPESAS_FINANCEIRAS","RECEITAS_RENDIMENTOS_FINANCEIROS","DESPESSAS_FINANCEIRAS","OUTRAS_RECEITAS_DESPESAS_NAO_OPERACIONAIS","OUTRAS_RECEITAS_NAO_OPERACIONAIS","OUTRAS_DESPESAS_NAO_OPERACIONAIS","LUCRO_PREJUIZO_FINAL","DESPESAS_INVESTIMENTOS_EMPRESTIMOS","INVESTIMENTOS_IMOBILIZADO","EMPRESTIMOS_DIVIDAS"],"x-enum-varnames":["DRE_ENTRY_RECEITA_BRUTA_VENDAS","DRE_ENTRY_RECEITAS_OPERACIONAIS","DRE_ENTRY_RECEITA_VENDA_PRODUTOS_SERVICOS","DRE_ENTRY_RECEITA_FRETES_ENTREGAS","DRE_ENTRY_RECEITA_LIQUIDA_VENDAS","DRE_ENTRY_DEDUCOES_RECEITA_BRUTA","DRE_ENTRY_IMPOSTOS_SOBRE_VENDAS","DRE_ENTRY_COMISSOES_SOBRE_VENDAS","DRE_ENTRY_DESCONTOS_INCONDICIONAIS","DRE_ENTRY_DEVOLUCOES_DE_VENDAS","DRE_ENTRY_LUCRO_BRUTO","DRE_ENTRY_CUSTOS_OPERACIONAIS","DRE_ENTRY_CUSTO_PRODUTOS_VENDIDOS","DRE_ENTRY_CUSTO_VENDAS_PRODUTOS","DRE_ENTRY_CUSTO_SERVICOS_PRESTADOS","DRE_ENTRY_LUCRO_PREJUIZO_OPERACIONAL","DRE_ENTRY_DESPESAS_OPERACIONAIS_NIVEL_1","DRE_ENTRY_DESPESAS_COMERCIAIS","DRE_ENTRY_DESPESAS_ADMINISTRATIVAS","DRE_ENTRY_DESPESAS_OPERACIONAIS_NIVEL_2","DRE_ENTRY_LUCRO_PREJUIZO_LIQUIDO","DRE_ENTRY_RECEITAS_DESPESAS_FINANCEIRAS","DRE_ENTRY_RECEITAS_RENDIMENTOS_FINANCEIROS","DRE_ENTRY_DESPESSAS_FINANCEIRAS","DRE_ENTRY_OUTRAS_RECEITAS_DESPESAS_NAO_OPERACIONAIS","DRE_ENTRY_OUTRAS_RECEITAS_NAO_OPERACIONAIS","DRE_ENTRY_OUTRAS_DESPESAS_NAO_OPERACIONAIS","DRE_ENTRY_LUCRO_PREJUIZO_FINAL","DRE_ENTRY_DESPESAS_INVESTIMENTOS_EMPRESTIMOS","DRE_ENTRY_INVESTIMENTOS_IMOBILIZADO","DRE_ENTRY_EMPRESTIMOS_DIVIDAS"]}},"components/schemas/ErroAPI":{"id":"components/schemas/ErroAPI","kind":"json-schema","title":"ErroAPI","data":{"description":"Modelo de resposta para erros da API","type":"object","properties":{"error":{"description":"Mensagem de erro","type":"string","example":"Mensagem de erro detalhada"}}}},"components/schemas/EstadoIntegracaoBancaria":{"id":"components/schemas/EstadoIntegracaoBancaria","kind":"json-schema","title":"EstadoIntegracaoBancaria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estado da integração bancária, derivado pelo bank-integration a partir do status da configuração"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["CONECTADA","PROCESSANDO","ACAO_NECESSARIA","ERRO","DESATIVADA","CANCELADA"],"x-enum-varnames":["BankIntegrationStateConnected","BankIntegrationStateProcessing","BankIntegrationStateActionRequired","BankIntegrationStateError","BankIntegrationStateDeactivated","BankIntegrationStateCanceled"]}},"components/schemas/EstruturaDRE":{"id":"components/schemas/EstruturaDRE","kind":"json-schema","title":"EstruturaDRE","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Estrutura de categorias do DRE (árvore recursiva)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"itens":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Itens de primeiro nível da estrutura DRE"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/CategoriaDRE"}}}}},"components/schemas/EventoFinanceiro":{"id":"components/schemas/EventoFinanceiro","kind":"json-schema","title":"EventoFinanceiro","data":{"description":"Evento financeiro","type":"object","properties":{"id":{"description":"ID do evento financeiro","type":"string","example":"0fc50efe-274b-4ba7-ac16-a9203f188149"}}}},"components/schemas/EventoFinanceiroCriado":{"id":"components/schemas/EventoFinanceiroCriado","kind":"json-schema","title":"EventoFinanceiroCriado","data":{"description":"representa o payload de um evento financeiro criado","type":"object","properties":{"agendado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"se o evento financeiro é agendado"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"condicao_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"condição de pagamento do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/EventoFinanceiroCriadoCondicaoPagamento"}]},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"data de competência do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-07-23"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"descrição do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Descrição do evento"},"id":{"description":"id do evento financeiro","type":"string","example":"9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39"},"id_cliente":{"description":"id do cliente do evento financeiro caso receita","type":"string","example":"f91047eb-2cff-4546-80e3-0f2b54d2cce0"},"id_fornecedor":{"description":"id do fornecedor do evento financeiro caso despesa","type":"string","example":"fda2f85c-ecd1-4cf1-9d0b-170c54b4cb3e"},"id_recorrencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"id da recorrência do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"indice_recorrencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"índice da recorrência do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"observacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"observação do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Observação do evento"},"rateio":{"description":"rateio do evento financeiro","type":"array","items":{"$ref":"#/components/schemas/EventoFinanceiroCriadoRateioCategoria"}},"referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"referência do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/EventoFinanceiroCriadoReferencia"}]},"referencia_externa":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"referência externa do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"tipo":{"description":"tipo do evento financeiro","allOf":[{"$ref":"#/components/schemas/TipoDeCategoriaFinanceira"}],"example":"DESPESA"},"valor":{"description":"valor do evento financeiro","type":"number","example":100},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"versão do evento financeiro"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/EventoFinanceiroCriadoCondicaoPagamento":{"id":"components/schemas/EventoFinanceiroCriadoCondicaoPagamento","kind":"json-schema","title":"EventoFinanceiroCriadoCondicaoPagamento","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"representa a condição de pagamento de um evento financeiro criado"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"parcelas":{"description":"parcelas","type":"array","items":{"$ref":"#/components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelas"}},"quantidade_parcelas":{"description":"quantidade de parcelas","type":"integer","example":1}}}},"components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelas":{"id":"components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelas","kind":"json-schema","title":"EventoFinanceiroCriadoCondicaoPagamentoParcelas","data":{"description":"representa uma parcela de um evento financeiro criado","type":"object","properties":{"agendado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"se a parcela é agendada"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"composição do valor da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelasComposicaoValor"}]},"conciliado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"se a parcela é conciliada"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"conta_financeira":{"type":"object","properties":{"id":{"description":"id da conta financeira","type":"string","example":"9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39"}}},"data_pagamento_esperado":{"description":"data de pagamento esperada da parcela","type":"string","example":"2025-07-23"},"data_vencimento":{"description":"data de vencimento da parcela","type":"string","example":"2025-07-23"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"descrição da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Descrição do evento"},"evento":{"description":"evento da parcela","allOf":[{"$ref":"#/components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelasEvento"}]},"id":{"description":"id da parcela","type":"string","example":"9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39"},"indice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"índice da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"metodo_pagamento":{"description":"metodo de pagamento","allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"nota":{"description":"nota da parcela","type":"string","example":"Nota do evento"},"nsu":{"description":"nsu da parcela","type":"string","example":"000215783210"},"pago":{"description":"valor pago da parcela","type":"number","example":100},"pendente":{"description":"valor pendente da parcela","type":"number","example":100},"status":{"description":"status da parcela","allOf":[{"$ref":"#/components/schemas/StatusDaParcela"}],"example":"EM_ABERTO"},"valor_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"valor líquido da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"versão da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelasComposicaoValor":{"id":"components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelasComposicaoValor","kind":"json-schema","title":"EventoFinanceiroCriadoCondicaoPagamentoParcelasComposicaoValor","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"representa a composição do valor de uma parcela de um evento financeiro criado"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"desconto","type":"number","example":100},"juros":{"description":"juros","type":"number","example":100},"multa":{"description":"multa","type":"number","example":100},"taxa":{"description":"taxa","type":"number","example":100},"valor_bruto":{"description":"valor bruto","type":"number","example":100},"valor_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"valor líquido"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100}}}},"components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelasEvento":{"id":"components/schemas/EventoFinanceiroCriadoCondicaoPagamentoParcelasEvento","kind":"json-schema","title":"EventoFinanceiroCriadoCondicaoPagamentoParcelasEvento","data":{"description":"representa o evento de uma parcela de um evento financeiro criado","type":"object","properties":{"agendado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"se o evento é agendado"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":true},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"data de competência do evento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-07-23"},"id":{"description":"id do evento","type":"string","example":"9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39"},"referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"referência do evento"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/EventoFinanceiroCriadoReferencia"}]},"tipo":{"description":"tipo do evento","allOf":[{"$ref":"#/components/schemas/TipoDeCategoriaFinanceira"}],"example":"DESPESA"}}}},"components/schemas/EventoFinanceiroCriadoRateioCategoria":{"id":"components/schemas/EventoFinanceiroCriadoRateioCategoria","kind":"json-schema","title":"EventoFinanceiroCriadoRateioCategoria","data":{"description":"representa o rateio de uma categoria financeira em um evento financeiro criado","type":"object","properties":{"id_categoria":{"description":"id da categoria do evento financeiro","type":"string","example":"23545d79-3c6a-4ec3-b805-5912736a3e00"},"rateio_centro_custo":{"description":"rateio do centro de custo do evento financeiro","type":"array","items":{"$ref":"#/components/schemas/EventoFinanceiroCriadoRateioCentroCusto"}},"valor":{"description":"valor do evento financeiro","type":"number","example":100}}}},"components/schemas/EventoFinanceiroCriadoRateioCentroCusto":{"id":"components/schemas/EventoFinanceiroCriadoRateioCentroCusto","kind":"json-schema","title":"EventoFinanceiroCriadoRateioCentroCusto","data":{"description":"representa o rateio de um centro de custo em uma categoria financeira de um evento financeiro criado","type":"object","properties":{"id_centro_custo":{"description":"id do centro de custo do evento financeiro","type":"string","example":"23545d79-3c6a-4ec3-b805-5912736a3e00"},"valor":{"description":"valor do evento financeiro","type":"number","example":100}}}},"components/schemas/EventoFinanceiroCriadoReferencia":{"id":"components/schemas/EventoFinanceiroCriadoReferencia","kind":"json-schema","title":"EventoFinanceiroCriadoReferencia","data":{"description":"representa a origem de um evento financeiro criado","type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"id da referência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39"},"origem":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"origem da referência"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/OrigemDoLancamento"}],"example":"LANCAMENTO_FINANCEIRO"},"revisao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"revisão da referência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/EventoFinanceiroDaVenda":{"id":"components/schemas/EventoFinanceiroDaVenda","kind":"json-schema","title":"EventoFinanceiroDaVenda","data":{"description":"Evento financeiro gerado pela venda","type":"object","properties":{"id":{"description":"ID do evento financeiro","type":"string","example":"1f6029f4-19ed-4b97-bd5b-302d3b76d654"}}}},"components/schemas/ExtratoImportado":{"id":"components/schemas/ExtratoImportado","kind":"json-schema","title":"ExtratoImportado","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Extrato bancário importado de uma conta financeira num período, resumido por origem"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"conta_financeira":{"$ref":"#/components/schemas/ContaFinanceiraExtratoImportado"},"itens_totais":{"type":"integer","example":128},"origens":{"type":"array","items":{"$ref":"#/components/schemas/OrigemExtratoImportado"}},"periodo":{"$ref":"#/components/schemas/PeriodoExtratoImportado"},"possui_extrato_importado":{"type":"boolean","example":true}}}},"components/schemas/HistoricoImportacao":{"id":"components/schemas/HistoricoImportacao","kind":"json-schema","title":"HistoricoImportacao","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Histórico diário de importação de uma conta financeira com integração bancária. dias vem do log de sincronização do bank-integration, um item para cada dia de consultado_de a consultado_ate, do mais recente para o mais antigo; lancamentos_descartados vem do goldengate e cobre o período pedido pela data do movimento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"consultado_ate":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Último dia consultado no log de sincronização, igual a data_fim"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2026-09-24"},"consultado_de":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Primeiro dia consultado no log de sincronização. Pode ser posterior a data_inicio quando a integração foi criada dentro do período"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2026-08-26"},"dias":{"type":"array","items":{"$ref":"#/components/schemas/DiaHistoricoImportacao"}},"id_conta_financeira":{"type":"string","example":"8a2f1c40-91b5-4e3a-9d77-2c5b8e1f0a34"},"lancamentos_descartados":{"type":"array","items":{"$ref":"#/components/schemas/LancamentoDescartado"}}}}},"components/schemas/InstituicaoBancaria":{"id":"components/schemas/InstituicaoBancaria","kind":"json-schema","title":"InstituicaoBancaria","data":{"type":"string","enum":["BANCO_BRASIL","BRADESCO","CAIXA_ECONOMICA","HSBC","ITAU","INTER","ORIGINAL","SANTANDER","BANCOOB","BANESTES","BANPARA","BANRISUL","BCN","BANK_BOSTON","BANCO_BRASILIA","BANCO_NORDESTE","CITIBANK","CREDISAN","NOSSA_CAIXA","MERCANTIL","REAL","SAFRA","SICREDI","SUDAMERIS","UNIBANCO","SICOOB","AILOS","BS2","NUBANK","UNICRED","NEON","C6","CORA","ACESSO","STONE","AGIBANK","ASAAS","TOPAZIO","DAYCOVAL","BANCO_AMAZONIA","BANESE","BTG_PACTUAL","OMNI","GENIAL","CAPITAL","RIBEIRAO_PRETO","PAN","BMG","BNP_PARIBAS_BRASIL","CCR_SAO_MIGUEL_OESTE","CREDISIS","CRESOL","FITBANK","GERENCIANET","GLOBAL_SCM","JP_MORGAN","JUNO","MERCADO_PAGO","MODAL","MONEY_PLUS","NEXT","OTIMO","PAGSEGURO","PICPAY","PJBANK","POLOCRED","RENDIMENTO","UNIPRIME","UNIPRIME_NORTE_PARANA","VORTX_DTVM","BRL_TRUST","IUGU","CONTAAZUL_IP","OUTROS","NAO_BANCO"],"x-enum-comments":{"ACESSO":"Swipe","NAO_BANCO":"Represents non-bank financial institutions","OUTROS":"Represents other banks not listed"},"x-enum-descriptions":["","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","Swipe","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","Represents other banks not listed","Represents non-bank financial institutions"],"x-enum-varnames":["BANCO_BRASIL","BRADESCO","CAIXA_ECONOMICA","HSBC","ITAU","INTER","ORIGINAL","SANTANDER","BANCOOB","BANESTES","BANPARA","BANRISUL","BCN","BANK_BOSTON","BANCO_BRASILIA","BANCO_NORDESTE","CITIBANK","CREDISAN","NOSSA_CAIXA","MERCANTIL","REAL","SAFRA","SICREDI","SUDAMERIS","UNIBANCO","SICOOB","AILOS","BS2","NUBANK","UNICRED","NEON","C6","CORA","ACESSO","STONE","AGIBANK","ASAAS","TOPAZIO","DAYCOVAL","BANCO_AMAZONIA","BANESE","BTG_PACTUAL","OMNI","GENIAL","CAPITAL","RIBEIRAO_PRETO","PAN","BMG","BNP_PARIBAS_BRASIL","CCR_SAO_MIGUEL_OESTE","CREDISIS","CRESOL","FITBANK","GERENCIANET","GLOBAL_SCM","JP_MORGAN","JUNO","MERCADO_PAGO","MODAL","MONEY_PLUS","NEXT","OTIMO","PAGSEGURO","PICPAY","PJBANK","POLOCRED","RENDIMENTO","UNIPRIME","UNIPRIME_NORTE_PARANA","VORTX_DTVM","BRL_TRUST","IUGU","CONTAAZUL_IP","OUTROS","NAO_BANCO"]}},"components/schemas/IntegracaoBancaria":{"id":"components/schemas/IntegracaoBancaria","kind":"json-schema","title":"IntegracaoBancaria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status de uma integração bancária. Datas no formato ISO 8601 sem fuso, hora de São Paulo (ex.: 2026-09-16T06:48:29)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"agencia":{"type":"string","example":"1234"},"banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instituição financeira da integração. Código técnico do bank-integration, repassado sem tradução"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"BRADESCO_OF_PLUGGY"},"codigo_banco":{"type":"integer","example":237},"codigo_mensagem":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código da última mensagem da integração. Código técnico do bank-integration, repassado sem tradução. Para exibição, use mensagem"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"NO_STATEMENTS"},"conectada_desde":{"type":"string","example":"2025-10-03T11:46:21"},"conta":{"type":"string","example":"56789-0"},"estado_integracao":{"allOf":[{"$ref":"#/components/schemas/EstadoIntegracaoBancaria"}],"example":"DESATIVADA"},"id_conta_financeira":{"type":"string","example":"8a2f1c40-91b5-4e3a-9d77-2c5b8e1f0a34"},"inativa_desde":{"type":"string","example":"2026-09-13T02:00:01"},"mensagem":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Texto em português da última mensagem da integração, pronto para exibição"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Horário da última atualização: 11:39 - 15/09/26."},"motivo_desativacao":{"allOf":[{"$ref":"#/components/schemas/MotivoDesativacaoIntegracaoBancaria"}],"example":"SEM_SINCRONIZACAO_30_DIAS"},"status_configuracao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status da configuração da integração. Código técnico do bank-integration, repassado sem tradução. Para exibição, use mensagem"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"BLOCKED"},"tipo_automacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo de automação da integração (ex.: API, PLUGGY_OPEN_FINANCE). Código técnico do bank-integration, repassado sem tradução"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"PLUGGY_OPEN_FINANCE"},"ultima_desativacao_em":{"type":"string","example":"2026-09-13T02:00:01"},"ultima_sincronizacao_sucesso_em":{"type":"string","example":"2026-08-12T06:48:29"}}}},"components/schemas/IntegracoesBancarias":{"id":"components/schemas/IntegracoesBancarias","kind":"json-schema","title":"IntegracoesBancarias","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Integrações bancárias do tenant, uma por conta financeira integrada"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"itens":{"type":"array","items":{"$ref":"#/components/schemas/IntegracaoBancaria"}},"itens_totais":{"type":"integer","example":7}}}},"components/schemas/LancamentoDescartado":{"id":"components/schemas/LancamentoDescartado","kind":"json-schema","title":"LancamentoDescartado","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lançamento que chegou na importação e foi descartado. Datas no formato ISO 8601 (YYYY-MM-DD), e campo sem valor vem null"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data_descarte":{"type":"string","example":"2026-09-13"},"data_movimento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data do movimento: a do pagamento quando houver, senão a do lançamento. É o eixo do filtro de período"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2026-09-12"},"descricao":{"type":"string","example":"PIX RECEBIDO JOAO DA SILVA"},"id_lancamento":{"type":"string","example":"d41c8f2e-7b90-4a63-8e15-6f0d9c3b2a77"},"motivo_descarte":{"allOf":[{"$ref":"#/components/schemas/MotivoDescarte"}],"example":"DUPLICADO"},"origem_descarte":{"allOf":[{"$ref":"#/components/schemas/OrigemDescarte"}],"example":"AUTOMATICO"},"origem_lancamento":{"allOf":[{"$ref":"#/components/schemas/OrigemDoExtrato"}],"example":"INTEGRACAO_BANCARIA"},"tipo":{"allOf":[{"$ref":"#/components/schemas/TipoEventoFinanceiro"}],"example":"RECEITA"},"valor":{"type":"number","example":1520}}}},"components/schemas/ListaContasAPagar":{"id":"components/schemas/ListaContasAPagar","kind":"json-schema","title":"ListaContasAPagar","data":{"description":"Lista de contas a pagar","type":"object","properties":{"itens":{"description":"Contas a pagar","type":"array","items":{"$ref":"#/components/schemas/ContaAPagar"}},"itens_totais":{"description":"Total de contas a pagar encontradas","type":"integer","example":10},"totais":{"description":"Totais consolidados","allOf":[{"$ref":"#/components/schemas/ContasTotais"}]}}}},"components/schemas/ListaContasAReceber":{"id":"components/schemas/ListaContasAReceber","kind":"json-schema","title":"ListaContasAReceber","data":{"description":"Lista de contas a receber","type":"object","properties":{"itens":{"description":"Contas a receber","type":"array","items":{"$ref":"#/components/schemas/ContaAReceber"}},"itens_totais":{"description":"Total de contas a receber encontradas","type":"integer","example":10},"totais":{"description":"Totais consolidados","allOf":[{"$ref":"#/components/schemas/ContasTotais"}]}}}},"components/schemas/ListaContasFinanceiras":{"id":"components/schemas/ListaContasFinanceiras","kind":"json-schema","title":"ListaContasFinanceiras","data":{"description":"modelo de resposta para a lista contas financeiras","type":"object","properties":{"itens":{"description":"lista de contas financeiras","type":"array","items":{"$ref":"#/components/schemas/ContaFinanceira"}},"itens_totais":{"description":"total de itens na resposta","type":"integer","example":150}}}},"components/schemas/ListaEventosFinanceiros":{"id":"components/schemas/ListaEventosFinanceiros","kind":"json-schema","title":"ListaEventosFinanceiros","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lista de eventos financeiros alterados no período"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"itens":{"description":"Eventos financeiros","type":"array","items":{"$ref":"#/components/schemas/EventoFinanceiro"}},"itens_totais":{"description":"Total de eventos financeiros encontrados","type":"integer","example":10}}}},"components/schemas/ListaSaldosIniciais":{"id":"components/schemas/ListaSaldosIniciais","kind":"json-schema","title":"ListaSaldosIniciais","data":{"description":"Lista de eventos financeiros de saldo inicial","type":"object","properties":{"itens":{"description":"Saldos iniciais","type":"array","items":{"$ref":"#/components/schemas/SaldoInicial"}},"itens_totais":{"description":"Total de saldos iniciais encontrados","type":"integer","example":10}}}},"components/schemas/ListaTransferencias":{"id":"components/schemas/ListaTransferencias","kind":"json-schema","title":"ListaTransferencias","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Lista de transferências (exportação contábil)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"itens":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Transferências"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/Transferencia"}},"itens_totais":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total de transferências encontradas"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":10}}}},"components/schemas/ListagemCentroDeCusto":{"id":"components/schemas/ListagemCentroDeCusto","kind":"json-schema","title":"ListagemCentroDeCusto","data":{"description":"modelo de resposta da lista de centros de custo","type":"object","properties":{"itens":{"type":"array","items":{"$ref":"#/components/schemas/CentroDeCusto"}},"itens_totais":{"description":"total de itens na resposta","type":"integer","example":150},"totais":{"description":"totais ativos, inativos e total geral","allOf":[{"$ref":"#/components/schemas/CentroCustoTotais"}]}}}},"components/schemas/MetodoDePagamento":{"id":"components/schemas/MetodoDePagamento","kind":"json-schema","title":"MetodoDePagamento","data":{"type":"string","enum":["BOLETO_BANCARIO","CARTAO_CREDITO","CARTAO_DEBITO","DINHEIRO","CHEQUE","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO","CARTAO_CREDITO_VIA_LINK"],"x-enum-varnames":["BANKING_BILLET","CREDIT_CARD","DEBIT_CARD","CASH","CHECK","BANKING_TRANSFER","OTHER","DIGITAL_WALLET","CASHBACK","STORE_CREDIT","VIRTUAL_CREDIT","BANKING_DEPOSIT","INSTANT_PAYMENT","FIDELITY_PROGRAM","WITHOUT_PAYMENT","FOOD_VOUCHER","FUEL_VOUCHER","GIFT_VOUCHER","MEAL_VOUCHER","PIX_CHARGE","AUTOMATIC_DEBIT","PAYMENT_LINK"]}},"components/schemas/MotivoDesativacaoIntegracaoBancaria":{"id":"components/schemas/MotivoDesativacaoIntegracaoBancaria","kind":"json-schema","title":"MotivoDesativacaoIntegracaoBancaria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Causa da desativação automática da integração bancária. Presente somente quando o estado é DESATIVADA"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["SEM_SINCRONIZACAO_30_DIAS","TENANT_INATIVO"],"x-enum-varnames":["BankIntegrationDeactivationReasonNoSync30Days","BankIntegrationDeactivationReasonInactiveTenant"]}},"components/schemas/MotivoDescarte":{"id":"components/schemas/MotivoDescarte","kind":"json-schema","title":"MotivoDescarte","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Motivo do descarte do lançamento na importação, traduzido do ignored_reason do goldengate"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["IGNORADO","DUPLICADO","BOLETO_RELEVANTE","DATA_RETROATIVA","DATA_RETROATIVA_OPEN_FINANCE","ESTORNADO","TRANSFERENCIA_DE_SALDO"],"x-enum-varnames":["DiscardReasonIgnored","DiscardReasonDuplicated","DiscardReasonRelevantBillet","DiscardReasonBackdated","DiscardReasonOpenFinanceBackdated","DiscardReasonRefunded","DiscardReasonBalanceTransfer"]}},"components/schemas/OrigemDescarte":{"id":"components/schemas/OrigemDescarte","kind":"json-schema","title":"OrigemDescarte","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Quem descartou o lançamento: AUTOMATICO (a importação, sem usuário) ou MANUAL (um usuário ignorou o lançamento na conciliação)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["AUTOMATICO","MANUAL"],"x-enum-varnames":["DiscardOriginAutomatic","DiscardOriginManual"]}},"components/schemas/OrigemDoExtrato":{"id":"components/schemas/OrigemDoExtrato","kind":"json-schema","title":"OrigemDoExtrato","data":{"type":"string","enum":["INTEGRACAO_MANUAL","INTEGRACAO_BANCARIA"],"x-enum-varnames":["INTEGRACAO_MANUAL","INTEGRACAO_BANCARIA"]}},"components/schemas/OrigemDoLancamento":{"id":"components/schemas/OrigemDoLancamento","kind":"json-schema","title":"OrigemDoLancamento","data":{"type":"string","enum":["VENDA","LANCAMENTO_FINANCEIRO","VENDA_AGENDADA","RENEGOCIACAO","DAS","FOLHA","TRANSFERENCIA","SALDO_CONTA_BANCARIA","COMPRA","COMPRA_AGENDADA","IMPORTACAO_DOCUMENTO","IMPOSTO_RETIDO","NOTA_COMPRA","ANTECIPACAO","HONORARIOS_CONTABEIS","SIC"],"x-enum-varnames":["SALE","FINANCIAL_ENTRY","SALE_SCHEDULED","RENEGOTIATION","DAS","PAYROLL","TRANSFER","FINANCIAL_ACCOUNT_BALANCE","PURCHASE","PURCHASE_SCHEDULED","DOCUMENTS","PURCHASE_TAX","PURCHASE_INVOICE","RECEIVABLES_FINANCING","ACCOUNTING_FEE","SIC"]}},"components/schemas/OrigemExtratoImportado":{"id":"components/schemas/OrigemExtratoImportado","kind":"json-schema","title":"OrigemExtratoImportado","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Resumo do extrato importado de uma origem dentro do período"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data_primeiro_lancamento":{"type":"string","example":"2026-08-01"},"data_ultimo_lancamento":{"type":"string","example":"2026-08-27"},"datas":{"type":"array","items":{"type":"string"},"example":["2026-08-01","2026-08-02"]},"itens_totais":{"type":"integer","example":84},"origem":{"allOf":[{"$ref":"#/components/schemas/OrigemDoExtrato"}],"example":"INTEGRACAO_MANUAL"}}}},"components/schemas/Parcela":{"id":"components/schemas/Parcela","kind":"json-schema","title":"Parcela","data":{"description":"Parcela de um evento financeiro (detalhe completo)","type":"object","properties":{"anexos":{"description":"Anexos da parcela","type":"array","items":{"$ref":"#/components/schemas/ParcelaAnexo"}},"baixa_agendada":{"description":"Indica baixa agendada (null quando ausente)","type":"boolean","example":false},"baixas":{"description":"Baixas da parcela","type":"array","items":{"$ref":"#/components/schemas/Baixa"}},"conciliado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indica se está conciliada (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"conta_financeira":{"description":"Conta financeira (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ContaFinanceira"}]},"data_alteracao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de alteração (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-31T10:00:00"},"data_pagamento_previsto":{"description":"Data prevista de pagamento (null quando ausente)","type":"string","example":"2025-01-31"},"data_vencimento":{"description":"Data de vencimento (null quando ausente)","type":"string","example":"2025-01-31"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Parcela 1/1"},"evento":{"description":"Resumo do evento financeiro (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ParcelaEvento"}]},"fatura":{"description":"Fatura (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ParcelaFatura"}]},"id":{"description":"ID da parcela (null quando ausente)","type":"string","example":"2f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_boleto_bancario_autorizado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID do boleto bancário autorizado (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"4f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_conta_financeira":{"description":"ID da conta financeira (null quando ausente)","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"id_ultima_solicitacao_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da última solicitação de pagamento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"3f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_ultimo_solicitacao_cobranca":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da última solicitação de cobrança (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5f6029f4-19ed-4b97-bd5b-302d3b76d654"},"indice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Índice da parcela (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Método de pagamento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"nao_pago":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor não pago (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100},"nota":{"description":"Nota (null quando ausente)","type":"string","example":"Observação"},"nsu":{"description":"NSU (null quando ausente)","type":"string","example":"000215783210"},"perda":{"description":"Perda associada (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ParcelaPerda"}]},"referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência da parcela (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"renegociacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Renegociação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ParcelaRenegociacao"}]},"solicitacoes_cobrancas":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Solicitações de cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/ParcelaSolicitacaoCobranca"}},"status":{"description":"Status da parcela (null quando ausente)","allOf":[{"$ref":"#/components/schemas/StatusDetalhadoDaParcela"}],"example":"PENDENTE"},"valor_composicao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorBaixa"}]},"valor_pago":{"description":"Valor pago (null quando ausente)","type":"number","example":0},"valor_total_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor total líquido (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão da parcela (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/ParcelaAnexo":{"id":"components/schemas/ParcelaAnexo","kind":"json-schema","title":"ParcelaAnexo","data":{"description":"Anexo da parcela","type":"object","properties":{"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Documento"},"id":{"description":"ID do anexo (null quando ausente)","type":"string","example":"df6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_parcela":{"description":"ID da parcela (null quando ausente)","type":"string","example":"2f6029f4-19ed-4b97-bd5b-302d3b76d654"},"nome":{"description":"Nome (null quando ausente)","type":"string","example":"documento.pdf"},"referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"tipo_anexo":{"description":"Tipo do anexo (null quando ausente)","allOf":[{"$ref":"#/components/schemas/TipoDeAnexoDaParcela"}],"example":"BOLETO_BANCARIO"},"tipo_conteudo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo de conteúdo (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TipoDeConteudoDoAnexo"}],"example":"URL"},"url":{"description":"URL (null quando ausente)","type":"string","example":"https://example.com/doc.pdf"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/ParcelaAtualizada":{"id":"components/schemas/ParcelaAtualizada","kind":"json-schema","title":"ParcelaAtualizada","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Modelo de resposta da atualização de parcela (reduzido)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorBaixa"}]},"conta_financeira":{"description":"Conta financeira (reduzida, null quando ausente)","allOf":[{"$ref":"#/components/schemas/ParcelaAtualizadaContaFinanceira"}]},"data_pagamento_esperado":{"description":"Data prevista de pagamento (null quando ausente)","type":"string","example":"2025-01-31"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Parcela 1/1"},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Método de pagamento (null quando não mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"nota":{"description":"Nota (null quando ausente)","type":"string","example":"Observação"},"nsu":{"description":"NSU (null quando ausente)","type":"string","example":"000215783210"},"pagamento_agendado":{"description":"Pagamento agendado (null quando ausente)","type":"boolean","example":false},"perda":{"description":"Perda (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ParcelaPerda"}]},"vencimento":{"description":"Data de vencimento (null quando ausente)","type":"string","example":"2025-01-31"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/ParcelaAtualizadaContaFinanceira":{"id":"components/schemas/ParcelaAtualizadaContaFinanceira","kind":"json-schema","title":"ParcelaAtualizadaContaFinanceira","data":{"description":"Conta financeira (reduzida) da parcela atualizada","type":"object","properties":{"agencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Agência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1234"},"banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instituição bancária (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/InstituicaoBancaria"}],"example":"BANCO_BRASIL"},"codigo_banco":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código do banco (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"id":{"description":"ID da conta financeira (null quando ausente)","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"nome":{"description":"Nome (null quando ausente)","type":"string","example":"Conta Corrente"},"numero":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"56789"},"tipo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo (null quando não mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TipoDeContaFinanceira"}],"example":"CONTA_CORRENTE"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/ParcelaCondicaoPagamento":{"id":"components/schemas/ParcelaCondicaoPagamento","kind":"json-schema","title":"ParcelaCondicaoPagamento","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Condição de pagamento do evento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"montante_fixo":{"description":"Indica montante fixo","type":"boolean","example":false},"quantidade_parcelas":{"description":"Quantidade de parcelas (null quando ausente)","type":"integer","example":1}}}},"components/schemas/ParcelaDaVenda":{"id":"components/schemas/ParcelaDaVenda","kind":"json-schema","title":"ParcelaDaVenda","data":{"description":"Parcela da venda","type":"object","properties":{"baixas":{"description":"Baixas da parcela, devolvidas inclusive em RENEGOCIADO, PERDIDO e CANCELADO (RT-03)","type":"array","items":{"$ref":"#/components/schemas/BaixaDaParcelaDaVenda"}},"conciliado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indica se está conciliada (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"data_vencimento":{"description":"Data de vencimento (null quando ausente)","type":"string","example":"2026-09-03"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Parcela 1/2"},"id":{"description":"ID da parcela","type":"string","example":"2f6029f4-19ed-4b97-bd5b-302d3b76d654"},"indice":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Posição da parcela no carnê (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"metodo_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Método de pagamento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/MetodoDePagamento"}],"example":"BOLETO_BANCARIO"},"nao_pago":{"description":"Valor em aberto (null quando ausente)","type":"number","example":450},"renegociacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Renegociação, exposta quando presente porque explica um status que sozinho engana (RT-04)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/RenegociacaoDaParcelaDaVenda"}]},"status":{"description":"Status detalhado, calculado a partir da parcela","allOf":[{"$ref":"#/components/schemas/StatusDetalhadoDaParcela"}],"example":"RECEBIDO_PARCIAL"},"valor_pago":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor já pago (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":300},"valor_total_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor total líquido da parcela (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":750}}}},"components/schemas/ParcelaEvento":{"id":"components/schemas/ParcelaEvento","kind":"json-schema","title":"ParcelaEvento","data":{"description":"Resumo do evento financeiro da parcela","type":"object","properties":{"agendado":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Indica se é agendado"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"codigo_referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código de referência externa do evento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"123456"},"condicao_pagamento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Condição de pagamento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ParcelaCondicaoPagamento"}]},"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-01"},"id":{"description":"ID do evento (null quando ausente)","type":"string","example":"1f6029f4-19ed-4b97-bd5b-302d3b76d654"},"rateio":{"description":"Rateio de categorias","type":"array","items":{"$ref":"#/components/schemas/ParcelaRateioCategoria"}},"referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência do evento (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ParcelaReferencia"}]},"tipo":{"description":"Tipo do evento (RECEITA/DESPESA, null quando ausente)","allOf":[{"$ref":"#/components/schemas/TipoDeCategoriaFinanceira"}],"example":"RECEITA"}}}},"components/schemas/ParcelaFatura":{"id":"components/schemas/ParcelaFatura","kind":"json-schema","title":"ParcelaFatura","data":{"description":"Fatura da parcela","type":"object","properties":{"numero":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da fatura (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":123},"rps":{"description":"RPS (null quando ausente)","type":"integer","example":456},"tipo_fatura":{"description":"Tipo da fatura (NFE, NFSE, NFCE; null quando ausente)","type":"string","example":"NFE"}}}},"components/schemas/ParcelaNotificacaoCobranca":{"id":"components/schemas/ParcelaNotificacaoCobranca","kind":"json-schema","title":"ParcelaNotificacaoCobranca","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Notificação de cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"aberto_em":{"description":"Aberto em (null quando ausente)","type":"string","example":"2025-01-31"},"agendado":{"description":"Agendado","type":"boolean","example":false},"assunto":{"description":"Assunto (null quando ausente)","type":"string","example":"Cobrança"},"auto_notificacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Auto notificação"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"corpo":{"description":"Corpo (null quando ausente)","type":"string","example":"Corpo da mensagem"},"enviado_em":{"description":"Enviado em (null quando ausente)","type":"string","example":"2025-01-31"},"envio_instantaneo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Envio instantâneo"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"boolean","example":false},"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da notificação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"bf6029f4-19ed-4b97-bd5b-302d3b76d654"},"itens_notificacao_cobranca":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Itens da notificação"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/ParcelaNotificacaoCobrancaItem"}},"respondido_para":{"description":"Responder para (null quando ausente)","type":"string","example":"contato@example.com"},"solicitacao_cobranca_ids":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"IDs das solicitações de cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"type":"string"}},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/ParcelaNotificacaoCobrancaItem":{"id":"components/schemas/ParcelaNotificacaoCobrancaItem","kind":"json-schema","title":"ParcelaNotificacaoCobrancaItem","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Item de notificação de cobrança"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"email":{"description":"E-mail (null quando ausente)","type":"string","example":"cliente@example.com"},"id":{"description":"ID do item (null quando ausente)","type":"string","example":"cf6029f4-19ed-4b97-bd5b-302d3b76d654"},"sms":{"description":"SMS (null quando ausente)","type":"string","example":"+5511999999999"},"status_entrega":{"description":"Status de entrega (null quando ausente)","allOf":[{"$ref":"#/components/schemas/StatusDeEntrega"}],"example":"ENVIADO"},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"whatsapp":{"description":"WhatsApp (null quando ausente)","type":"string","example":"+5511999999999"}}}},"components/schemas/ParcelaPerda":{"id":"components/schemas/ParcelaPerda","kind":"json-schema","title":"ParcelaPerda","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Perda associada à parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data":{"description":"Data da perda (null quando ausente)","type":"string","example":"2025-01-31"},"valor":{"description":"Valor da perda (null quando ausente)","type":"number","example":0}}}},"components/schemas/ParcelaRateioCategoria":{"id":"components/schemas/ParcelaRateioCategoria","kind":"json-schema","title":"ParcelaRateioCategoria","data":{"description":"Rateio de categoria do evento","type":"object","properties":{"id_categoria":{"description":"ID da categoria (null quando ausente)","type":"string","example":"7f6029f4-19ed-4b97-bd5b-302d3b76d654"},"nome_categoria":{"description":"Nome da categoria (null quando ausente)","type":"string","example":"Vendas"},"rateio_centro_custo":{"description":"Rateio por centro de custo","type":"array","items":{"$ref":"#/components/schemas/ParcelaRateioCentroCusto"}},"valor":{"description":"Valor (null quando ausente)","type":"number","example":100},"valor_bruto":{"description":"Valor bruto (null quando ausente)","type":"number","example":100}}}},"components/schemas/ParcelaRateioCentroCusto":{"id":"components/schemas/ParcelaRateioCentroCusto","kind":"json-schema","title":"ParcelaRateioCentroCusto","data":{"description":"Rateio por centro de custo","type":"object","properties":{"id_centro_custo":{"description":"ID do centro de custo (null quando ausente)","type":"string","example":"8f6029f4-19ed-4b97-bd5b-302d3b76d654"},"nome_centro_custo":{"description":"Nome do centro de custo (null quando ausente)","type":"string","example":"Comercial"},"valor":{"description":"Valor (null quando ausente)","type":"number","example":100},"valor_bruto":{"description":"Valor bruto (null quando ausente)","type":"number","example":100}}}},"components/schemas/ParcelaReferencia":{"id":"components/schemas/ParcelaReferencia","kind":"json-schema","title":"ParcelaReferencia","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência do evento"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da referência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"6f6029f4-19ed-4b97-bd5b-302d3b76d654"},"origem":{"description":"Origem (null quando ausente)","allOf":[{"$ref":"#/components/schemas/OrigemDoLancamento"}],"example":"VENDA"},"revisao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Revisão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"1"}}}},"components/schemas/ParcelaRenegociacao":{"id":"components/schemas/ParcelaRenegociacao","kind":"json-schema","title":"ParcelaRenegociacao","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Renegociação da parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da renegociação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"ef6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_evento":{"description":"ID do evento (null quando ausente)","type":"string","example":"ff6029f4-19ed-4b97-bd5b-302d3b76d654"},"valor":{"description":"Valor (null quando ausente)","type":"number","example":100}}}},"components/schemas/ParcelaSolicitacaoCobranca":{"id":"components/schemas/ParcelaSolicitacaoCobranca","kind":"json-schema","title":"ParcelaSolicitacaoCobranca","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Solicitação de cobrança associada à parcela"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"atributos_personalizados":{"description":"Atributos personalizados (null quando ausente)","type":"string","example":""},"combinado":{"description":"Indica se combinado","type":"boolean","example":false},"confirmado_em":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de confirmação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-31"},"conta_financeira":{"description":"Conta financeira (null quando ausente)","allOf":[{"$ref":"#/components/schemas/ContaFinanceira"}]},"data_quitacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de quitação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-31"},"data_vencimento":{"description":"Data de vencimento (null quando ausente)","type":"string","example":"2025-01-31"},"datalhe_erro":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Detalhe do erro (mantém o typo do contrato legado; null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":""},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Cobrança"},"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da solicitação de cobrança (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"9f6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_cliente":{"description":"ID do cliente (null quando ausente)","type":"string","example":"af6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_referencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID de referência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"notificao_cobranca":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Notificação (mantém o typo do contrato legado; null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ParcelaNotificacaoCobranca"}]},"recuperado":{"description":"Indica se recuperado","type":"boolean","example":false},"referencia_externa":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Referência externa (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"status_solicitacao_cobranca":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Status da solicitação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/StatusDaCobranca"}],"example":"REGISTRADO"},"tipo_solicitacao_cobranca":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Tipo da solicitação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TipoDeCobranca"}],"example":"BOLETO"},"url":{"description":"URL (null quando ausente)","type":"string","example":"https://example.com/charge"},"valor_composicao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/ComposicaoValorBaixa"}]},"versao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Versão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1}}}},"components/schemas/ParcelasDaVenda":{"id":"components/schemas/ParcelasDaVenda","kind":"json-schema","title":"ParcelasDaVenda","data":{"description":"Parcelas de uma venda, com as baixas de cada parcela","type":"object","properties":{"evento_financeiro":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Evento financeiro da venda (null quando a venda ainda não gerou financeiro)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/EventoFinanceiroDaVenda"}]},"itens":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Parcelas em ordem crescente de índice"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/ParcelaDaVenda"}},"itens_totais":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Total de parcelas da venda (mesmo quando não há itens retornados)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":2},"venda":{"description":"Venda consultada","allOf":[{"$ref":"#/components/schemas/VendaDasParcelas"}]}}}},"components/schemas/PeriodoConciliacoesPendentes":{"id":"components/schemas/PeriodoConciliacoesPendentes","kind":"json-schema","title":"PeriodoConciliacoesPendentes","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Período efetivamente coberto pela resposta"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data_fim":{"type":"string","example":"2026-08-31"},"data_inicio":{"type":"string","example":"2026-08-01"}}}},"components/schemas/PeriodoExtratoImportado":{"id":"components/schemas/PeriodoExtratoImportado","kind":"json-schema","title":"PeriodoExtratoImportado","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Período efetivamente coberto pela resposta"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data_fim":{"type":"string","example":"2026-08-31"},"data_inicio":{"type":"string","example":"2026-08-01"}}}},"components/schemas/Rateio":{"id":"components/schemas/Rateio","kind":"json-schema","title":"Rateio","data":{"description":"Rateio representa o rateio de uma categoria financeira","type":"object","required":["id_categoria","valor"],"properties":{"id_categoria":{"description":"ID da categoria financeira","type":"string","example":"937f6d29-3b2c-4eee-9778-29e54606f8b5"},"rateio_centro_custo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Rateio dos centros de custo associados à categoria"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"array","items":{"$ref":"#/components/schemas/RateioCentroCusto"}},"valor":{"description":"Valor da categoria no rateio","type":"number","minimum":0,"example":100}}}},"components/schemas/RateioCentroCusto":{"id":"components/schemas/RateioCentroCusto","kind":"json-schema","title":"RateioCentroCusto","data":{"description":"RateioCentroCusto representa o rateio de um centro de custo","type":"object","properties":{"id_centro_custo":{"description":"ID do centro de custo","type":"string","example":"bbe8049e-71df-4bf7-91f8-3b14ac5a6cdc"},"valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor do centro de custo no rateio (obrigatório e maior que zero)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","minimum":0,"example":100}}}},"components/schemas/RenegociacaoDaParcelaDaVenda":{"id":"components/schemas/RenegociacaoDaParcelaDaVenda","kind":"json-schema","title":"RenegociacaoDaParcelaDaVenda","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Renegociação da parcela da venda"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da renegociação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"ef6029f4-19ed-4b97-bd5b-302d3b76d654"},"id_evento":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID do evento que recebeu a renegociação (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"ff6029f4-19ed-4b97-bd5b-302d3b76d654"},"valor":{"description":"Valor renegociado (null quando ausente)","type":"number","example":100}}}},"components/schemas/SaldoContaFinanceira":{"id":"components/schemas/SaldoContaFinanceira","kind":"json-schema","title":"SaldoContaFinanceira","data":{"description":"Saldo atual de uma conta financeira","type":"object","properties":{"saldo_atual":{"description":"Saldo atual da conta financeira","type":"number","example":1234.56}}}},"components/schemas/SaldoInicial":{"id":"components/schemas/SaldoInicial","kind":"json-schema","title":"SaldoInicial","data":{"description":"Evento financeiro de saldo inicial","type":"object","properties":{"data_competencia":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de competência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-15"},"id_conta_financeira":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"saldo_inicial":{"description":"Saldo inicial","type":"number","example":100},"tipo":{"description":"Tipo do evento (RECEITA ou DESPESA)","allOf":[{"$ref":"#/components/schemas/TipoEventoFinanceiro"}],"example":"RECEITA"}}}},"components/schemas/SituacaoDaVenda":{"id":"components/schemas/SituacaoDaVenda","kind":"json-schema","title":"SituacaoDaVenda","data":{"type":"string","enum":["EM_ANDAMENTO","APROVADO","FATURADO","CANCELADO","ORCAMENTO","ORCAMENTO_ACEITO","ORCAMENTO_RECUSADO","CONTRATO","VENDA"],"x-enum-varnames":["SALE_SITUATION_IN_PROCESS","SALE_SITUATION_APPROVED","SALE_SITUATION_INVOICED","SALE_SITUATION_CANCELED","SALE_SITUATION_PROPOSAL","SALE_SITUATION_PROPOSAL_ACCEPTED","SALE_SITUATION_PROPOSAL_REFUSED","SALE_SITUATION_SCHEDULED","SALE_SITUATION_COMMITTED"]}},"components/schemas/SituacaoDiaImportacao":{"id":"components/schemas/SituacaoDiaImportacao","kind":"json-schema","title":"SituacaoDiaImportacao","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Situação do dia no histórico de importação, derivada pelo open-api-finance a partir do log de sincronização do bank-integration: IMPORTOU (enviou lançamentos), SEM_LANCAMENTOS (conectou e o banco não tinha movimento), FALHOU (tentou e não teve sucesso no dia), SEM_TENTATIVA (nenhum log de sincronização no dia)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["IMPORTOU","SEM_LANCAMENTOS","FALHOU","SEM_TENTATIVA"],"x-enum-varnames":["ImportDaySituationImported","ImportDaySituationNoStatements","ImportDaySituationFailed","ImportDaySituationNoAttempt"]}},"components/schemas/StatusDaCobranca":{"id":"components/schemas/StatusDaCobranca","kind":"json-schema","title":"StatusDaCobranca","data":{"type":"string","enum":["AGUARDANDO_CONFIRMACAO","EM_CANCELAMENTO","REGISTRADO","QUITADO","CANCELADO","INVALIDO","EXPIRADO","FALHA_EMISSAO","FALHA_CANCELAR","REMESSA_GERADO","REMESSA_PENDENTE","PAGO","EXTORNADO"],"x-enum-varnames":["AWAITING_CONFIRMATION","CANCELLATION_REQUESTED","CR_PENDING","CR_ACQUITTED","CR_CANCELED","INVALID","EXPIRED","CONFIRMATION_ERROR","CANCELLATION_ERROR","BILLET_DELIVERY_GENERATED","BILLET_DELIVERY_PENDING","CR_PAID","REFUNDED"]}},"components/schemas/StatusDaParcela":{"id":"components/schemas/StatusDaParcela","kind":"json-schema","title":"StatusDaParcela","data":{"type":"string","enum":["EM_ABERTO","RECEBIDO","RECEBIDO_PARCIAL","CANCELADO"],"x-enum-varnames":["PENDING","ACQUITTED","PARTIAL","CANCELED"]}},"components/schemas/StatusDeEntrega":{"id":"components/schemas/StatusDeEntrega","kind":"json-schema","title":"StatusDeEntrega","data":{"type":"string","enum":["ENVIADO","INVALIDO"],"x-enum-varnames":["DELIVERY_SENT","DELIVERY_INVALID"]}},"components/schemas/StatusDetalhadoDaParcela":{"id":"components/schemas/StatusDetalhadoDaParcela","kind":"json-schema","title":"StatusDetalhadoDaParcela","data":{"type":"string","enum":["PENDENTE","QUITADO","CANCELADO","RENEGOCIADO","RECEBIDO_PARCIAL","ATRASADO","PERDIDO"],"x-enum-varnames":["INSTALLMENT_PENDING","INSTALLMENT_ACQUITTED","INSTALLMENT_CANCELED","INSTALLMENT_RENEGOTIATED","INSTALLMENT_PARTIAL","INSTALLMENT_OVERDUE","INSTALLMENT_LOST"]}},"components/schemas/SugestaoPadraoCategoria":{"id":"components/schemas/SugestaoPadraoCategoria","kind":"json-schema","title":"SugestaoPadraoCategoria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Sugestão padrão da configuração de categoria"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da sugestão"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"nome":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Nome da sugestão (null quando o tipo de operação não é mapeado)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Fretes recebidos"}}}},"components/schemas/TipoDeAnexo":{"id":"components/schemas/TipoDeAnexo","kind":"json-schema","title":"TipoDeAnexo","data":{"type":"string","enum":["RECIBO","RECIBO_DIGITAL"],"x-enum-varnames":["RECEIPT","DIGITAL_RECEIPT"]}},"components/schemas/TipoDeAnexoDaParcela":{"id":"components/schemas/TipoDeAnexoDaParcela","kind":"json-schema","title":"TipoDeAnexoDaParcela","data":{"type":"string","enum":["BOLETO_BANCARIO_RFB","BOLETO_BANCARIO","RECIBO","FATURA","OUTROS","RECIBO_DIGITAL"],"x-enum-varnames":["INSTALLMENT_ATTACHMENT_RFB_BANKSLIP","INSTALLMENT_ATTACHMENT_BANKSLIP","INSTALLMENT_ATTACHMENT_RECEIPT","INSTALLMENT_ATTACHMENT_INVOICE","INSTALLMENT_ATTACHMENT_OTHERS","INSTALLMENT_ATTACHMENT_DIGITAL_RECEIPT"]}},"components/schemas/TipoDeCategoriaFinanceira":{"id":"components/schemas/TipoDeCategoriaFinanceira","kind":"json-schema","title":"TipoDeCategoriaFinanceira","data":{"description":"Enum de tipo de categoria financeira","type":"string","enum":["RECEITA","DESPESA"],"x-enum-varnames":["REVENUE","EXPENSE"]}},"components/schemas/TipoDeCobranca":{"id":"components/schemas/TipoDeCobranca","kind":"json-schema","title":"TipoDeCobranca","data":{"type":"string","enum":["BOLETO","LINK_PAGAMENTO","BOLETO_REGISTRADO","PIX_COBRANCA"],"x-enum-varnames":["CR_BANK_SLIP","CR_PAYMENT_LINK","CR_REGISTERED_BANK_SLIP","CR_PIX"]}},"components/schemas/TipoDeContaFinanceira":{"id":"components/schemas/TipoDeContaFinanceira","kind":"json-schema","title":"TipoDeContaFinanceira","data":{"type":"string","enum":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTROS","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"],"x-enum-varnames":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTRA_CONTA","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"]}},"components/schemas/TipoDeConteudoDoAnexo":{"id":"components/schemas/TipoDeConteudoDoAnexo","kind":"json-schema","title":"TipoDeConteudoDoAnexo","data":{"type":"string","enum":["FILE","URL"],"x-enum-varnames":["FILE","URL"]}},"components/schemas/TipoEventoFinanceiro":{"id":"components/schemas/TipoEventoFinanceiro","kind":"json-schema","title":"TipoEventoFinanceiro","data":{"description":"Enum de tipo de evento financeiro","type":"string","enum":["RECEITA","DESPESA"],"x-enum-varnames":["FINANCIAL_EVENT_REVENUE","FINANCIAL_EVENT_EXPENSE"]}},"components/schemas/TipoOperacao":{"id":"components/schemas/TipoOperacao","kind":"json-schema","title":"TipoOperacao","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Enum de tipo de operação da configuração padrão de categoria"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","enum":["FRETES_RECEBIDOS","FRETES_PAGOS","IMPOSTOS_RETIDOS_EM_VENDAS","DESCONTOS_INCONDICIONAIS_OBTIDOS","DESCONTOS_INCONDICIONAIS_CONCEDIDOS","DESCONTOS_FINANCEIROS_OBTIDOS","DESCONTOS_FINANCEIROS_CONCEDIDOS","MULTAS_RECEBIDAS","MULTAS_PAGAS","JUROS_RECEBIDOS","JUROS_PAGOS","TARIFAS","PERDAS"],"x-enum-varnames":["OPERATION_SHIPPING_RECEIVED","OPERATION_SHIPPING_PAID","OPERATION_SALE_TAX","OPERATION_UNCONDITIONAL_DISCOUNT_RECEIVED","OPERATION_UNCONDITIONAL_DISCOUNT_PAID","OPERATION_FINANCIAL_DISCOUNT_RECEIVED","OPERATION_FINANCIAL_DISCOUNT_PAID","OPERATION_FINE_RECEIVED","OPERATION_FINE_PAID","OPERATION_INTEREST_RECEIVED","OPERATION_INTEREST_PAID","OPERATION_FEE","OPERATION_LOSS"]}},"components/schemas/Transferencia":{"id":"components/schemas/Transferencia","kind":"json-schema","title":"Transferencia","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Transferência entre contas financeiras"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data da transferência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2025-01-15"},"descricao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Descrição da transferência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"Transferência entre contas"},"destino":{"description":"Baixa de destino (conta de entrada); null quando ausente","allOf":[{"$ref":"#/components/schemas/TransferenciaBaixa"}]},"id":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"ID da transferência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"0fc50efe-274b-4ba7-ac16-a9203f188149"},"origem":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Baixa de origem (conta de saída); null quando ausente"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TransferenciaBaixa"}]},"valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor da transferência (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100}}}},"components/schemas/TransferenciaBaixa":{"id":"components/schemas/TransferenciaBaixa","kind":"json-schema","title":"TransferenciaBaixa","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Baixa associada à transferência (origem ou destino)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"composicao_valor":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TransferenciaComposicaoValor"}]},"conta_financeira":{"description":"Conta financeira da baixa (null quando ausente)","allOf":[{"$ref":"#/components/schemas/TransferenciaContaFinanceira"}]},"data":{"description":"Data da baixa (null quando ausente)","type":"string","example":"2025-01-15"}}}},"components/schemas/TransferenciaComposicaoValor":{"id":"components/schemas/TransferenciaComposicaoValor","kind":"json-schema","title":"TransferenciaComposicaoValor","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Composição do valor da baixa da transferência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"desconto":{"description":"Desconto (null quando ausente)","type":"number","example":0},"juros":{"description":"Juros (null quando ausente)","type":"number","example":0},"multa":{"description":"Multa (null quando ausente)","type":"number","example":0},"taxa":{"description":"Taxa (null quando ausente)","type":"number","example":0},"valor_bruto":{"description":"Valor bruto (null quando ausente)","type":"number","example":100},"valor_liquido":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Valor líquido (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"number","example":100}}}},"components/schemas/TransferenciaContaFinanceira":{"id":"components/schemas/TransferenciaContaFinanceira","kind":"json-schema","title":"TransferenciaContaFinanceira","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Conta financeira da baixa da transferência"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"id":{"description":"ID da conta financeira","type":"string","example":"8a3e0f8b-1bb0-48e7-98d8-db0203ae598a"},"instituicao_bancaria":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instituição bancária (null quando a conta não possui banco)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/TransferenciaInstituicaoBancaria"}]},"nome":{"description":"Nome da conta financeira (null quando ausente)","type":"string","example":"Conta Corrente"}}}},"components/schemas/TransferenciaInstituicaoBancaria":{"id":"components/schemas/TransferenciaInstituicaoBancaria","kind":"json-schema","title":"TransferenciaInstituicaoBancaria","data":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Instituição bancária da conta financeira"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"object","properties":{"codigo":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Código do banco (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1},"nome":{"description":"Nome do banco (null quando ausente)","type":"string","example":"Banco do Brasil"}}}},"components/schemas/VendaDasParcelas":{"id":"components/schemas/VendaDasParcelas","kind":"json-schema","title":"VendaDasParcelas","data":{"description":"Venda que originou as parcelas","type":"object","properties":{"data_emissao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Data de emissão (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"string","example":"2026-08-03"},"id":{"description":"ID interno da venda","type":"string","example":"aff32f2a-2904-4918-a18b-96fa39ac435c"},"numero":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Número da venda que a PME vê no ERP"},"children":[],"type":"text"}],"type":"paragraph"}],"type":"integer","example":1042},"situacao":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Situação da venda (null quando ausente)"},"children":[],"type":"text"}],"type":"paragraph"}],"allOf":[{"$ref":"#/components/schemas/SituacaoDaVenda"}],"example":"APROVADO"},"total":{"description":"Valor total da venda (null quando ausente)","type":"number","example":1500}}}},"schema_0":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":1},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":1000,"default":10},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","enum":["ID","CODIGO","NOME","ATIVO"]},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","enum":["ATIVO","INATIVO","TODOS"],"default":"TODOS"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string","enum":["NOME","TIPO"]},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","enum":["RECEITA","DESPESA"]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguracaoPadraoCategoria"}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","enum":["NOME"]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"array","items":{"enum":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTROS","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"],"type":"string"}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"integer","minimum":1,"default":10},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"array","items":{"enum":["PERDIDO","RECEBIDO","EM_ABERTO","RENEGOCIADO","RECEBIDO_PARCIAL","ATRASADO"],"type":"string"}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"array","items":{"enum":["BOLETO_BANCARIO","CARTAO_CREDITO","CARTAO_DEBITO","DINHEIRO","CHEQUE","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO","CARTAO_CREDITO_VIA_LINK","NENHUMA"],"type":"string"}},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Parcela"}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Baixa"}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"attachment; filename=\"<descrição da cobrança>.pdf\\"},"children":[],"type":"text"}],"type":"paragraph"}]}}},"id":"schema_21"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"apiKey","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Digite "},"children":[],"type":"text"},{"$$mdtype":"Node","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[],"type":"text"}],"type":"strong"},{"$$mdtype":"Node","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[],"type":"text"}],"type":"paragraph"}],"in":"header","paramName":"Authorization"}},"specVersion":"3.2.0","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/open-api-docs/open-api-finance","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/open-api-docs/open-api-finance","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/open-api-docs/open-api-finance.json?download"},{"url":"/_bundle/open-api-docs/open-api-finance.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Financeiro","description":"A API de Financeiro tem como objetivo oferecer um conjunto de recursos para gerenciar de forma programática os principais aspectos financeiros de uma empresa, desde a criação de eventos de contas a receber ou pagar, passando pela gestão de contas financeiras, centros de custo, categorias, até a consulta de saldos. Com esta API, sistemas podem integrar de forma fluida com o módulo financeiro da Conta Azul, garantindo que lançamentos, saldos, classificações e relatórios estejam sempre sincronizados.\n\nSe desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, consulte nossa Central de Ajuda:\n\n- [Contas a pagar e receber](https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar)\n- [Cadastro e gestão de contas financeiras](https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras)\n- [Categorias financeiras e centro de custos](https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo)\n"}},"baseSlug":"/open-api-docs/open-api-finance","routesMapping":{}}