{"items":[{"type":"link","label":"Financeiro","link":"/docs/financial-apis-openapi","routeSlug":"/docs/financial-apis-openapi","content":{"contentType":"overview","meta":{"name":"Financeiro"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"financial-apis-openapi.json","url":"/_bundle/docs/financial-apis-openapi.json?download"},{"kind":"download","label":"financial-apis-openapi.yaml","url":"/_bundle/docs/financial-apis-openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","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","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","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":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Se desejar aprofundar o entendimento das regras de negócio aplicadas pelo ERP, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contas a pagar e receber:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cadastro e gestão de contas financeiras:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categorias financeiras e centro de custos:"},"children":[]}]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo"},"children":[]}]}]}]}]}],"sectionId":"/docs/financial-apis-openapi"}],"sectionId":"/docs/financial-apis-openapi"}]}]}},{"type":"group","label":"v1","link":"/docs/financial-apis-openapi/v1","routeSlug":"/docs/financial-apis-openapi/v1","items":[{"label":"Retornar os centros de custo por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchcostcenters","routeSlug":"/docs/financial-apis-openapi/v1/searchcostcenters","metadata":{"seo":{"title":"Retornar os centros de custo por filtro","description":"Permite consultar os centros de custo cadastrados. Suporta filtros como página, tamanho de página, busca por texto, status (ativo/inativo/todos) e ordenação. Utilizado para consultar lançamentos financeiros e facilitar análise orçamentária."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCostCenters","name":"Retornar os centros de custo por filtro","isWebhook":false,"pointer":"/paths/~1v1~1centro-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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os centros de custo cadastrados. Suporta filtros como página, tamanho de página, busca por texto, status (ativo/inativo/todos) e ordenação. Utilizado para consultar lançamentos financeiros e facilitar análise orçamentária."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_149","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"required":true,"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"required":true,"example":10},{"name":"busca","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Busca textual por nome ou código"},"children":[]}]}]}],"example":"010"},{"name":"filtro_rapido","in":"query","schemaId":"schema_152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtro rápido para itens ativos, inativos ou todos"},"children":[]}]}]}],"example":"ATIVO"},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por nome ou por código"},"children":[]}]}]}],"example":"nome"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente  não deverá ser informado. É possível ordenar por nome ou por código"},"children":[]}]}]}],"example":"nome"}],"pointer":"/paths/~1v1~1centro-de-custo/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/centro-de-custo","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":true,"example":1,"schemaId":"schema_149"},{"name":"tamanho_pagina","in":"query","required":true,"example":10,"schemaId":"schema_150"},{"name":"busca","in":"query","required":false,"example":"010","schemaId":"schema_151"},{"name":"filtro_rapido","in":"query","required":false,"example":"ATIVO","schemaId":"schema_152"},{"name":"campo_ordenado_ascendente","in":"query","required":false,"example":"nome","schemaId":"schema_151"},{"name":"campo_ordenado_descendente","in":"query","required":false,"example":"nome","schemaId":"schema_151"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/centro-de-custo","href":"v1/searchcostcenters","openApiOperationId":"searchCostCenters","summary":"Retornar os centros de custo por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CentroDeCustoResponse"}},"schemaId":"components/schemas/CentroDeCustoResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1centro-de-custo/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CentroDeCustoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CentroDeCustoResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchcostcenters"}],"panels":[]}]},"httpPath":"/v1/centro-de-custo"},{"label":"Criar um novo centro de custo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/createcostcenter","routeSlug":"/docs/financial-apis-openapi/v1/createcostcenter","metadata":{"seo":{"title":"Criar um novo centro de custo","description":"Permite criar um novo centro de custo, definindo campos como código, nome, parâmetros que ajudam a organizar os custos da empresa de forma estruturada."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCostCenter","name":"Criar um novo centro de custo","isWebhook":false,"pointer":"/paths/~1v1~1centro-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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite criar um novo centro de custo, definindo campos como código, nome, parâmetros que ajudam a organizar os custos da empresa de forma estruturada."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoCentroDeCustoRequest"}},"schemaId":"components/schemas/CriacaoCentroDeCustoRequest","pointer":"/paths/~1v1~1centro-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/centro-de-custo","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriacaoCentroDeCustoRequest"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/centro-de-custo","href":"v1/createcostcenter","openApiOperationId":"createCostCenter","summary":"Criar um novo centro de custo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoCentroDeCustoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoCentroDeCustoRequest"}},"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/CentroDeCusto"}},"schemaId":"components/schemas/CentroDeCusto"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1centro-de-custo/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CentroDeCusto","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CentroDeCusto"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/createcostcenter"}],"panels":[]}]},"httpPath":"/v1/centro-de-custo"},{"label":"Retornar as parcelas pelo id do evento financeiro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getinstallmentsbyeventid","routeSlug":"/docs/financial-apis-openapi/v1/getinstallmentsbyeventid","metadata":{"seo":{"title":"Retornar as parcelas pelo id do evento financeiro","description":"Permite listar as parcelas vinculadas a um evento financeiro específico (id_evento). Útil para acompanhar cada parcela de um lançamento de contas a pagar ou receber, com seus valores, vencimentos e status e outras informações pertinentes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstallmentsByEventId","name":"Retornar as parcelas pelo id do evento financeiro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1{id_evento}~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite listar as parcelas vinculadas a um evento financeiro específico (id_evento). Útil para acompanhar cada parcela de um lançamento de contas a pagar ou receber, com seus valores, vencimentos e status e outras informações pertinentes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id_evento","in":"path","schemaId":"schema_151","description":"uuid ou id legado do evento","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1{id_evento}~1parcelas/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/{id_evento}/parcelas","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id_evento","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_151"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/{id_evento}/parcelas","href":"v1/getinstallmentsbyeventid","openApiOperationId":"getInstallmentsByEventId","summary":"Retornar as parcelas pelo id do evento financeiro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}},"schemaId":"schema_153"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1{id_evento}~1parcelas/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_153","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_153"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getinstallmentsbyeventid"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/{id_evento}/parcelas"},{"label":"Retornar as categorias por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchcategories","routeSlug":"/docs/financial-apis-openapi/v1/searchcategories","metadata":{"seo":{"title":"Retornar as categorias por filtro","description":"Permite listar as categorias utilizadas para classificação de receitas ou despesas. Auxilia no controle, agrupamento e geração de relatórios financeiros baseados em categorias."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchCategories","name":"Retornar as categorias por filtro","isWebhook":false,"pointer":"/paths/~1v1~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite listar as categorias utilizadas para classificação de receitas ou despesas. Auxilia no controle, agrupamento e geração de relatórios financeiros baseados em categorias."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_149","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"required":true,"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"required":true,"example":10},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_154","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação ascendente. Se informado ele desconsidera o valor do  campo_ordenado_descendente. É possível ordenar por 'NOME' ou 'TIPO'"},"children":[]}]}]}],"example":"NOME"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_154","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não  deverá ser informado. É possível ordenar por 'NOME' ou 'TIPO'"},"children":[]}]}]}],"example":"TIPO"},{"name":"busca","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Busca textual por nome ou código"},"children":[]}]}]}],"example":"010"},{"name":"tipo","in":"query","schemaId":"schema_155","description":"Tipo da categoria","example":"RECEITA"},{"name":"apenas_filhos","in":"query","schemaId":"schema_156","description":"Filtrar apenas categorias filhas","example":true},{"name":"nome","in":"query","schemaId":"schema_151","description":"Nome da categoria","example":"Eletrônicos"},{"name":"permite_apenas_filhos","in":"query","schemaId":"schema_156","description":"Permite apenas categorias filhas","required":true,"example":true}],"pointer":"/paths/~1v1~1categorias/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/categorias","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":true,"example":1,"schemaId":"schema_149"},{"name":"tamanho_pagina","in":"query","required":true,"example":10,"schemaId":"schema_150"},{"name":"campo_ordenado_ascendente","in":"query","required":false,"example":"NOME","schemaId":"schema_154"},{"name":"campo_ordenado_descendente","in":"query","required":false,"example":"TIPO","schemaId":"schema_154"},{"name":"busca","in":"query","required":false,"example":"010","schemaId":"schema_151"},{"name":"tipo","in":"query","required":false,"example":"RECEITA","schemaId":"schema_155"},{"name":"apenas_filhos","in":"query","required":false,"example":true,"schemaId":"schema_156"},{"name":"nome","in":"query","required":false,"example":"Eletrônicos","schemaId":"schema_151"},{"name":"permite_apenas_filhos","in":"query","required":true,"example":true,"schemaId":"schema_156"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/categorias","href":"v1/searchcategories","openApiOperationId":"searchCategories","summary":"Retornar as categorias por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}},"schemaId":"schema_157"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1categorias/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_157","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_157"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchcategories"}],"panels":[]}]},"httpPath":"/v1/categorias"},{"label":"Retornar a configuração de de-para de categorias","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getdefaultcategoryconfig","routeSlug":"/docs/financial-apis-openapi/v1/getdefaultcategoryconfig","metadata":{"seo":{"title":"Retornar a configuração de de-para de categorias","description":"Retorna o de-para entre as operações financeiras e as categorias configuradas para o tenant, incluindo opcionalmente a sugestão padrão de categoria para cada operação."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultCategoryConfig","name":"Retornar a configuração de de-para de categorias","isWebhook":false,"pointer":"/paths/~1v1~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna o de-para entre as operações financeiras e as categorias configuradas para o tenant, incluindo opcionalmente a sugestão padrão de categoria para cada operação."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sugestao_padrao","in":"query","schemaId":"schema_158","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quando verdadeiro (padrão), inclui o objeto "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sugestao_padrao"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" em cada item. Quando falso, o campo "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sugestao_padrao"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" é retornado como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}],"pointer":"/paths/~1v1~1categorias~1configuracao-padrao/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/categorias/configuracao-padrao","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"sugestao_padrao","in":"query","required":false,"example":true,"schemaId":"schema_158"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/categorias/configuracao-padrao","href":"v1/getdefaultcategoryconfig","openApiOperationId":"getDefaultCategoryConfig","summary":"Retornar a configuração de de-para de categorias"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}},"schemaId":"schema_159"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1categorias~1configuracao-padrao/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_159","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getdefaultcategoryconfig"}],"panels":[]}]},"httpPath":"/v1/categorias/configuracao-padrao"},{"label":"Retornar as categorias DRE","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchdrecategories","routeSlug":"/docs/financial-apis-openapi/v1/searchdrecategories","metadata":{"seo":{"title":"Retornar as categorias DRE","description":"Permite listar as categorias de DRE (Demonstração do Resultado do Exercício) usadas para a estrutura contábil-financeira da empresa, facilitando o fechamento financeiro e contábil."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchDreCategories","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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite listar as categorias de DRE (Demonstração do Resultado do Exercício) usadas para a estrutura contábil-financeira da empresa, facilitando o fechamento financeiro e contábil."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]}],"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/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","401","429","500"],"pointer":"/v1/financeiro/categorias-dre","href":"v1/searchdrecategories","openApiOperationId":"searchDreCategories","summary":"Retornar as categorias DRE"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EstruturaDRE"}},"schemaId":"components/schemas/EstruturaDRE"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1categorias-dre/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EstruturaDRE","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EstruturaDRE"}}},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchdrecategories"}],"panels":[]}]},"httpPath":"/v1/financeiro/categorias-dre"},{"label":"Retornar as contas financeiras por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchfinancialaccounts","routeSlug":"/docs/financial-apis-openapi/v1/searchfinancialaccounts","metadata":{"seo":{"title":"Retornar as contas financeiras por filtro","description":"Permite consultar as contas financeiras existentes no sistema (contas bancárias, cartões, poupança, etc.). Suporta filtros como tipo de conta, nome, se estão ativas, entre outros."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchFinancialAccounts","name":"Retornar as contas financeiras por filtro","isWebhook":false,"pointer":"/paths/~1v1~1conta-financeira/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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar as contas financeiras existentes no sistema (contas bancárias, cartões, poupança, etc.). Suporta filtros como tipo de conta, nome, se estão ativas, entre outros."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_161","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"example":10},{"name":"tipos","in":"query","schemaId":"schema_162","description":"Lista de tipos de conta","example":"APLICACAO"},{"name":"nome","in":"query","schemaId":"schema_151","description":"Nome da conta","example":"Conta corrente"},{"name":"apenas_ativo","in":"query","schemaId":"schema_156","description":"Filtrar apenas contas ativas","example":true},{"name":"esconde_conta_digital","in":"query","schemaId":"schema_156","description":"Esconder contas digitais","example":true},{"name":"mostrar_caixinha","in":"query","schemaId":"schema_156","description":"Mostrar contas de caixinha","example":true}],"pointer":"/paths/~1v1~1conta-financeira/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/conta-financeira","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":false,"example":1,"schemaId":"schema_160"},{"name":"tamanho_pagina","in":"query","required":false,"example":10,"schemaId":"schema_161"},{"name":"tipos","in":"query","required":false,"example":"APLICACAO","schemaId":"schema_162"},{"name":"nome","in":"query","required":false,"example":"Conta corrente","schemaId":"schema_151"},{"name":"apenas_ativo","in":"query","required":false,"example":true,"schemaId":"schema_156"},{"name":"esconde_conta_digital","in":"query","required":false,"example":true,"schemaId":"schema_156"},{"name":"mostrar_caixinha","in":"query","required":false,"example":true,"schemaId":"schema_156"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/conta-financeira","href":"v1/searchfinancialaccounts","openApiOperationId":"searchFinancialAccounts","summary":"Retornar as contas financeiras por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}},"schemaId":"schema_163"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1conta-financeira/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_163","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchfinancialaccounts"}],"panels":[]}]},"httpPath":"/v1/conta-financeira"},{"label":"Retornar o saldo atual pelo id da conta financeira","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchbalancebyfinancialaccountid","routeSlug":"/docs/financial-apis-openapi/v1/searchbalancebyfinancialaccountid","metadata":{"seo":{"title":"Retornar o saldo atual pelo id da conta financeira","description":"Permite obter o saldo atual de uma conta financeira específica identificada por id_conta_financeira. Útil para monitoramento em tempo real de saldos das contas da empresa."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchBalanceByFinancialAccountId","name":"Retornar o saldo atual pelo id da conta financeira","isWebhook":false,"pointer":"/paths/~1v1~1conta-financeira~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite obter o saldo atual de uma conta financeira específica identificada por id_conta_financeira. Útil para monitoramento em tempo real de saldos das contas da empresa."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id_conta_financeira","in":"path","schemaId":"schema_151","description":"uuid da conta financeira","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/conta-financeira/{id_conta_financeira}/saldo-atual","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id_conta_financeira","in":"path","required":true,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_151"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/conta-financeira/{id_conta_financeira}/saldo-atual","href":"v1/searchbalancebyfinancialaccountid","openApiOperationId":"searchBalanceByFinancialAccountId","summary":"Retornar o saldo atual pelo id da conta financeira"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SaldoAtualResponse"}},"schemaId":"components/schemas/SaldoAtualResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/400/content/application~1json/example"]}},"schemaId":"schema_164","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_165","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/401/content/application~1json/example"]},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_166","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SaldoAtualResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SaldoAtualResponse"}}},{"code":"400","schemaId":"schema_164","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_165","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/401/content/application~1json/example"]}}},{"code":"429"},{"code":"500","schemaId":"schema_166","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchbalancebyfinancialaccountid"}],"panels":[]}]},"httpPath":"/v1/conta-financeira/{id_conta_financeira}/saldo-atual"},{"label":"Retornar as transferências entre contas financeiras por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchaccountingexporttransfers","routeSlug":"/docs/financial-apis-openapi/v1/searchaccountingexporttransfers","metadata":{"seo":{"title":"Retornar as transferências entre contas financeiras por filtro","description":"Permite consultar as transferências realizadas entre contas financeiras mediante filtros como período de datas e contas financeiras específicas. Para viabilizar a conciliação financeira automática e sincronizar corretamente as movimentações no meu sistema."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchAccountingExportTransfers","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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar as transferências realizadas entre contas financeiras mediante filtros como período de datas e contas financeiras específicas. Para viabilizar a conciliação financeira automática e sincronizar corretamente as movimentações no meu sistema."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_167","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da página para paginação dos resultados"},"children":[]}]}]}],"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_168","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade de itens por página"},"children":[]}]}]}],"example":10},{"name":"ids_conta_financeira","in":"query","schemaId":"schema_169","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de identificadores (UUIDs) das contas financeiras para filtrar as transferências. Retorna transferências onde as contas especificadas sejam origem ou destino."},"children":[]}]}]}],"example":["35473eec-4e74-11ee-b500-9f61de8a8b8b","8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f"]},{"name":"data_inicio","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data inicial do período para filtrar as transferências (formato ISO date)"},"children":[]}]}]}],"example":"2026-01-01"},{"name":"data_fim","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data final do período para filtrar as transferências (formato ISO date)"},"children":[]}]}]}],"example":"2026-12-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/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":false,"example":1,"schemaId":"schema_167"},{"name":"tamanho_pagina","in":"query","required":false,"example":10,"schemaId":"schema_168"},{"name":"ids_conta_financeira","in":"query","required":false,"example":["35473eec-4e74-11ee-b500-9f61de8a8b8b","8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f"],"schemaId":"schema_169"},{"name":"data_inicio","in":"query","required":false,"example":"2026-01-01","schemaId":"schema_170"},{"name":"data_fim","in":"query","required":false,"example":"2026-12-31","schemaId":"schema_170"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/transferencias","href":"v1/searchaccountingexporttransfers","openApiOperationId":"searchAccountingExportTransfers","summary":"Retornar as transferências entre contas financeiras por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK - Retorna a lista paginada de transferências entre contas financeiras"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferenciaContaFinanceiraResponse","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_sucesso","paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_vazio"]}},"schemaId":"components/schemas/TransferenciaContaFinanceiraResponse","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_sucesso","paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_vazio"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request - Parâmetros inválidos na requisição"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/data_invalida","paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/uuid_invalido"]}},"schemaId":"schema_171","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/data_invalida","paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/uuid_invalido"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized - Token de autenticação inválido ou expirado"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_165","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/401/content/application~1json/example"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too Many Requests - Limite de requisições excedido"},"children":[]}]}]}]},{"code":"500","description":"Internal Server Error - Erro interno no servidor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/500/content/application~1json/example"]}},"schemaId":"schema_166","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1v1~1financeiro~1transferencias/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferenciaContaFinanceiraResponse","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_sucesso","paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_vazio"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferenciaContaFinanceiraResponse","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_sucesso","paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_vazio"]}}},{"code":"400","schemaId":"schema_171","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/data_invalida","paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/uuid_invalido"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/data_invalida","paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/uuid_invalido"]}}},{"code":"401","schemaId":"schema_165","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/401/content/application~1json/example"]}}},{"code":"429"},{"code":"500","schemaId":"schema_166","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1v1~1financeiro~1transferencias/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchaccountingexporttransfers"}],"panels":[]}]},"httpPath":"/v1/financeiro/transferencias"},{"label":"Criar um novo evento financeiro de contas a receber","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/createreceivablefinancialevent","routeSlug":"/docs/financial-apis-openapi/v1/createreceivablefinancialevent","metadata":{"seo":{"title":"Criar um novo evento financeiro de contas a receber","description":"Permite criar um novo evento financeiro de contas a receber, passando dados como data de competência, valor, descrição, conta financeira, condições de pagamento, entre outros. Facilita o registro de receitas previstas ou realizadas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReceivableFinancialEvent","name":"Criar um novo evento financeiro de contas a receber","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite criar um novo evento financeiro de contas a receber, passando dados como data de competência, valor, descrição, conta financeira, condições de pagamento, entre outros. Facilita o registro de receitas previstas ou realizadas."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroRequest"}},"schemaId":"components/schemas/EventoFinanceiroRequest","pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber/post/requestBody","description":"Dados do evento financeiro de contas a receber"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/eventos-financeiros/contas-a-receber","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroRequest"}},"responseCodes":["202","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-receber","href":"v1/createreceivablefinancialevent","openApiOperationId":"createReceivableFinancialEvent","summary":"Criar um novo evento financeiro de contas a receber"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EventoFinanceiroRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Evento financeiro de contas a receber criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProtocolResponseDTO"}},"schemaId":"components/schemas/ProtocolResponseDTO"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/ProtocolResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProtocolResponseDTO"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/createreceivablefinancialevent"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber"},{"label":"Retornar as receitas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchinstallmentstoreceivebyfilter","routeSlug":"/docs/financial-apis-openapi/v1/searchinstallmentstoreceivebyfilter","metadata":{"seo":{"title":"Retornar as receitas por filtro","description":"Permite consultar as parcelas de receitas (contas a receber) mediante filtros como data de vencimento, data de competência, data de pagamento, data de alteração, valor, status, dentre outros. Essa funcionalidade ajuda no controle e análise de entradas financeiras com base nas condições definidas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchInstallmentsToReceiveByFilter","name":"Retornar as receitas por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1buscar/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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar as parcelas de receitas (contas a receber) mediante filtros como data de vencimento, data de competência, data de pagamento, data de alteração, valor, status, dentre outros. Essa funcionalidade ajuda no controle e análise de entradas financeiras com base nas condições definidas."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_167","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"required":true,"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_172","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"required":true,"example":10},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por nome"},"children":[]}]}]}],"example":"nome"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por nome"},"children":[]}]}]}],"example":"nome"},{"name":"descricao","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da conta"},"children":[]}]}]}],"example":"Conta Corrente"},{"name":"data_vencimento_de","in":"query","schemaId":"schema_170","description":"Data de vencimento de (ISO date format)","required":true,"example":"2027-08-15"},{"name":"data_vencimento_ate","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de vencimento até (ISO date format)"},"children":[]}]}]}],"required":true,"example":"2027-08-20"},{"name":"data_competencia_de","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência de (ISO date format)"},"children":[]}]}]}],"example":"2025-08-15"},{"name":"data_competencia_ate","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência até (ISO date format)"},"children":[]}]}]}],"example":"2025-08-20"},{"name":"data_pagamento_de","in":"query","schemaId":"schema_170","description":"Data de pagamento de (ISO date format)","example":"2025-08-15"},{"name":"data_pagamento_ate","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de pagamento até (ISO date format)"},"children":[]}]}]}],"example":"2025-08-20"},{"name":"data_alteracao_de","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração de (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-20T07:00:00"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração até (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-20T07:59:59"},{"name":"valor_de","in":"query","schemaId":"schema_174","description":"Valor de","example":"100"},{"name":"valor_ate","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor até"},"children":[]}]}]}],"example":"500"},{"name":"status","in":"query","schemaId":"schema_175","description":"Status da conta","example":"ATRASADO"},{"name":"ids_contas_financeiras","in":"query","schemaId":"schema_176","description":"Lista de IDs de contas financeiras"},{"name":"ids_categorias","in":"query","schemaId":"schema_176","description":"Lista de IDs de categorias"},{"name":"ids_centros_de_custo","in":"query","schemaId":"schema_176","description":"Lista de IDs de centros de custo"},{"name":"ids_clientes","in":"query","schemaId":"schema_176","description":"Lista de IDs de clientes"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1buscar/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/contas-a-receber/buscar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":true,"example":1,"schemaId":"schema_167"},{"name":"tamanho_pagina","in":"query","required":true,"example":10,"schemaId":"schema_172"},{"name":"campo_ordenado_ascendente","in":"query","required":false,"example":"nome","schemaId":"schema_151"},{"name":"campo_ordenado_descendente","in":"query","required":false,"example":"nome","schemaId":"schema_151"},{"name":"descricao","in":"query","required":false,"example":"Conta Corrente","schemaId":"schema_151"},{"name":"data_vencimento_de","in":"query","required":true,"example":"2027-08-15","schemaId":"schema_170"},{"name":"data_vencimento_ate","in":"query","required":true,"example":"2027-08-20","schemaId":"schema_170"},{"name":"data_competencia_de","in":"query","required":false,"example":"2025-08-15","schemaId":"schema_170"},{"name":"data_competencia_ate","in":"query","required":false,"example":"2025-08-20","schemaId":"schema_170"},{"name":"data_pagamento_de","in":"query","required":false,"example":"2025-08-15","schemaId":"schema_170"},{"name":"data_pagamento_ate","in":"query","required":false,"example":"2025-08-20","schemaId":"schema_170"},{"name":"data_alteracao_de","in":"query","required":false,"example":"2025-10-20T07:00:00","schemaId":"schema_173"},{"name":"data_alteracao_ate","in":"query","required":false,"example":"2025-10-20T07:59:59","schemaId":"schema_173"},{"name":"valor_de","in":"query","required":false,"example":"100","schemaId":"schema_174"},{"name":"valor_ate","in":"query","required":false,"example":"500","schemaId":"schema_174"},{"name":"status","in":"query","required":false,"example":"ATRASADO","schemaId":"schema_175"},{"name":"ids_contas_financeiras","in":"query","required":false,"schemaId":"schema_176"},{"name":"ids_categorias","in":"query","required":false,"schemaId":"schema_176"},{"name":"ids_centros_de_custo","in":"query","required":false,"schemaId":"schema_176"},{"name":"ids_clientes","in":"query","required":false,"schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-receber/buscar","href":"v1/searchinstallmentstoreceivebyfilter","openApiOperationId":"searchInstallmentsToReceiveByFilter","summary":"Retornar as receitas por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContasAReceberResponse"}},"schemaId":"components/schemas/ContasAReceberResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-receber~1buscar/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContasAReceberResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContasAReceberResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchinstallmentstoreceivebyfilter"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-receber/buscar"},{"label":"Criar um novo evento financeiro de contas a pagar","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/createpayablefinancialevent","routeSlug":"/docs/financial-apis-openapi/v1/createpayablefinancialevent","metadata":{"seo":{"title":"Criar um novo evento financeiro de contas a pagar","description":"Permite criar um novo evento financeiro de contas a pagar, informando dados como valor, condições de pagamento, descrição, conta financeira, entre outros. Esse endpoint facilita o registro das obrigações financeiras da empresa."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPayableFinancialEvent","name":"Criar um novo evento financeiro de contas a pagar","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite criar um novo evento financeiro de contas a pagar, informando dados como valor, condições de pagamento, descrição, conta financeira, entre outros. Esse endpoint facilita o registro das obrigações financeiras da empresa."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroRequest"}},"schemaId":"components/schemas/EventoFinanceiroRequest","pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-pagar/post/requestBody","description":"Dados do evento financeiro de contas a pagar"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/financeiro/eventos-financeiros/contas-a-pagar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroRequest"}},"responseCodes":["202","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-pagar","href":"v1/createpayablefinancialevent","openApiOperationId":"createPayableFinancialEvent","summary":"Criar um novo evento financeiro de contas a pagar"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/EventoFinanceiroRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EventoFinanceiroRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Evento financeiro de conta a pagar criado com sucesso","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProtocolResponseDTO"}},"schemaId":"components/schemas/ProtocolResponseDTO"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-pagar/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/ProtocolResponseDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProtocolResponseDTO"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/createpayablefinancialevent"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-pagar"},{"label":"Retornar as despesas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/searchinstallmentstopaybyfilter","routeSlug":"/docs/financial-apis-openapi/v1/searchinstallmentstopaybyfilter","metadata":{"seo":{"title":"Retornar as despesas por filtro","description":"Permite consultar as parcelas de despesas (contas a pagar) conforme filtros como data de vencimento, data competência, data de alteração, valor, status, conta financeira, etc. Essa consulta possibilita monitorar as obrigações financeiras pendentes ou pagas, favorecendo a gestão e o planejamento."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchInstallmentsToPayByFilter","name":"Retornar as despesas por filtro","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-pagar~1buscar/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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar as parcelas de despesas (contas a pagar) conforme filtros como data de vencimento, data competência, data de alteração, valor, status, conta financeira, etc. Essa consulta possibilita monitorar as obrigações financeiras pendentes ou pagas, favorecendo a gestão e o planejamento."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_167","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"required":true,"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_172","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"required":true,"example":10},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_177","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por id do centro de custo (id),  pelo código (CODIGO), pelo nome (NOME) e por ativo (ATIVO)"},"children":[]}]}]}],"example":"nome"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_177","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não  deverá ser informado. É possível ordenar por id do centro de custo (id), pelo código (CODIGO), pelo  nome (NOME) ou por ativo (ATIVO)"},"children":[]}]}]}],"example":"nome"},{"name":"descricao","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da conta"},"children":[]}]}]}],"example":"Pagamento do salário"},{"name":"data_vencimento_de","in":"query","schemaId":"schema_170","description":"Date de vencimento de (ISO date format)","required":true,"example":"2027-08-15"},{"name":"data_vencimento_ate","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de vencimento até (ISO date format)"},"children":[]}]}]}],"required":true,"example":"2027-08-20"},{"name":"data_competencia_de","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência de (ISO date format)"},"children":[]}]}]}],"example":"2025-08-15"},{"name":"data_competencia_ate","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência até (ISO date format)"},"children":[]}]}]}],"example":"2025-08-20"},{"name":"data_pagamento_de","in":"query","schemaId":"schema_170","description":"Data de pagamento de (ISO date format)","example":"2025-08-15"},{"name":"data_pagamento_ate","in":"query","schemaId":"schema_170","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de pagamento até (ISO date format)"},"children":[]}]}]}],"example":"2025-08-20"},{"name":"data_alteracao_de","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração de (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-20T07:00:00"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração até (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-20T07:59:59"},{"name":"valor_de","in":"query","schemaId":"schema_178","description":"Valor de","example":"100"},{"name":"valor_ate","in":"query","schemaId":"schema_178","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor até"},"children":[]}]}]}],"example":"500"},{"name":"status","in":"query","schemaId":"schema_175","description":"Lista de status da conta","example":"ATRASADO"},{"name":"ids_contas_financeiras","in":"query","schemaId":"schema_176","description":"Lista de IDs de contas financeiras","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},{"name":"ids_categorias","in":"query","schemaId":"schema_176","description":"Lista de IDs de categorias","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},{"name":"ids_centros_de_custo","in":"query","schemaId":"schema_176","description":"Lista de IDs de centros de custo","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-pagar~1buscar/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":true,"example":1,"schemaId":"schema_167"},{"name":"tamanho_pagina","in":"query","required":true,"example":10,"schemaId":"schema_172"},{"name":"campo_ordenado_ascendente","in":"query","required":false,"example":"nome","schemaId":"schema_177"},{"name":"campo_ordenado_descendente","in":"query","required":false,"example":"nome","schemaId":"schema_177"},{"name":"descricao","in":"query","required":false,"example":"Pagamento do salário","schemaId":"schema_151"},{"name":"data_vencimento_de","in":"query","required":true,"example":"2027-08-15","schemaId":"schema_170"},{"name":"data_vencimento_ate","in":"query","required":true,"example":"2027-08-20","schemaId":"schema_170"},{"name":"data_competencia_de","in":"query","required":false,"example":"2025-08-15","schemaId":"schema_170"},{"name":"data_competencia_ate","in":"query","required":false,"example":"2025-08-20","schemaId":"schema_170"},{"name":"data_pagamento_de","in":"query","required":false,"example":"2025-08-15","schemaId":"schema_170"},{"name":"data_pagamento_ate","in":"query","required":false,"example":"2025-08-20","schemaId":"schema_170"},{"name":"data_alteracao_de","in":"query","required":false,"example":"2025-10-20T07:00:00","schemaId":"schema_173"},{"name":"data_alteracao_ate","in":"query","required":false,"example":"2025-10-20T07:59:59","schemaId":"schema_173"},{"name":"valor_de","in":"query","required":false,"example":"100","schemaId":"schema_178"},{"name":"valor_ate","in":"query","required":false,"example":"500","schemaId":"schema_178"},{"name":"status","in":"query","required":false,"example":"ATRASADO","schemaId":"schema_175"},{"name":"ids_contas_financeiras","in":"query","required":false,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_176"},{"name":"ids_categorias","in":"query","required":false,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_176"},{"name":"ids_centros_de_custo","in":"query","required":false,"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar","href":"v1/searchinstallmentstopaybyfilter","openApiOperationId":"searchInstallmentsToPayByFilter","summary":"Retornar as despesas por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179"}},"schemaId":"schema_179"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1contas-a-pagar~1buscar/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_179","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_179"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchinstallmentstopaybyfilter"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar"},{"label":"Retornar a parcela por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getinstallmentbyid","routeSlug":"/docs/financial-apis-openapi/v1/getinstallmentbyid","metadata":{"seo":{"title":"Retornar a parcela por id","description":"Permite consultar os detalhes de uma parcela específica (de conta a receber ou a pagar) identificada pelo seu id. A resposta traz campos como data de vencimento, valor, status, conta financeira, entre outros."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstallmentById","name":"Retornar a parcela por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os detalhes de uma parcela específica (de conta a receber ou a pagar) identificada pelo seu id. A resposta traz campos como data de vencimento, valor, status, conta financeira, entre outros."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_180","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da parcela"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/parcelas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9986f173-f531-4660-96ae-04b71c879264","schemaId":"schema_180"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/parcelas/{id}","href":"v1/getinstallmentbyid","openApiOperationId":"getInstallmentById","summary":"Retornar a parcela por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações da parcela retornadas com sucesso"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Parcela"}},"schemaId":"components/schemas/Parcela"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Parcela","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Parcela"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getinstallmentbyid"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{id}"},{"label":"Atualizar parcialmente uma parcela por id","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/updateinstallment","routeSlug":"/docs/financial-apis-openapi/v1/updateinstallment","metadata":{"seo":{"title":"Atualizar parcialmente uma parcela por id","description":"Permite atualizar parcialmente uma parcela existente identificada pelo id, alterando campos como data de vencimento, valor, observações, conta financeira e outros campos permitidos. Essa operação ajuda a ajustar lançamentos financeiros sem a necessidade de recriá-los."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInstallment","name":"Atualizar parcialmente uma parcela por id","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite atualizar parcialmente uma parcela existente identificada pelo id, alterando campos como data de vencimento, valor, observações, conta financeira e outros campos permitidos. Essa operação ajuda a ajustar lançamentos financeiros sem a necessidade de recriá-los."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_180","required":true}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~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/ParcelaAtualizacaoRequest"}},"schemaId":"components/schemas/ParcelaAtualizacaoRequest","pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{id}/patch/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campos aceitos para atualização da parcela"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/financeiro/eventos-financeiros/parcelas/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"9986f173-f531-4660-96ae-04b71c879264","schemaId":"schema_180"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ParcelaAtualizacaoRequest"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/parcelas/{id}","href":"v1/updateinstallment","openApiOperationId":"updateInstallment","summary":"Atualizar parcialmente uma parcela por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ParcelaAtualizacaoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ParcelaAtualizacaoRequest"}},"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/ParcelaAtualizacaoResponse"}},"schemaId":"components/schemas/ParcelaAtualizacaoResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1parcelas~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ParcelaAtualizacaoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ParcelaAtualizacaoResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/updateinstallment"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/parcelas/{id}"},{"label":"Retornar os IDs dos eventos financeiros alterados em um período","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getalteredfinancialevents","routeSlug":"/docs/financial-apis-openapi/v1/getalteredfinancialevents","metadata":{"seo":{"title":"Retornar os IDs dos eventos financeiros alterados em um período","description":"Permite consultar os IDs dos eventos financeiros (contas a pagar e a receber) que foram alterados em um período  definido por data de ínico e fim. Essa funcionalidade é útil para identificar quais eventos sofreram modificações  recentes, facilitando a sincronização e o monitoramento de mudanças nos dados financeiros. Importante: As informações disponíveis indicam a data e hora em que o evento foi salvo, sem detalhar quais campos  foram modificados em cada operação. Salvar um recurso sem alterações reais pode gerar uma entrada no histórico e  atualizar a data do último registro."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlteredFinancialEvents","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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os IDs dos eventos financeiros (contas a pagar e a receber) que foram alterados em um período  definido por data de ínico e fim. Essa funcionalidade é útil para identificar quais eventos sofreram modificações  recentes, facilitando a sincronização e o monitoramento de mudanças nos dados financeiros. Importante: As informações disponíveis indicam a data e hora em que o evento foi salvo, sem detalhar quais campos  foram modificados em cada operação. Salvar um recurso sem alterações reais pode gerar uma entrada no histórico e  atualizar a data do último registro."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_181","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"example":10},{"name":"data_inicio","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data inicial do período para filtrar os eventos financeiros alterados (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"required":true,"example":"2026-01-01T23:59:59"},{"name":"data_fim","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data final do período para filtrar os eventos financeiros alterados (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"required":true,"example":"2026-03-12T23: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/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":false,"example":1,"schemaId":"schema_160"},{"name":"tamanho_pagina","in":"query","required":false,"example":10,"schemaId":"schema_181"},{"name":"data_inicio","in":"query","required":true,"example":"2026-01-01T23:59:59","schemaId":"schema_173"},{"name":"data_fim","in":"query","required":true,"example":"2026-03-12T23:59:59","schemaId":"schema_173"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/alteracoes","href":"v1/getalteredfinancialevents","openApiOperationId":"getAlteredFinancialEvents","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/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182"}},"schemaId":"schema_182"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1alteracoes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_182","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_182"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getalteredfinancialevents"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/alteracoes"},{"label":"Retornar os saldos iniciais das contas financeiras","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/financial-apis-openapi/v1/getinitialbalancesoffinancialaccounts","routeSlug":"/docs/financial-apis-openapi/v1/getinitialbalancesoffinancialaccounts","metadata":{"seo":{"title":"Retornar os saldos iniciais das contas financeiras","description":"Permite consultar os saldos iniciais das contas financeiras em um período definido por data de início e fim."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInitialBalancesOfFinancialAccounts","name":"Retornar os saldos iniciais das contas financeiras","isWebhook":false,"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~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":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite consultar os saldos iniciais das contas financeiras em um período definido por data de início e fim."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Página"},"children":[]}]}]}],"example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_181","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"example":10},{"name":"data_inicio","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data inicial do período para filtrar os saldos iniciais (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"required":true,"example":"2026-01-01T23:59:59"},{"name":"data_fim","in":"query","schemaId":"schema_173","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data final do período para filtrar os saldos iniciais (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"required":true,"example":"2026-03-12T23:59:59"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1saldo-inicial/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/financeiro/eventos-financeiros/saldo-inicial","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":false,"example":1,"schemaId":"schema_160"},{"name":"tamanho_pagina","in":"query","required":false,"example":10,"schemaId":"schema_181"},{"name":"data_inicio","in":"query","required":true,"example":"2026-01-01T23:59:59","schemaId":"schema_173"},{"name":"data_fim","in":"query","required":true,"example":"2026-03-12T23:59:59","schemaId":"schema_173"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/financeiro/eventos-financeiros/saldo-inicial","href":"v1/getinitialbalancesoffinancialaccounts","openApiOperationId":"getInitialBalancesOfFinancialAccounts","summary":"Retornar os saldos iniciais das contas financeiras"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","description":"Mock server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}},"schemaId":"schema_183"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1financeiro~1eventos-financeiros~1saldo-inicial/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_183","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_183"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getinitialbalancesoffinancialaccounts"}],"panels":[]}]},"httpPath":"/v1/financeiro/eventos-financeiros/saldo-inicial"}],"content":{"contentType":"group","meta":{"name":"v1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"v1","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conjunto de recursos para acompanhar e administrar as finanças da empresa -  esses recursos incluem centros de custo, parcelas, categorias, categorias dre,  contas financeiras e movimentações (contas a pagar e a receber)"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/centro-de-custo","summary":"Retornar os centros de custo por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchcostcenters","deprecated":false},{"title":"/v1/centro-de-custo","summary":"Criar um novo centro de custo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/createcostcenter","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/{id_evento}/parcelas","summary":"Retornar as parcelas pelo id do evento financeiro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getinstallmentsbyeventid","deprecated":false},{"title":"/v1/categorias","summary":"Retornar as categorias por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchcategories","deprecated":false},{"title":"/v1/categorias/configuracao-padrao","summary":"Retornar a configuração de de-para de categorias","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getdefaultcategoryconfig","deprecated":false},{"title":"/v1/financeiro/categorias-dre","summary":"Retornar as categorias DRE","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchdrecategories","deprecated":false},{"title":"/v1/conta-financeira","summary":"Retornar as contas financeiras por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchfinancialaccounts","deprecated":false},{"title":"/v1/conta-financeira/{id_conta_financeira}/saldo-atual","summary":"Retornar o saldo atual pelo id da conta financeira","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchbalancebyfinancialaccountid","deprecated":false},{"title":"/v1/financeiro/transferencias","summary":"Retornar as transferências entre contas financeiras por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchaccountingexporttransfers","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/contas-a-receber","summary":"Criar um novo evento financeiro de contas a receber","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/createreceivablefinancialevent","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/contas-a-receber/buscar","summary":"Retornar as receitas por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchinstallmentstoreceivebyfilter","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/contas-a-pagar","summary":"Criar um novo evento financeiro de contas a pagar","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/createpayablefinancialevent","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar","summary":"Retornar as despesas por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchinstallmentstopaybyfilter","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/parcelas/{id}","summary":"Retornar a parcela por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getinstallmentbyid","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/parcelas/{id}","summary":"Atualizar parcialmente uma parcela por id","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/v1/updateinstallment","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":"/v1/getalteredfinancialevents","deprecated":false},{"title":"/v1/financeiro/eventos-financeiros/saldo-inicial","summary":"Retornar os saldos iniciais das contas financeiras","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getinitialbalancesoffinancialaccounts","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CentroDeCusto":{"id":"components/schemas/CentroDeCusto","kind":"json-schema","title":"CentroDeCusto","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do centro de custo"},"children":[]}]}]}],"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"codigo":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código do centro de custo"},"children":[]}]}]}],"example":"1040"},"nome":{"type":"string","description":"Nome do centro de custo","example":"Contabilidade"},"ativo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o centro de custo está ativo"},"children":[]}]}]}],"example":true}}}},"components/schemas/CriacaoCentroDeCustoRequest":{"id":"components/schemas/CriacaoCentroDeCustoRequest","kind":"json-schema","title":"CriacaoCentroDeCustoRequest","data":{"type":"object","required":["nome"],"properties":{"codigo":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código do centro de custo"},"children":[]}]}]}],"example":"1040"},"nome":{"type":"string","description":"Nome do centro de custo","example":"Contabilidade"}}}},"components/schemas/Totais":{"id":"components/schemas/Totais","kind":"json-schema","title":"Totais","data":{"type":"object","properties":{"ativo":{"type":"integer","description":"Total de centros de custo ativos","example":6},"inativo":{"type":"integer","description":"Total de centros de custo inativos","example":0},"todos":{"type":"integer","description":"Total de centros de custo","example":6}}}},"components/schemas/CentroDeCustoResponse":{"id":"components/schemas/CentroDeCustoResponse","kind":"json-schema","title":"CentroDeCustoResponse","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":6},"items":{"type":"array","items":{"$ref":"#/components/schemas/CentroDeCusto"}},"totais":{"$ref":"#/components/schemas/Totais"}}}},"components/schemas/ContasAReceberResponse":{"id":"components/schemas/ContasAReceberResponse","kind":"json-schema","title":"ContasAReceberResponse","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":6},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ContaAReceber"}},"totais":{"$ref":"#/components/schemas/Totais"}}}},"components/schemas/NegociadorContaAPagarOuReceber":{"id":"components/schemas/NegociadorContaAPagarOuReceber","kind":"json-schema","title":"NegociadorContaAPagarOuReceber","data":{"type":"object","properties":{"id":{"type":"string","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"nome":{"type":"string","example":"Maria da Silva"}}}},"components/schemas/CategoriaParcela":{"id":"components/schemas/CategoriaParcela","kind":"json-schema","title":"CategoriaParcela","data":{"type":"object","description":"Estrutura resumida de categoria enviada em itens de parcela","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da categoria"},"children":[]}]}]}],"example":"b134ec6b-30f8-4edc-9a8f-4787fd3381ac"},"nome":{"description":"Nome da categoria","type":"string","example":"Adiantamento Salarial"}}}},"components/schemas/CentroCustoParcela":{"id":"components/schemas/CentroCustoParcela","kind":"json-schema","title":"CentroCustoParcela","data":{"type":"object","description":"Estrutura resumida de centro de custo enviada em itens de parcela","properties":{"id":{"type":"string","format":"uuid","example":"428389c6-4e74-11ee-a3eb-9b5f0f22a7c1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do centro de custo"},"children":[]}]}]}]},"nome":{"type":"string","example":"Centro de custo de Teste","description":"Nome do centro de custo"}}}},"components/schemas/ContaAReceber":{"id":"components/schemas/ContaAReceber","kind":"json-schema","title":"ContaAReceber","data":{"type":"object","properties":{"id":{"type":"string","example":"c6a28b6e-efe4-11ee-8ef8-8b86c5251537"},"descricao":{"type":"string","example":"Venda de Produtos"},"data_vencimento":{"type":"string","example":"2027-08-15"},"status":{"type":"string","example":"OVERDUE"},"status_traduzido":{"example":"ATRASADO","type":"string","enum":["PERDIDO","RECEBIDO","EM_ABERTO","RENEGOCIADO","RECEBIDO_PARCIAL","ATRASADO"]},"total":{"type":"number","example":781201.79},"nao_pago":{"type":"number","example":213023.79},"pago":{"type":"number","example":0},"data_criacao":{"type":"string","format":"date-time","example":"2027-08-15T14:30:00Z"},"data_alteracao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração da conta a receber (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"format":"date-time","example":"2027-08-15T14:30:00Z"},"data_competencia":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência da parcela (campo data_competencia)"},"children":[]}]}]}],"example":"2018-03-16"},"categorias":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de categorias associadas à parcela (id e nome)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CategoriaParcela"}},"centros_custo":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de centros de custo associados à parcela (id e nome)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CentroCustoParcela"}},"cliente":{"$ref":"#/components/schemas/NegociadorContaAPagarOuReceber"},"renegociacao":{"$ref":"#/components/schemas/RenegociacaoContaAReceber"}}}},"components/schemas/ContaAPagar":{"id":"components/schemas/ContaAPagar","kind":"json-schema","title":"ContaAPagar","data":{"type":"object","properties":{"id":{"type":"string","example":"c6a28b6e-efe4-11ee-8ef8-8b86c5251537"},"descricao":{"type":"string","example":"Aluguel do escritório"},"data_vencimento":{"type":"string","example":"2027-08-15"},"status":{"type":"string","example":"OVERDUE"},"status_traduzido":{"example":"ATRASADO","type":"string","enum":["PERDIDO","RECEBIDO","EM_ABERTO","RENEGOCIADO","RECEBIDO_PARCIAL","ATRASADO"]},"total":{"type":"number","example":781201.79},"nao_pago":{"type":"number","example":213023.79},"pago":{"type":"number","example":0},"data_criacao":{"type":"string","format":"date-time","example":"2027-08-15T14:30:00Z"},"data_alteracao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração da conta a pagar (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"format":"date-time","example":"2027-08-15T14:30:00Z"},"data_competencia":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência da parcela (campo data_competencia)"},"children":[]}]}]}],"example":"2018-03-16"},"categorias":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de categorias associadas à parcela (id e nome)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CategoriaParcela"}},"centros_custo":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de centros de custo associados à parcela (id e nome)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/CentroCustoParcela"}},"fornecedor":{"$ref":"#/components/schemas/NegociadorContaAPagarOuReceber"}}}},"components/schemas/Categoria":{"id":"components/schemas/Categoria","kind":"json-schema","title":"Categoria","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"versao":{"type":"integer","example":0},"nome":{"type":"string","example":"Eletrônicos"},"categoria_pai":{"type":"string","nullable":true,"example":"3d39b8d2-8b16-42d6-abd8-6cfd9d2e06c4"},"tipo":{"type":"string","example":"RECEITA"},"entrada_dre":{"type":"string","example":"DESPESAS_ADMINISTRATIVAS"},"considera_custo_dre":{"type":"boolean","example":true}}}},"components/schemas/ConfiguracaoPadraoCategoria":{"id":"components/schemas/ConfiguracaoPadraoCategoria","kind":"json-schema","title":"ConfiguracaoPadraoCategoria","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Item do de-para entre uma operação financeira e a categoria configurada para o tenant"},"children":[]}]}]}],"properties":{"tipo_operacao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo da operação financeira. Valores possíveis:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRETES_RECEBIDOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para valor de frete inserido na venda."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRETES_PAGOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para valor de frete inserido na compra."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPOSTOS_RETIDOS_EM_VENDAS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para valor dos impostos retidos na venda."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESCONTOS_INCONDICIONAIS_OBTIDOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para descontos obtidos na compra."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESCONTOS_INCONDICIONAIS_CONCEDIDOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para descontos concedidos na venda."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESCONTOS_FINANCEIROS_OBTIDOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para descontos obtidos, no caso de baixas em despesas com desconto."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESCONTOS_FINANCEIROS_CONCEDIDOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para descontos concedidos, no caso de baixas em receitas com desconto."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MULTAS_RECEBIDAS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para multas recebidas, em baixas no Contas a receber."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MULTAS_PAGAS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para multas pagas, em baixas no Contas a pagar."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JUROS_RECEBIDOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para juros recebidos em baixas no Contas a receber."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JUROS_PAGOS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para juros pagos, em baixas no Contas a pagar."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TARIFAS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categorias para tarifas pagas, em baixas no contas a receber."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PERDAS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Categoria para perdas, quando a parcela é dada como perda no Contas a receber."},"children":[]}]}]}]}],"example":"FRETES_RECEBIDOS","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"]},"id_categoria":{"type":"string","format":"uuid","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador da categoria configurada para a operação"},"children":[]}]}]}],"example":"e82ba6fd-a291-422f-8ef7-eb383205d743"},"nome_categoria":{"type":"string","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da categoria configurada para a operação"},"children":[]}]}]}],"example":"0.5 categoria dre"},"sugestao_padrao":{"$ref":"#/components/schemas/SugestaoPadrao"}}}},"components/schemas/SugestaoPadrao":{"id":"components/schemas/SugestaoPadrao","kind":"json-schema","title":"SugestaoPadrao","data":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sugestão padrão de categoria para a operação. Quando "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sugestao_padrao=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", este campo é retornado como "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","format":"uuid","nullable":true,"description":"Identificador da categoria sugerida","example":"1bb1b4fa-0fba-49e6-9fb6-a0342b7575eb"},"nome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da operação financeira correspondente à sugestão"},"children":[]}]}]}],"example":"Fretes recebidos"}}}},"components/schemas/ContaFinanceira":{"id":"components/schemas/ContaFinanceira","kind":"json-schema","title":"ContaFinanceira","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da conta financeira"},"children":[]}]}]}]},"banco":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Instituição bancária"},"children":[]}]}]}],"example":"BANCO_BRASIL","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","OUTROS","NAO_BANCO"]},"codigo_banco":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código da instituição bancária"},"children":[]}]}]}]},"nome":{"type":"string","example":"Conta Corrente","description":"Nome da conta financeira"},"ativo":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se a conta está ativa"},"children":[]}]}]}]},"tipo":{"type":"string","description":"Tipo da conta","example":"APLICACAO","enum":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTROS","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"]},"conta_padrao":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se é a conta padrão"},"children":[]}]}]}]},"possui_config_boleto_bancario":{"type":"boolean","example":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se a conta possui configuração de boleto bancário"},"children":[]}]}]}]},"agencia":{"type":"string","example":"001","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agência da conta"},"children":[]}]}]}]},"numero":{"type":"string","example":"31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da conta"},"children":[]}]}]}]}}}},"components/schemas/SaldoAtualResponse":{"id":"components/schemas/SaldoAtualResponse","kind":"json-schema","title":"SaldoAtualResponse","data":{"type":"object","description":"Saldo atual da conta financeira","properties":{"saldo_atual":{"type":"number","format":"double","example":1000.36}}}},"components/schemas/EstruturaDRE":{"id":"components/schemas/EstruturaDRE","kind":"json-schema","title":"EstruturaDRE","data":{"type":"object","properties":{"itens":{"type":"array","description":"Lista principal de itens da DRE","items":{"$ref":"#/components/schemas/CategoriaDRE"}}}}},"components/schemas/CategoriaDRE":{"id":"components/schemas/CategoriaDRE","kind":"json-schema","title":"CategoriaDRE","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"id do item da categoria DRE","example":"a1b2c3d4-e5f6-7890-1234-567890abcdef"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição do item"},"children":[]}]}]}],"example":"Receita Operacional Bruta"},"codigo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de identificação do item"},"children":[]}]}]}],"example":"01"},"posicao":{"type":"integer","format":"int64","description":"Ordem de posicionamento do item na estrutura","example":1},"indica_totalizador":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o item é um totalizador de subitens"},"children":[]}]}]}],"example":true},"representa_soma_custo_medio":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se o item representa a soma do custo médio do produto"},"children":[]}]}]}],"example":false},"subitens":{"type":"array","description":"Lista de subitens aninhados","items":{"$ref":"#/components/schemas/CategoriaDRE"}},"categorias_financeiras":{"type":"array","description":"Categorias financeiras associadas a este item da DRE","items":{"$ref":"#/components/schemas/CategoriaFinanceira"}}}}},"components/schemas/CategoriaFinanceira":{"id":"components/schemas/CategoriaFinanceira","kind":"json-schema","title":"CategoriaFinanceira","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"id da categoria financeira","example":"f0e9d8c7-b6a5-4321-fedc-ba9876543210"},"codigo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código da categoria financeira"},"children":[]}]}]}],"example":"1"},"nome":{"type":"string","description":"Nome da categoria financeira","example":"Venda de Produtos"},"ativo":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se a categoria financeira está ativa"},"children":[]}]}]}],"example":true}}}},"components/schemas/ParcelaAtualizacaoRequest":{"id":"components/schemas/ParcelaAtualizacaoRequest","kind":"json-schema","title":"ParcelaAtualizacaoRequest","data":{"type":"object","required":["versao"],"properties":{"nota":{"type":"string","description":"Nota da parcela","example":"Pgto 3/5"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[]}]}]}],"example":"Valor líquido referente ao serviço prestado"},"vencimento":{"type":"string","format":"date","example":"2024-07-15"},"composicao_valor":{"$ref":"#/components/schemas/ComposicaoValor"},"versao":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sempre enviar o valor atual da versão"},"children":[]}]}]}]},"data_pagamento_esperado":{"type":"string","format":"date","example":"2024-07-15"},"metodo_pagamento":{"type":"string","example":"CARTAO_CREDITO","enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO"]},"perda":{"$ref":"#/components/schemas/PerdaFinanceira"},"nsu":{"type":"string","example":"1029384756"},"pagamento_agendado":{"type":"boolean","example":false},"id_conta_financeira":{"type":"string","format":"uuid","example":"e12a84ed-fb5c-4b8c-af56-4448b947337c"}}}},"components/schemas/ParcelaAtualizacaoResponse":{"id":"components/schemas/ParcelaAtualizacaoResponse","kind":"json-schema","title":"ParcelaAtualizacaoResponse","data":{"type":"object","properties":{"nota":{"type":"string","description":"Nota da parcela","example":"Pgto 3/5"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[]}]}]}],"example":"Valor líquido referente ao serviço prestado"},"vencimento":{"type":"string","format":"date","example":"2024-07-15"},"composicao_valor":{"$ref":"#/components/schemas/ComposicaoValor"},"versao":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nova versão da parcela após salvar as alterações"},"children":[]}]}]}]},"data_pagamento_esperado":{"type":"string","format":"date","example":"2024-07-15"},"metodo_pagamento":{"type":"string","example":"CARTAO_CREDITO","enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO"]},"perda":{"$ref":"#/components/schemas/PerdaFinanceira"},"nsu":{"type":"string","example":"1029384756"},"pagamento_agendado":{"type":"boolean","example":false},"conta_financeira":{"$ref":"#/components/schemas/ParcelaContaFinanceira"}}}},"components/schemas/ParcelaContaFinanceira":{"id":"components/schemas/ParcelaContaFinanceira","kind":"json-schema","title":"ParcelaContaFinanceira","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9"},"versao":{"type":"integer","example":1},"nome":{"type":"string","description":"Nome do banco","example":"Conta Corrente"},"agencia":{"type":"string","example":"001"},"numero":{"type":"string","example":"123"},"tipo":{"type":"string","example":"OUTROS","enum":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTROS","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"]},"banco":{"type":"string","example":"OUTROS","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","OUTROS","NAO_BANCO"]}}}},"components/schemas/PerdaFinanceira":{"id":"components/schemas/PerdaFinanceira","kind":"json-schema","title":"PerdaFinanceira","data":{"type":"object","properties":{"data":{"type":"string","format":"date","example":"2024-07-15"},"valor":{"type":"number","example":1.99}}}},"components/schemas/ComposicaoValor":{"id":"components/schemas/ComposicaoValor","kind":"json-schema","title":"ComposicaoValor","data":{"type":"object","required":["valor_bruto"],"properties":{"multa":{"type":"number","example":100.25,"description":"Valor da multa"},"juros":{"type":"number","example":1.5,"description":"Valor dos juros"},"valor_bruto":{"type":"number","example":275.99,"description":"Valor bruto da parcela"},"valor_liquido":{"type":"number","example":250.33,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor líquido da parcela"},"children":[]}]}]}]},"desconto":{"type":"number","example":2.1,"description":"Valor do desconto"},"taxa":{"type":"number","example":4.4,"description":"Valor da taxa"}}}},"components/schemas/EventoFinanceiroRequest":{"id":"components/schemas/EventoFinanceiroRequest","kind":"json-schema","title":"EventoFinanceiroRequest","data":{"type":"object","required":["data_competencia","valor","observacao","descricao","contato","conta_financeira","condicao_pagamento"],"properties":{"data_competencia":{"type":"string","format":"date","example":"2024-07-15","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data da competência do evento financeiro"},"children":[]}]}]}]},"valor":{"type":"number","format":"decimal","example":100,"description":"Valor do evento financeiro"},"observacao":{"type":"string","example":"Evento financeiro no valor de R$100,00","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observação do evento financeiro"},"children":[]}]}]}]},"descricao":{"type":"string","example":"Prestação de serviço","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição do evento financeiro"},"children":[]}]}]}]},"contato":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":"Identificador do negociador"},"conta_financeira":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":"Identificador da Conta Financeira"},"rateio":{"type":"array","items":{"$ref":"#/components/schemas/CategoriaRateio"}},"condicao_pagamento":{"$ref":"#/components/schemas/ListaCondicaoPagamento"}}}},"components/schemas/ProtocolResponseDTO":{"id":"components/schemas/ProtocolResponseDTO","kind":"json-schema","title":"ProtocolResponseDTO","data":{"type":"object","properties":{"protocolo":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":"Identificador do protocolo"},"status":{"type":"string","description":"Status do protocolo","example":"SUCCESS","enum":["PENDING","SUCCESS","ERROR"]},"data_criacao":{"type":"string","format":"date-time","example":"2024-10-22T14:30:00Z","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação do protocolo"},"children":[]}]}]}]}}}},"components/schemas/CategoriaRateio":{"id":"components/schemas/CategoriaRateio","kind":"json-schema","title":"CategoriaRateio","data":{"type":"object","required":["id_categoria","valor"],"properties":{"id_categoria":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da categoria"},"children":[]}]}]}]},"valor":{"type":"number","format":"decimal","example":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor atribuído à categoria no rateio"},"children":[]}]}]}]},"rateio_centro_custo":{"type":"array","items":{"$ref":"#/components/schemas/CentroCustoRateio"},"description":"Lista de rateios por centro de custo"}}}},"components/schemas/CentroCustoRateio":{"id":"components/schemas/CentroCustoRateio","kind":"json-schema","title":"CentroCustoRateio","data":{"type":"object","properties":{"id_centro_custo":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do centro de custo"},"children":[]}]}]}]},"valor":{"type":"number","format":"decimal","example":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor atribuído ao centro de custo no rateio"},"children":[]}]}]}]}}}},"components/schemas/ListaCondicaoPagamento":{"id":"components/schemas/ListaCondicaoPagamento","kind":"json-schema","title":"ListaCondicaoPagamento","data":{"type":"object","required":["parcelas"],"properties":{"parcelas":{"type":"array","items":{"$ref":"#/components/schemas/ParcelaCondicaoPagamento"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de parcelas da condição de pagamento"},"children":[]}]}]}]}}}},"components/schemas/ParcelaCondicaoPagamento":{"id":"components/schemas/ParcelaCondicaoPagamento","kind":"json-schema","title":"ParcelaCondicaoPagamento","data":{"type":"object","required":["descricao","data_vencimento","nota","conta_financeira","detalhe_valor"],"properties":{"descricao":{"type":"string","example":"Mensalidade (2/6)","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[]}]}]}]},"data_vencimento":{"type":"string","format":"date","example":"2024-07-15","description":"Data de vencimento da parcela"},"nota":{"type":"string","example":"Pagamento realizado via PIX","description":"Nota adicional sobre a parcela"},"conta_financeira":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador da conta financeira associada à parcela"},"children":[]}]}]}]},"detalhe_valor":{"$ref":"#/components/schemas/ComposicaoValor"},"metodo_pagamento":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Método de pagamento da parcela"},"children":[]}]}]}],"example":"PIX_PAGAMENTO_INSTANTANEO","enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO"]}}}},"components/schemas/Parcela":{"id":"components/schemas/Parcela","kind":"json-schema","title":"Parcela","data":{"type":"object","properties":{"evento":{"$ref":"#/components/schemas/Evento"},"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"versao":{"type":"integer","format":"int64","example":1},"referencia":{"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"indice":{"type":"integer","format":"int32","example":1},"conciliado":{"type":"boolean","example":true},"status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PENDENTE é o mesmo que EM_ABERTO. QUITADO é mesmo que RECEBIDO"},"children":[]}]}]}],"type":"string","example":"PENDENTE","enum":["PENDENTE","QUITADO","CANCELADO","RENEGOCIADO","RECEBIDO_PARCIAL","ATRASADO","PERDIDO"]},"valor_pago":{"type":"number","format":"double","example":10},"perda":{"$ref":"#/components/schemas/PerdaFinanceira"},"nao_pago":{"type":"number","format":"double","example":5},"data_vencimento":{"type":"string","format":"date","example":"2025-09-05"},"data_pagamento_previsto":{"type":"string","format":"date","example":"2025-09-05"},"descricao":{"type":"string","example":"Parcela do evento financeiro de contas a pagar"},"nota":{"type":"string","example":"A data de pagamento prevista é para 01/01/2030"},"conta_financeira":{"$ref":"#/components/schemas/ContaFinanceira"},"id_conta_financeira":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"valor_composicao":{"$ref":"#/components/schemas/ValorComposicao"},"metodo_pagamento":{"type":"string","example":"DEPOSITO_BANCARIO","enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO"]},"nsu":{"type":"string","example":"000215783210"},"baixa_agendada":{"type":"boolean","example":false},"baixas":{"type":"array","items":{"$ref":"#/components/schemas/Baixa"}},"anexos":{"type":"array","items":{"$ref":"#/components/schemas/AnexoParcela"}},"solicitacoes_cobrancas":{"type":"array","items":{"$ref":"#/components/schemas/SolicitacaoCobranca"}},"id_ultima_solicitacao_pagamento":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"id_boleto_bancario_autorizado":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"fatura":{"$ref":"#/components/schemas/Fatura"},"data_alteracao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração da parcela (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"format":"date-time","example":"2025-10-22T08:37:05"},"valor_total_liquido":{"type":"number","format":"double","example":10},"id_ultimo_solicitacao_cobranca":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"renegociacao":{"$ref":"#/components/schemas/Renegociacao"}}}},"components/schemas/Evento":{"id":"components/schemas/Evento","kind":"json-schema","title":"Evento","data":{"type":"object","properties":{"data_competencia":{"type":"string","format":"date","example":"2025-06-11"},"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamento"},"referencia":{"$ref":"#/components/schemas/Referencia"},"agendado":{"type":"boolean","example":true},"tipo":{"type":"string","example":"RECEITA","enum":["RECEITA","DESPESA"]},"codigo_referencia":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código de referência do evento financeiro"},"children":[]}]}]}],"example":"123456"},"rateio":{"type":"array","items":{"$ref":"#/components/schemas/Rateio"}}}}},"components/schemas/Rateio":{"id":"components/schemas/Rateio","kind":"json-schema","title":"Rateio","data":{"type":"object","properties":{"id_categoria":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"nome_categoria":{"type":"string","example":"Eletrônicos"},"valor":{"type":"number","format":"double","example":20.5},"valor_bruto":{"type":"number","format":"double","example":20.5},"rateio_centro_custo":{"type":"array","items":{"$ref":"#/components/schemas/RateioCentroCusto"}}}}},"components/schemas/RateioCentroCusto":{"id":"components/schemas/RateioCentroCusto","kind":"json-schema","title":"RateioCentroCusto","data":{"type":"object","properties":{"id_centro_custo":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"nome_centro_custo":{"type":"string","example":"Contabilidade"},"valor":{"type":"number","format":"double","example":30.5},"valor_bruto":{"type":"number","format":"double","nullable":true,"example":30.5}}}},"components/schemas/CondicaoPagamento":{"id":"components/schemas/CondicaoPagamento","kind":"json-schema","title":"CondicaoPagamento","data":{"type":"object","properties":{"quantidade_parcelas":{"type":"integer","example":10},"montante_fixo":{"type":"boolean","example":false}}}},"components/schemas/Referencia":{"id":"components/schemas/Referencia","kind":"json-schema","title":"Referencia","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"revisao":{"type":"string","example":"1"},"origem":{"type":"string","example":"LANCAMENTO_FINANCEIRO","enum":["LANCAMENTO_FINANCEIRO","DAS","FOLHA","TRANSFERENCIA","SALDO_CONTA_BANCARIA","VENDA","COMPRA","VENDA_AGENDADA","COMPRA_AGENDADA","IMPORTACAO_DOCUMENTO","IMPOSTO_RETIDO","SIC","NOTA_COMPRA","ANTECIPACAO","RENEGOCIACAO","HONORARIOS_CONTABEIS"]}}}},"components/schemas/ValorComposicao":{"id":"components/schemas/ValorComposicao","kind":"json-schema","title":"ValorComposicao","data":{"type":"object","properties":{"multa":{"type":"number","format":"double","example":10},"juros":{"type":"number","format":"double","example":1},"valor_bruto":{"type":"number","format":"double","example":20},"desconto":{"type":"number","format":"double","example":0.1},"taxa":{"type":"number","format":"double","example":0.03},"valor_liquido":{"type":"number","format":"double","example":9}}}},"components/schemas/Baixa":{"id":"components/schemas/Baixa","kind":"json-schema","title":"Baixa","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"versao":{"type":"integer","example":1},"data_pagamento":{"type":"string","format":"date","example":"2025-05-20"},"valor_composicao":{"$ref":"#/components/schemas/ValorComposicao"},"conta_financeira":{"$ref":"#/components/schemas/ContaFinanceira"},"id_reconciliacao":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"id_parcela":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"id_solicitacao_cobranca":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"observacao":{"type":"string","example":"Pgto 03/05 - Nota Fiscal 4567"},"metodo_pagamento":{"type":"string","example":"DEPOSITO_BANCARIO","enum":["DINHEIRO","CARTAO_CREDITO","BOLETO_BANCARIO","CARTAO_CREDITO_VIA_LINK","CHEQUE","CARTAO_DEBITO","TRANSFERENCIA_BANCARIA","OUTRO","CARTEIRA_DIGITAL","CASHBACK","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","PIX_PAGAMENTO_INSTANTANEO","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO","PIX_COBRANCA","DEBITO_AUTOMATICO"]},"origem":{"type":"string","example":"LANCAMENTO_FINANCEIRO","enum":["LANCAMENTO_FINANCEIRO","DAS","FOLHA","TRANSFERENCIA","SALDO_CONTA_BANCARIA","VENDA","COMPRA","VENDA_AGENDADA","COMPRA_AGENDADA","IMPORTACAO_DOCUMENTO","IMPOSTO_RETIDO","SIC","NOTA_COMPRA","ANTECIPACAO","RENEGOCIACAO","HONORARIOS_CONTABEIS"]},"id_recibo_digital":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"tipo_evento_financeiro":{"type":"string","example":"RECEITA","enum":["RECEITA","DESPESA"]},"nsu":{"type":"string","example":"000215783210"},"id_referencia":{"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"atualizado_em":{"type":"string","format":"date-time","example":"2025-08-05T08:37:05"},"anexos":{"type":"array","items":{"$ref":"#/components/schemas/AnexoBaixa"}}}}},"components/schemas/AnexoBaixa":{"id":"components/schemas/AnexoBaixa","kind":"json-schema","title":"AnexoBaixa","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"referencia":{"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"nome":{"type":"string","example":"baixa_03_05.pdf"},"descricao":{"type":"string","example":"Pgto 03/05 - Nota Fiscal 4567"},"tipo":{"type":"string","example":"RECIBO_DIGITAL","enum":["RECIBO_DIGITAL","RECIBO"]},"tipo_conteudo":{"type":"string","example":"FILE","enum":["FILE","URL"]},"url":{"type":"string","example":"www.example.com"}}}},"components/schemas/AnexoParcela":{"id":"components/schemas/AnexoParcela","kind":"json-schema","title":"AnexoParcela","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"versao":{"type":"integer","format":"int64","example":1},"descricao":{"type":"string","example":"Boleto de cobrança"},"nome":{"type":"string","example":"boleto_03_05.pdf"},"url":{"type":"string","example":"www.exemplo.com"},"tipo_conteudo":{"type":"string","example":"URL","enum":["FILE","URL"]},"referencia":{"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"tipo_anexo":{"type":"string","example":"BOLETO_BANCARIO","enum":["BOLETO_BANCARIO_RFB","BOLETO_BANCARIO","RECIBO","FATURA","OUTROS","RECIBO_DIGITAL"]},"id_parcela":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}}}},"components/schemas/SolicitacaoCobranca":{"id":"components/schemas/SolicitacaoCobranca","kind":"json-schema","title":"SolicitacaoCobranca","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"versao":{"type":"integer","format":"int64","example":1},"status_solicitacao_cobranca":{"type":"string","example":"AGUARDANDO_CONFIRMACAO","enum":["AGUARDANDO_CONFIRMACAO","EM_CANCELAMENTO","REGISTRADO","QUITADO","CANCELADO","INVALIDO","EXPIRADO","FALHA_EMISSAO","FALHA_CANCELAR","REMESSA_GERADO","REMESSA_PENDENTE","PAGO","EXTORNADO"]},"valor_composicao":{"$ref":"#/components/schemas/ValorComposicao"},"data_vencimento":{"type":"string","format":"date","example":"2025-09-05"},"data_quitacao":{"type":"string","format":"date","example":"2025-09-05"},"tipo_solicitacao_cobranca":{"type":"string","example":"BOLETO","enum":["BOLETO","LINK_PAGAMENTO","BOLETO_REGISTRADO","PIX_COBRANCA"]},"id_cliente":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"id_referencia":{"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"url":{"type":"string","example":"www.exemplo.com"},"detalhe_erro":{"type":"string","example":"Erro de valor..."},"conta_financeira":{"$ref":"#/components/schemas/ContaFinanceira"},"notificacao_cobranca":{"$ref":"#/components/schemas/NotificacaoCobranca"},"confirmado_em":{"type":"string","format":"date","example":"2025-09-05"},"descricao":{"type":"string","example":"Reembolso de Despesas"},"referencia_externa":{"type":"string","example":"5b04139f-fcca-4c64-8d01-1dd568eb420e"},"recuperado":{"type":"boolean","example":false},"combinado":{"type":"boolean","example":false},"atributos_personalizados":{"type":"string","example":"atributos"}}}},"components/schemas/NotificacaoCobranca":{"id":"components/schemas/NotificacaoCobranca","kind":"json-schema","title":"NotificacaoCobranca","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"solicitacao_cobranca_ids":{"type":"array","example":["35473eec-4e74-11ee-b500-9f61de8a8b8b"],"items":{"type":"string","format":"uuid"}},"versao":{"type":"integer","format":"int64","example":1},"enviado_em":{"type":"string","format":"date","example":"2025-09-05"},"aberto_em":{"type":"string","format":"date","example":"2025-09-05"},"itens_notificacao_cobranca":{"type":"array","items":{"$ref":"#/components/schemas/ItemNotificacaoCobranca"}},"assunto":{"type":"string","example":"Fatura Vencida"},"corpo":{"type":"string","example":"Verificamos que o prazo de vencimento era [X] dias atrás..."},"respondido_para":{"type":"string","example":"exemplo@email.com"},"agendado":{"type":"boolean","example":false},"auto_notificacao":{"type":"boolean","example":false},"envio_instantaneo":{"type":"boolean","example":false}}}},"components/schemas/ItemNotificacaoCobranca":{"id":"components/schemas/ItemNotificacaoCobranca","kind":"json-schema","title":"ItemNotificacaoCobranca","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"versao":{"type":"integer","format":"int64","example":1},"email":{"type":"string","example":"exemplo@email.com"},"sms":{"type":"string","example":"SMS"},"whatsapp":{"type":"string","example":"whatsapp"},"status_entrega":{"type":"string","example":"ENVIADO","enum":["ENVIADO","INVALIDO"]}}}},"components/schemas/Fatura":{"id":"components/schemas/Fatura","kind":"json-schema","title":"Fatura","data":{"type":"object","properties":{"numero":{"type":"integer","format":"int64","example":123},"rps":{"type":"integer","format":"int64","example":1},"tipo_fatura":{"type":"string","example":"NFE","enum":["NFE","NFSE","NFCE"]}}}},"components/schemas/Renegociacao":{"id":"components/schemas/Renegociacao","kind":"json-schema","title":"Renegociacao","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações de renegociação."},"children":[]}]}]}],"properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da renegociação."},"children":[]}]}]}],"example":"43adf4e9-203c-4f7e-a0f6-08abf3f8a583"},"valor":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor da renegociação."},"children":[]}]}]}],"example":25}}}},"components/schemas/RenegociacaoContaAReceber":{"id":"components/schemas/RenegociacaoContaAReceber","kind":"json-schema","title":"RenegociacaoContaAReceber","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações de renegociação."},"children":[]}]}]}],"properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da renegociação."},"children":[]}]}]}],"example":"43adf4e9-203c-4f7e-a0f6-08abf3f8a583"},"valor":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor da renegociação."},"children":[]}]}]}],"example":25},"id_evento":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do evento relacionado à renegociação."},"children":[]}]}]}],"example":"6460daeb-6db1-4a50-a15d-b9dfb54200ca"}}}},"components/schemas/TransferenciaContaFinanceiraResponse":{"id":"components/schemas/TransferenciaContaFinanceiraResponse","kind":"json-schema","title":"TransferenciaContaFinanceiraResponse","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resposta paginada contendo a lista de transferências entre contas financeiras"},"children":[]}]}]}],"properties":{"itens_totais":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número total de transferências encontradas"},"children":[]}]}]}],"example":50},"itens":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de transferências entre contas financeiras"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/TransferenciaContaFinanceira"}}}}},"components/schemas/TransferenciaContaFinanceira":{"id":"components/schemas/TransferenciaContaFinanceira","kind":"json-schema","title":"TransferenciaContaFinanceira","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Representa uma transferência entre contas financeiras da empresa"},"children":[]}]}]}],"properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da transferência"},"children":[]}]}]}],"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição ou motivo da transferência"},"children":[]}]}]}],"example":"Transferência para conta poupança"},"valor":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor da transferência"},"children":[]}]}]}],"example":1500.5},"data":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data em que a transferência foi realizada (formato ISO date)"},"children":[]}]}]}],"example":"2026-02-15"},"origem":{"$ref":"#/components/schemas/Quitacao","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações da conta financeira de origem da transferência"},"children":[]}]}]}]},"destino":{"$ref":"#/components/schemas/Quitacao","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações da conta financeira de destino da transferência"},"children":[]}]}]}]}}}},"components/schemas/Quitacao":{"id":"components/schemas/Quitacao","kind":"json-schema","title":"Quitacao","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações de quitação de uma conta financeira incluindo data, composição de valores e detalhes da conta"},"children":[]}]}]}],"properties":{"data":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data da quitação (formato ISO date)"},"children":[]}]}]}],"example":"2026-02-15"},"composicao_valor":{"$ref":"#/components/schemas/ComposicaoValorTransferencia","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Detalhamento da composição do valor da transação"},"children":[]}]}]}]},"conta_financeira":{"$ref":"#/components/schemas/ContaFinanceiraDetalhes","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações da conta financeira envolvida"},"children":[]}]}]}]}}}},"components/schemas/ComposicaoValorTransferencia":{"id":"components/schemas/ComposicaoValorTransferencia","kind":"json-schema","title":"ComposicaoValorTransferencia","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Composição detalhada do valor de uma transação financeira"},"children":[]}]}]}],"properties":{"valor_bruto":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor bruto da transação antes de qualquer ajuste"},"children":[]}]}]}],"example":1500.5},"juros":{"type":"number","format":"decimal","description":"Valor de juros aplicado","example":0},"multa":{"type":"number","format":"decimal","description":"Valor de multa aplicado","example":0},"valor_liquido":{"type":"number","format":"decimal","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valor líquido após todos os ajustes (valor_bruto + juros + multa - desconto - taxa)"},"children":[]}]}]}],"example":1500.5},"desconto":{"type":"number","format":"decimal","description":"Valor de desconto aplicado","example":0},"taxa":{"type":"number","format":"decimal","description":"Valor de taxa aplicado","example":0}}}},"components/schemas/ContaFinanceiraDetalhes":{"id":"components/schemas/ContaFinanceiraDetalhes","kind":"json-schema","title":"ContaFinanceiraDetalhes","data":{"type":"object","description":"Detalhes de uma conta financeira","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da conta financeira"},"children":[]}]}]}],"example":"8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f"},"nome":{"type":"string","description":"Nome da conta financeira","example":"Conta Corrente Principal"},"instituicao_bancaria":{"$ref":"#/components/schemas/InstituicaoBancaria","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações da instituição bancária"},"children":[]}]}]}]}}}},"components/schemas/InstituicaoBancaria":{"id":"components/schemas/InstituicaoBancaria","kind":"json-schema","title":"InstituicaoBancaria","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações da instituição bancária"},"children":[]}]}]}],"properties":{"codigo":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Código da instituição bancária"},"children":[]}]}]}],"example":1},"nome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da instituição bancária"},"children":[]}]}]}],"example":"Banco do Brasil"}}}},"components/schemas/EventoFinanceiro":{"id":"components/schemas/EventoFinanceiro","kind":"json-schema","title":"EventoFinanceiro","data":{"type":"object","description":"IDs dos eventos financeiros alterados","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único do evento financeiro"},"children":[]}]}]}],"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"}}}},"components/schemas/SaldoInicialContaFinanceira":{"id":"components/schemas/SaldoInicialContaFinanceira","kind":"json-schema","title":"SaldoInicialContaFinanceira","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Informações sobre o saldo inicial de uma conta financeira, incluindo o valor e a data de competência"},"children":[]}]}]}],"properties":{"tipo":{"type":"string","example":"RECEITA","enum":["RECEITA","DESPESA"]},"id_conta_financeira":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identificador único da conta financeira"},"children":[]}]}]}],"example":"35473eec-4e74-11ee-b500-9f61de8a8b8b"},"data_competencia":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de competência da conta financeira (formato ISO date)"},"children":[]}]}]}],"example":"2018-03-16"},"saldo_inicial":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saldo inicial da conta financeira na data de competência. Se o saldo for negativo, o tipo deve ser \"DESPESA\", caso contrário, \"RECEITA\"."},"children":[]}]}]}],"format":"decimal","example":2500}}}},"schema_149":{"kind":"json-schema","data":{"type":"number"},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"enum":[10,20,50,100,200,500,1000],"type":"number"},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"string"},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"string","enum":["ATIVO","INATIVO","TODOS"]},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Parcela"}},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"string","enum":["NOME","TIPO"]},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"string","enum":["RECEITA","DESPESA"]},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":6},"itens":{"type":"array","items":{"$ref":"#/components/schemas/Categoria"}},"totais":{"$ref":"#/components/schemas/Totais"}}},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ConfiguracaoPadraoCategoria"}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"enum":[10,20,50,100,200,500,1000],"type":"integer"},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTROS","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"]}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":6},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ContaFinanceira"}},"totais":{"$ref":"#/components/schemas/Totais"}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","example":400},"message":{"type":"string","example":"O valor 'fbbccb85-a71a-4dfdb699-56ac1b5f1115' fornecido no parâmetro 'id_conta_financeira' não é um identificador (uuid) válido."}}},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","example":401},"message":{"type":"string","example":"The Token has expired."}}},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","example":500},"message":{"type":"string","example":"Ocorreu um erro inesperado no servidor. Tente novamente mais tarde."}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"integer","default":1,"minimum":1},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"type":"integer","default":10,"enum":[10,20,50,100,200,500,1000]},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"type":"integer","example":400},"message":{"type":"string","example":"A data de início não pode ser posterior à data de fim."}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"enum":[10,20,50,100,200,500,1000],"type":"integer","minimum":1},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","example":"999.99"},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["PERDIDO","RECEBIDO","EM_ABERTO","RENEGOCIADO","RECEBIDO_PARCIAL","ATRASADO"]}},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"string","enum":["ID","CODIGO","NOME","ATIVO"]},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9]+(\\.[0-9]{1,2})?$","example":"110.10"},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":6},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ContaAPagar"}},"totais":{"type":"object","properties":{"ativo":{"type":"integer","example":6},"inativo":{"type":"integer","example":0},"todos":{"type":"integer","example":6}}}}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"9986f173-f531-4660-96ae-04b71c879264"},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":1},"itens":{"type":"array","items":{"$ref":"#/components/schemas/EventoFinanceiro"}}}},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":1},"itens":{"type":"array","items":{"$ref":"#/components/schemas/SaldoInicialContaFinanceira"}}}},"id":"schema_183"}},"exampleStore":{"paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/400/content/application~1json/example":{"value":{"code":400,"message":"O valor 'fbbccb85-a71a-4dfdb699-56ac1b5f1115' fornecido no parâmetro 'id_conta_financeira' não é um identificador (uuid) válido."},"id":"paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/400/content/application~1json/example"},"paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"The Token has expired."},"id":"paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/401/content/application~1json/example"},"paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/500/content/application~1json/example":{"value":{"code":500,"message":"Ocorreu um erro inesperado no servidor. Tente novamente mais tarde."},"id":"paths/~1v1~1conta-financeira~1{id_conta_financeira}~1saldo-atual/get/responses/500/content/application~1json/example"},"paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_sucesso":{"value":{"itens_totais":2,"itens":[{"id":"35473eec-4e74-11ee-b500-9f61de8a8b8b","descricao":"Transferência para conta poupança","valor":1500.5,"data":"2026-02-15","origem":{"data":"2026-02-15","composicao_valor":{"valor_bruto":1500.5,"juros":0,"multa":0,"valor_liquido":1500.5,"desconto":0,"taxa":0},"conta_financeira":{"id":"8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f","nome":"Conta Corrente Principal","instituicao_bancaria":{"codigo":1,"nome":"Banco do Brasil"}}},"destino":{"data":"2026-02-15","composicao_valor":{"valor_bruto":1500.5,"juros":0,"multa":0,"valor_liquido":1500.5,"desconto":0,"taxa":0},"conta_financeira":{"id":"7d1b2c34-8a5e-4f6d-b9c2-3e4f5a6b7c8d","nome":"Conta Poupança","instituicao_bancaria":{"codigo":1,"nome":"Banco do Brasil"}}}},{"id":"9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d","descricao":"Transferência para investimento","valor":5000,"data":"2026-02-20","origem":{"data":"2026-02-20","composicao_valor":{"valor_bruto":5000,"juros":0,"multa":0,"valor_liquido":5000,"desconto":0,"taxa":0},"conta_financeira":{"id":"8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f","nome":"Conta Corrente Principal","instituicao_bancaria":{"codigo":341,"nome":"Itaú"}}},"destino":{"data":"2026-02-20","composicao_valor":{"valor_bruto":5000,"juros":0,"multa":0,"valor_liquido":5000,"desconto":0,"taxa":0},"conta_financeira":{"id":"6c5d4e3f-2a1b-9c8d-7e6f-5a4b3c2d1e0f","nome":"Conta Investimento","instituicao_bancaria":{"codigo":341,"nome":"Itaú"}}}}]},"key":"exemplo_sucesso","summary":"Exemplo de resposta com transferências","id":"paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_sucesso"},"paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_vazio":{"value":{"itens_totais":0,"itens":[]},"key":"exemplo_vazio","summary":"Exemplo de resposta sem transferências","id":"paths/~1v1~1financeiro~1transferencias/get/responses/200/content/application~1json/examples/exemplo_vazio"},"paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/data_invalida":{"value":{"code":400,"message":"A data de início não pode ser posterior à data de fim."},"key":"data_invalida","summary":"Erro de validação de datas","id":"paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/data_invalida"},"paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/uuid_invalido":{"value":{"code":400,"message":"O valor fornecido no parâmetro 'ids_conta_financeira' não é um identificador (uuid) válido."},"key":"uuid_invalido","summary":"Erro de UUID inválido","id":"paths/~1v1~1financeiro~1transferencias/get/responses/400/content/application~1json/examples/uuid_invalido"},"paths/~1v1~1financeiro~1transferencias/get/responses/401/content/application~1json/example":{"value":{"code":401,"message":"The Token has expired."},"id":"paths/~1v1~1financeiro~1transferencias/get/responses/401/content/application~1json/example"},"paths/~1v1~1financeiro~1transferencias/get/responses/500/content/application~1json/example":{"value":{"code":500,"message":"Ocorreu um erro inesperado no servidor. Tente novamente mais tarde."},"id":"paths/~1v1~1financeiro~1transferencias/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/financial-apis-openapi","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/financial-apis-openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/financial-apis-openapi.json?download"},{"url":"/_bundle/docs/financial-apis-openapi.yaml?download"}],"excludeFromSearch":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, recomendamos, de forma opcional a consulta à nossa Central de Ajuda:\n\n**Contas a pagar e receber:**  \n[https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar](https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar)\n\n**Cadastro e gestão de contas financeiras:**  \n[https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras](https://ajuda.contaazul.com/hc/pt-br/sections/20546846147981-Cadastro-e-gest%C3%A3o-de-contas-financeiras)\n\n**Categorias financeiras e centro de custos:**  \n[https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo](https://ajuda.contaazul.com/hc/pt-br/sections/28553633338765-Categorias-financeiras-e-centros-de-custo)\n"}},"baseSlug":"/docs/financial-apis-openapi","routesMapping":{}}