{"items":[{"type":"link","label":"Contratos","link":"/docs/open-api-scheduled-sales","routeSlug":"/docs/open-api-scheduled-sales","content":{"contentType":"overview","meta":{"name":"Contratos"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"open-api-scheduled-sales.json","url":"/_bundle/docs/open-api-scheduled-sales.json?download"},{"kind":"download","label":"open-api-scheduled-sales.yaml","url":"/_bundle/docs/open-api-scheduled-sales.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/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Contratos (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":"Operações relacionadas a contratos"},"children":[]}]}]}]}],"sectionId":"/docs/open-api-scheduled-sales"}],"sectionId":"/docs/open-api-scheduled-sales"}]}]}},{"type":"group","label":"v1","link":"/docs/open-api-scheduled-sales/v1","routeSlug":"/docs/open-api-scheduled-sales/v1","items":[{"label":"Retornar os contratos por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/listarcontratos","routeSlug":"/docs/open-api-scheduled-sales/v1/listarcontratos","metadata":{"seo":{"title":"Retornar os contratos por filtro","description":"Permite consultar contratos existentes, com suporte a filtros que facilitam a busca e a gestão dos contratos criados (ex. por cliente, data, status, entre outros).Os parâmetros de múltiplos valores (ex.: cliente_id, tipo_pagamento) aceitam dois formatos equivalentes: chaves repetidas (?cliente_id=<uuid1>&cliente_id=<uuid2>) ou valores separados por vírgula (?cliente_id=<uuid1>,<uuid2>)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listarContratos","name":"Retornar os contratos por filtro","isWebhook":false,"pointer":"/paths/~1v1~1contratos/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar os contratos 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 contratos existentes, com suporte a filtros que facilitam a busca e a gestão dos contratos criados (ex. por cliente, data, status, entre outros)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Os parâmetros de múltiplos valores (ex.: cliente_id, tipo_pagamento) aceitam dois formatos equivalentes: chaves repetidas ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?cliente_id=<uuid1>&cliente_id=<uuid2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") ou valores separados por vírgula ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?cliente_id=<uuid1>,<uuid2>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_210","description":"Página","example":1},{"name":"tamanho_pagina","in":"query","schemaId":"schema_211","description":"Tamanho da página (máximo 50)","example":10},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_212","description":"Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente.","example":"DATA_INICIO"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_212","description":"Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado.","example":"DATA_INICIO"},{"name":"busca_textual","in":"query","schemaId":"schema_213","description":"Busca textual por nome","example":"Contrato 1"},{"name":"cliente_id","in":"query","schemaId":"schema_214","description":"id do cliente","example":"123e4567-e89b-12d3-a456-426614174000"},{"name":"data_inicio","in":"query","schemaId":"schema_213","description":"Data inicio do intervalo de busca","required":true,"example":"2026-08-15"},{"name":"data_fim","in":"query","schemaId":"schema_213","description":"Data fim do intervalo de busca","required":true,"example":"2027-08-15"},{"name":"tipo_pagamento","in":"query","schemaId":"schema_215","description":"Tipos de pagamento","example":"BOLETO_BANCARIO"},{"name":"status","in":"query","schemaId":"schema_216","description":"Status dos contratos","example":"ATIVO"}],"pointer":"/paths/~1v1~1contratos/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/contratos","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","example":1,"schemaId":"schema_210"},{"name":"tamanho_pagina","in":"query","example":10,"schemaId":"schema_211"},{"name":"campo_ordenado_ascendente","in":"query","example":"DATA_INICIO","schemaId":"schema_212"},{"name":"campo_ordenado_descendente","in":"query","example":"DATA_INICIO","schemaId":"schema_212"},{"name":"busca_textual","in":"query","example":"Contrato 1","schemaId":"schema_213"},{"name":"cliente_id","in":"query","example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_214","explode":true},{"name":"data_inicio","in":"query","required":true,"example":"2026-08-15","schemaId":"schema_213"},{"name":"data_fim","in":"query","required":true,"example":"2027-08-15","schemaId":"schema_213"},{"name":"tipo_pagamento","in":"query","example":"BOLETO_BANCARIO","schemaId":"schema_215","explode":true},{"name":"status","in":"query","example":"ATIVO","schemaId":"schema_216"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/contratos","href":"v1/listarcontratos","openApiOperationId":"listarContratos","summary":"Retornar os contratos por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","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/ContratosFiltroResposta"}},"schemaId":"components/schemas/ContratosFiltroResposta"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1contratos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContratosFiltroResposta","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContratosFiltroResposta"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/listarcontratos"}],"panels":[]}]},"httpPath":"/v1/contratos"},{"label":"Criar um novo contrato","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/criarcontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/criarcontrato","metadata":{"seo":{"title":"Criar um novo contrato","description":"Permite criar um novo contrato, definindo as informações necessárias para configuração da recorrência, como período, produtos/serviços vinculados e demais parâmetros do contrato."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"criarContrato","name":"Criar um novo contrato","isWebhook":false,"pointer":"/paths/~1v1~1contratos/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar um novo contrato","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 contrato, definindo as informações necessárias para configuração da recorrência, como período, produtos/serviços vinculados e demais parâmetros do contrato."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriarContrato"}},"schemaId":"components/schemas/CriarContrato","pointer":"/paths/~1v1~1contratos/post/requestBody","description":"Dados para criar o contrato"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/contratos","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CriarContrato"}},"responseCodes":["201","400","401","429","500"],"pointer":"/v1/contratos","href":"v1/criarcontrato","openApiOperationId":"criarContrato","summary":"Criar um novo contrato"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriarContrato","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriarContrato"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoCriacaoContrato"}},"schemaId":"components/schemas/ResumoCriacaoContrato"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1contratos/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ResumoCriacaoContrato","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResumoCriacaoContrato"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/criarcontrato"}],"panels":[]}]},"httpPath":"/v1/contratos"},{"label":"Retornar o próximo número do contrato disponível","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/obterproximonumerocontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/obterproximonumerocontrato","metadata":{"seo":{"title":"Retornar o próximo número do contrato disponível","description":"Permite consultar o próximo número de contrato a ser utilizado no momento da criação."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterProximoNumeroContrato","name":"Retornar o próximo número do contrato disponível","isWebhook":false,"pointer":"/paths/~1v1~1contratos~1proximo-numero/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o próximo número do contrato disponível","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 o próximo número de contrato a ser utilizado no momento da criação."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/contratos/proximo-numero","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/contratos/proximo-numero","href":"v1/obterproximonumerocontrato","openApiOperationId":"obterProximoNumeroContrato","summary":"Retornar o próximo número do contrato disponível"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","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_217"}},"schemaId":"schema_217"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1contratos~1proximo-numero/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_217","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_217"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/obterproximonumerocontrato"}],"panels":[]}]},"httpPath":"/v1/contratos/proximo-numero"},{"label":"Retornar o contrato por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/obtercontratoporid","routeSlug":"/docs/open-api-scheduled-sales/v1/obtercontratoporid","metadata":{"seo":{"title":"Retornar o contrato por id","description":"Recupera os detalhes de um contrato específico por ID. Útil quando quiser exibir ou sincronizar todos os dados de um contrato específico."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"obterContratoPorID","name":"Retornar o contrato por id","isWebhook":false,"pointer":"/paths/~1v1~1contratos~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o contrato 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":"Recupera os detalhes de um contrato específico por ID. Útil quando quiser exibir ou sincronizar todos os dados de um contrato específico."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_213","description":"ID do contrato (UUID)","required":true}],"pointer":"/paths/~1v1~1contratos~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/contratos/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_213"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/contratos/{id}","href":"v1/obtercontratoporid","openApiOperationId":"obterContratoPorID","summary":"Retornar o contrato por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","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/ContratoResumo"}},"schemaId":"components/schemas/ContratoResumo"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1contratos~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContratoResumo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContratoResumo"}}},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"404","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/obtercontratoporid"}],"panels":[]}]},"httpPath":"/v1/contratos/{id}"},{"label":"Remover um contrato","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/removercontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/removercontrato","metadata":{"seo":{"title":"Remover um contrato","description":"Remove um contrato existente. O contrato será excluído permanentemente, cancelando todas as vendas associadas (agendadas e efetivadas). Contratos em reajuste de valor não podem ser removidos."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removerContrato","name":"Remover um contrato","isWebhook":false,"pointer":"/paths/~1v1~1contratos~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remover um contrato","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":"Remove um contrato existente. O contrato será excluído permanentemente, cancelando todas as vendas associadas (agendadas e efetivadas). Contratos em reajuste de valor não podem ser removidos."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_213","description":"ID do contrato (UUID)","required":true}],"pointer":"/paths/~1v1~1contratos~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/contratos/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_213"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","429","500"],"pointer":"/v1/contratos/{id}","href":"v1/removercontrato","openApiOperationId":"removerContrato","summary":"Remover um contrato"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","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":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1contratos~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/removercontrato"}],"panels":[]}]},"httpPath":"/v1/contratos/{id}"},{"label":"Encerrar um contrato","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/open-api-scheduled-sales/v1/encerrarcontrato","routeSlug":"/docs/open-api-scheduled-sales/v1/encerrarcontrato","metadata":{"seo":{"title":"Encerrar um contrato","description":"Encerra um contrato ativo. O contrato será desativado e não poderá mais gerar novas cobranças. Contratos que estão passando por reajuste de valor não podem ser encerrados."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"encerrarContrato","name":"Encerrar um contrato","isWebhook":false,"pointer":"/paths/~1v1~1contratos~1{id}~1encerrar/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Encerrar um contrato","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":"Encerra um contrato ativo. O contrato será desativado e não poderá mais gerar novas cobranças. Contratos que estão passando por reajuste de valor não podem ser encerrados."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_213","description":"ID do contrato (UUID)","required":true}],"pointer":"/paths/~1v1~1contratos~1{id}~1encerrar/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/contratos/{id}/encerrar","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_213"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["204","400","401","429","500"],"pointer":"/v1/contratos/{id}/encerrar","href":"v1/encerrarcontrato","openApiOperationId":"encerrarContrato","summary":"Encerrar um contrato"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","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":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}},"schemaId":"components/schemas/ErroAPI"}],"pointer":"/paths/~1v1~1contratos~1{id}~1encerrar/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"401","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"429","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}},{"code":"500","schemaId":"components/schemas/ErroAPI","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErroAPI"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/encerrarcontrato"}],"panels":[]}]},"httpPath":"/v1/contratos/{id}/encerrar"}],"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":"Operações relacionadas a orçamentos"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/contratos","summary":"Retornar os contratos por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/listarcontratos","deprecated":false},{"title":"/v1/contratos","summary":"Criar um novo contrato","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/criarcontrato","deprecated":false},{"title":"/v1/contratos/proximo-numero","summary":"Retornar o próximo número do contrato disponível","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/obterproximonumerocontrato","deprecated":false},{"title":"/v1/contratos/{id}","summary":"Retornar o contrato por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/obtercontratoporid","deprecated":false},{"title":"/v1/contratos/{id}","summary":"Remover um contrato","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/v1/removercontrato","deprecated":false},{"title":"/v1/contratos/{id}/encerrar","summary":"Encerrar um contrato","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/encerrarcontrato","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ClienteContrato":{"id":"components/schemas/ClienteContrato","kind":"json-schema","title":"ClienteContrato","data":{"description":"Dados do cliente vinculado ao contrato","type":"object","properties":{"id":{"description":"ID do cliente","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"description":"Nome do cliente","type":"string","example":"João da Silva"}}}},"components/schemas/ClienteResumo":{"id":"components/schemas/ClienteResumo","kind":"json-schema","title":"ClienteResumo","data":{"description":"Resumo dos dados do cliente vinculado ao contrato","type":"object","properties":{"id":{"description":"ID do cliente","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"description":"Nome do cliente","type":"string","example":"João da Silva"}}}},"components/schemas/ComposicaoValorResumo":{"id":"components/schemas/ComposicaoValorResumo","kind":"json-schema","title":"ComposicaoValorResumo","data":{"description":"Resumo da composição de valores do contrato","type":"object","properties":{"desconto":{"description":"Valor do desconto aplicado","type":"number","example":200},"frete":{"description":"Valor do frete","type":"number","example":50},"valor_bruto":{"description":"Valor bruto do contrato","type":"number","example":1200},"valor_impostos_servico":{"description":"Valor total dos impostos sobre o serviço","type":"number","example":100},"valor_liquido":{"description":"Valor líquido do contrato","type":"number","example":1050}}}},"components/schemas/CondicaoPagamentoResumo":{"id":"components/schemas/CondicaoPagamentoResumo","kind":"json-schema","title":"CondicaoPagamentoResumo","data":{"description":"Resumo das condições de pagamento do contrato","type":"object","properties":{"dia_vencimento":{"description":"Dia do mês para vencimento do pagamento","type":"integer","example":15},"nome_conta_financeira":{"description":"Nome da conta financeira vinculada ao pagamento","type":"string","example":"Conta Corrente"},"observacoes_pagamento":{"description":"Observações sobre o pagamento","type":"string","example":"Pagamento mensal"},"tipo_pagamento":{"description":"Tipo de pagamento do contrato","allOf":[{"$ref":"#/components/schemas/TipoDePagamento"}],"example":"CARTAO_CREDITO"}}}},"components/schemas/ConfiguracaoRecorrenciaResumo":{"id":"components/schemas/ConfiguracaoRecorrenciaResumo","kind":"json-schema","title":"ConfiguracaoRecorrenciaResumo","data":{"description":"Resumo da configuração de recorrência do contrato","type":"object","properties":{"vigencia_restante":{"description":"Vigência restante do contrato","type":"integer","example":12},"vigencia_total":{"description":"Vigência total do contrato","type":"integer","example":24}}}},"components/schemas/ContaFinanceiraContrato":{"id":"components/schemas/ContaFinanceiraContrato","kind":"json-schema","title":"ContaFinanceiraContrato","data":{"description":"Conta financeira vinculada ao contrato","type":"object","properties":{"id":{"description":"ID da conta","type":"string","example":"b0ff3efe-a7fe-4432-81ac-62ca1085529b"},"tipo":{"description":"Tipo de conta","allOf":[{"$ref":"#/components/schemas/TipoContaFinanceira"}],"example":"CONTA_CORRENTE"}}}},"components/schemas/ContratoResumo":{"id":"components/schemas/ContratoResumo","kind":"json-schema","title":"ContratoResumo","data":{"description":"Resumo do modelo que representa um contrato de venda recorrente","type":"object","properties":{"cliente":{"$ref":"#/components/schemas/ClienteResumo"},"composicao_valor":{"$ref":"#/components/schemas/ComposicaoValorResumo"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamentoResumo"},"configuracao_recorrencia":{"$ref":"#/components/schemas/ConfiguracaoRecorrenciaResumo"},"data_proxima_emissao":{"description":"Data da próxima emissão","type":"string","example":"2026-09-15"},"data_proximo_vencimento":{"description":"Data do próximo vencimento","type":"string","example":"2026-09-15"},"data_ultima_emissao":{"description":"Data da última emissão","type":"string","example":"2026-08-15"},"id":{"description":"ID do contrato","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"id_proxima_venda_agendada":{"description":"ID da próxima venda agendada","type":"string","example":"123e4567-e89b-12d3-a456-426614174002"},"id_ultima_venda_confirmada":{"description":"ID da última venda confirmada","type":"string","example":"123e4567-e89b-12d3-a456-426614174001"},"local_prestacao_servico":{"$ref":"#/components/schemas/LocalPrestacaoServicoResumo"},"observacoes":{"description":"Observações adicionais sobre o contrato","type":"string","example":"Contrato de venda recorrente para serviços de consultoria."},"status":{"description":"Status do contrato","allOf":[{"$ref":"#/components/schemas/Status"}],"example":"ATIVO"},"termos":{"$ref":"#/components/schemas/TermosResumo"},"vendedor":{"$ref":"#/components/schemas/VendedorResumo"}}}},"components/schemas/ContratosFiltroResposta":{"id":"components/schemas/ContratosFiltroResposta","kind":"json-schema","title":"ContratosFiltroResposta","data":{"description":"Resposta paginada da listagem de contratos","type":"object","properties":{"itens":{"description":"Lista de contratos","type":"array","items":{"$ref":"#/components/schemas/ItemContrato"}},"itens_totais":{"description":"Total de contratos encontrados","type":"integer","example":1}}}},"components/schemas/CriarComposicaoValorContrato":{"id":"components/schemas/CriarComposicaoValorContrato","kind":"json-schema","title":"CriarComposicaoValorContrato","data":{"description":"Modelo de criação da composição de valor do contrato, incluindo frete e desconto","type":"object","properties":{"desconto":{"description":"Detalhes do desconto aplicado à venda","allOf":[{"$ref":"#/components/schemas/CriarDescontoContrato"}]},"frete":{"description":"Valor de frete","type":"number","minimum":0,"example":15}}}},"components/schemas/CriarCondicaoPagamentoContrato":{"id":"components/schemas/CriarCondicaoPagamentoContrato","kind":"json-schema","title":"CriarCondicaoPagamentoContrato","data":{"description":"Modelo de condição de pagamento para criação de contrato","type":"object","required":["dia_vencimento","primeira_data_vencimento","tipo_pagamento"],"properties":{"dia_vencimento":{"description":"Dia do mês para vencimento do pagamento (1-31)","type":"integer","maximum":31,"minimum":1,"example":10},"id_conta_financeira":{"description":"ID da conta financeira associada ao pagamento","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"primeira_data_vencimento":{"description":"Data do primeiro vencimento no formato YYYY-MM-DD","type":"string","example":"2025-01-10"},"tipo_pagamento":{"description":"Forma de pagamento","allOf":[{"$ref":"#/components/schemas/TipoDePagamento"}],"example":"BOLETO_BANCARIO"}}}},"components/schemas/CriarContrato":{"id":"components/schemas/CriarContrato","kind":"json-schema","title":"CriarContrato","data":{"description":"Modelo de criação de contrato","type":"object","required":["condicao_pagamento","id_cliente","itens","termos"],"properties":{"composicao_de_valor":{"description":"Composição dos valores da venda, incluindo frete e desconto","allOf":[{"$ref":"#/components/schemas/CriarComposicaoValorContrato"}]},"condicao_pagamento":{"description":"Condição de pagamento do contrato","allOf":[{"$ref":"#/components/schemas/CriarCondicaoPagamentoContrato"}]},"id_categoria":{"description":"ID da categoria","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"id_centro_custo":{"description":"ID do centro de custo","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"id_cliente":{"description":"ID do cliente associado ao contrato","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"id_vendedor":{"description":"ID do vendedor responsável pelo contrato","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"itens":{"description":"Lista de itens do contrato","type":"array","minItems":1,"items":{"$ref":"#/components/schemas/CriarItemVendaContrato"}},"observacoes":{"description":"Observações gerais sobre o contrato","type":"string","example":"Cliente solicitou entrega rápida"},"observacoes_pagamento":{"description":"Observações específicas para a emissão da nota fiscal","type":"string","example":"Pagamento realizado em 3 parcelas"},"termos":{"description":"Termos de recorrência da venda agendada","allOf":[{"$ref":"#/components/schemas/CriarTermosContrato"}]}}}},"components/schemas/CriarDescontoContrato":{"id":"components/schemas/CriarDescontoContrato","kind":"json-schema","title":"CriarDescontoContrato","data":{"description":"Modelo de criação de desconto aplicado ao contrato","type":"object","required":["tipo","valor"],"properties":{"tipo":{"description":"Tipo de desconto (VALOR ou PORCENTAGEM)","allOf":[{"$ref":"#/components/schemas/TipoDeDesconto"}],"example":"VALOR"},"valor":{"description":"Valor do desconto","type":"number","minimum":0,"example":5}}}},"components/schemas/CriarItemVendaContrato":{"id":"components/schemas/CriarItemVendaContrato","kind":"json-schema","title":"CriarItemVendaContrato","data":{"description":"Modelo de criação de item de venda para contrato","type":"object","required":["id","quantidade","valor"],"properties":{"descricao":{"description":"Descrição do item da venda","type":"string","maxLength":500,"example":"Produto A"},"id":{"description":"ID do item da venda","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"quantidade":{"description":"Quantidade do item da venda","type":"number","minimum":0,"example":2},"valor":{"description":"Valor do item da venda","type":"number","minimum":0,"example":100.5},"valor_custo":{"description":"Valor de custo do item da venda                        // Itens do kit, caso o item seja um kit","type":"number","example":80}}}},"components/schemas/CriarTermosContrato":{"id":"components/schemas/CriarTermosContrato","kind":"json-schema","title":"CriarTermosContrato","data":{"description":"Modelo de termos para criação de contrato","type":"object","required":["data_fim","data_inicio","dia_emissao_venda","intervalo_frequencia","numero","tipo_expiracao","tipo_frequencia"],"properties":{"data_fim":{"description":"Data de fim da recorrência no formato YYYY-MM-DD; não pode ser anterior à data de início","type":"string","example":"2025-12-31"},"data_inicio":{"description":"Data de início da recorrência no formato YYYY-MM-DD","type":"string","example":"2025-01-01"},"dia_emissao_venda":{"description":"Dia do mês em que a venda será emitida","type":"integer","maximum":31,"minimum":1,"example":5},"intervalo_frequencia":{"description":"Intervalo de frequência entre as recorrências (1-60)","type":"integer","maximum":60,"minimum":1,"example":1},"numero":{"description":"Número do contrato","type":"integer","minimum":1,"example":12},"tipo_expiracao":{"description":"Tipo de expiração da recorrência. Aceita DATA ou NUNCA","allOf":[{"$ref":"#/components/schemas/TipoExpiracaoRecorrencia"}],"example":"DATA"},"tipo_frequencia":{"description":"Tipo de frequência da recorrência. Aceita MENSAL ou ANUAL","allOf":[{"$ref":"#/components/schemas/TipoFrequenciaRecorrencia"}],"example":"MENSAL"}}}},"components/schemas/ErroAPI":{"id":"components/schemas/ErroAPI","kind":"json-schema","title":"ErroAPI","data":{"description":"Modelo de resposta para erros da API","type":"object","properties":{"error":{"description":"Mensagem de erro","type":"string","example":"Mensagem de erro detalhada"}}}},"components/schemas/ItemContrato":{"id":"components/schemas/ItemContrato","kind":"json-schema","title":"ItemContrato","data":{"description":"Dados resumidos de um contrato recorrente","type":"object","properties":{"cliente":{"description":"Dados do cliente","allOf":[{"$ref":"#/components/schemas/ClienteContrato"}]},"conta_financeira":{"description":"Conta financeira vinculada","allOf":[{"$ref":"#/components/schemas/ContaFinanceiraContrato"}]},"data_inicio":{"description":"Data de início do contrato","type":"string","example":"2026-08-15"},"id":{"description":"ID do contrato","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"numero":{"description":"Número do contrato","type":"integer","example":1014},"proximo_vencimento":{"description":"Data do próximo vencimento","type":"string","example":"2026-08-15"},"status":{"description":"Status do contrato","allOf":[{"$ref":"#/components/schemas/Status"}],"example":"ATIVO"},"termos":{"description":"Termos de vigência","allOf":[{"$ref":"#/components/schemas/TermosContrato"}]},"tipo_pagamento":{"description":"Tipo de pagamento","allOf":[{"$ref":"#/components/schemas/TipoDePagamento"}],"example":"BOLETO_BANCARIO"},"total":{"description":"Valor total do contrato","type":"number","example":1000},"total_proximo_vencimento":{"description":"Valor da próxima cobrança","type":"number","example":1000}}}},"components/schemas/LocalPrestacaoServicoResumo":{"id":"components/schemas/LocalPrestacaoServicoResumo","kind":"json-schema","title":"LocalPrestacaoServicoResumo","data":{"description":"Resumo do local de prestação de serviço do contrato","type":"object","properties":{"nome":{"description":"Nome do local de prestação de serviço","type":"string","example":"Escritório Central"}}}},"components/schemas/PeriodoDeAgendamento":{"id":"components/schemas/PeriodoDeAgendamento","kind":"json-schema","title":"PeriodoDeAgendamento","data":{"description":"Enum de período de agendamento","type":"string","enum":["MENSAL","SEMANAL","ANUAL"],"x-enum-varnames":["SCHEDULED_PERIOD_MONTH","SCHEDULED_PERIOD_WEEK","SCHEDULED_PERIOD_YEAR"]}},"components/schemas/ResumoCriacaoContrato":{"id":"components/schemas/ResumoCriacaoContrato","kind":"json-schema","title":"ResumoCriacaoContrato","data":{"description":"Resumo de criação de contrato","type":"object","properties":{"id":{"description":"ID do contrato","type":"string","example":"550e8400-e29b-41d4-a716-446655440000"},"id_legado":{"description":"ID legado do contrato","type":"integer","example":12345},"id_venda":{"description":"ID da venda gerada pelo contrato","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"}}}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"description":"Enum de status do contrato","type":"string","enum":["ATIVO","INATIVO","DELETADO"],"x-enum-varnames":["STATUS_ENABLED","STATUS_DISABLED","STATUS_DELETED"]}},"components/schemas/TermosContrato":{"id":"components/schemas/TermosContrato","kind":"json-schema","title":"TermosContrato","data":{"description":"Termos de vigência do contrato","type":"object","properties":{"data_fim":{"description":"Data de término do contrato","type":"string","example":"2026-10-21"},"tipo_expiracao":{"description":"Tipo de expiração","allOf":[{"$ref":"#/components/schemas/TipoDeExpiracao"}],"example":"DATA"},"vigencia_atual":{"description":"Número de cobranças realizadas","type":"integer","example":6},"vigencia_total":{"description":"Total de cobranças previstas","type":"integer","example":12}}}},"components/schemas/TermosResumo":{"id":"components/schemas/TermosResumo","kind":"json-schema","title":"TermosResumo","data":{"description":"Resumo dos termos do contrato","type":"object","properties":{"data_fim":{"description":"Data de término do contrato","type":"string","example":"2026-10-21"},"data_inicio":{"description":"Data de início do contrato","type":"string","example":"2026-08-15"},"dia_emissao_venda":{"description":"Dia do mês para emissão da venda","type":"integer","example":15},"intervalo_frequencia":{"description":"Intervalo entre as cobranças (ex: a cada 1 mês)","type":"integer","example":1},"numero":{"description":"Número do contrato","type":"integer","example":1},"tipo_expiracao":{"description":"Tipo de expiração do contrato","allOf":[{"$ref":"#/components/schemas/TipoDeExpiracao"}],"example":"DATA"},"tipo_frequencia":{"description":"Tipo de frequência de cobrança","allOf":[{"$ref":"#/components/schemas/PeriodoDeAgendamento"}],"example":"MENSAL"}}}},"components/schemas/TipoContaFinanceira":{"id":"components/schemas/TipoContaFinanceira","kind":"json-schema","title":"TipoContaFinanceira","data":{"description":"Enum de tipo de conta financeira","type":"string","enum":["APLICACAO","CAIXINHA","CONTA_CORRENTE","CARTAO_CREDITO","INVESTIMENTO","OUTROS","MEIOS_RECEBIMENTO","POUPANCA","COBRANCAS_CONTA_AZUL","RECEBA_FACIL_CARTAO"],"x-enum-varnames":["ACCOUNT_TYPE_APPLICATION","ACCOUNT_TYPE_CASH","ACCOUNT_TYPE_CHECKING","ACCOUNT_TYPE_CREDIT_CARD","ACCOUNT_TYPE_INVESTMENT","ACCOUNT_TYPE_OTHERS","ACCOUNT_TYPE_PAYMENTS_SYSTEM","ACCOUNT_TYPE_SAVINGS","ACCOUNT_TYPE_CA_PAYMENTS","ACCOUNT_TYPE_CA_PAYMENTS_CREDIT"]}},"components/schemas/TipoDeDesconto":{"id":"components/schemas/TipoDeDesconto","kind":"json-schema","title":"TipoDeDesconto","data":{"description":"Enum de tipo de desconto","type":"string","enum":["PORCENTAGEM","VALOR"],"x-enum-varnames":["DISCOUNT_TYPE_PERCENT","DISCOUNT_TYPE_VALUE"]}},"components/schemas/TipoDeExpiracao":{"id":"components/schemas/TipoDeExpiracao","kind":"json-schema","title":"TipoDeExpiracao","data":{"description":"Enum de tipo de expiração","type":"string","enum":["DATA","VEZES","NUNCA"],"x-enum-varnames":["EXPIRATION_TYPE_DATE","EXPIRATION_TYPE_TIMES","EXPIRATION_TYPE_FOREVER"]}},"components/schemas/TipoDePagamento":{"id":"components/schemas/TipoDePagamento","kind":"json-schema","title":"TipoDePagamento","data":{"description":"Enum de tipo de pagamento","type":"string","enum":["BOLETO_BANCARIO","CARTAO_CREDITO","CARTAO_DEBITO","CARTEIRA_DIGITAL","CASHBACK","CHEQUE","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","DINHEIRO","OUTRO","DEBITO_AUTOMATICO","LINK_PAGAMENTO","PIX_PAGAMENTO_INSTANTANEO","COBRANCA_PIX","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","TRANSFERENCIA_BANCARIA","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO"],"x-enum-varnames":["PAYMENT_TYPE_BANKING_BILLET","PAYMENT_TYPE_CREDIT_CARD","PAYMENT_TYPE_DEBIT_CARD","PAYMENT_TYPE_DIGITAL_WALLET","PAYMENT_TYPE_CASHBACK","PAYMENT_TYPE_CHECK","PAYMENT_TYPE_STORE_CREDIT","PAYMENT_TYPE_VIRTUAL_CREDIT","PAYMENT_TYPE_BANKING_DEPOSIT","PAYMENT_TYPE_CASH","PAYMENT_TYPE_OTHER","PAYMENT_TYPE_AUTOMATIC_DEBIT","PAYMENT_TYPE_PAYMENT_LINK","PAYMENT_TYPE_INSTANT_PAYMENT","PAYMENT_TYPE_PIX_CHARGE","PAYMENT_TYPE_FIDELITY_PROGRAM","PAYMENT_TYPE_WITHOUT_PAYMENT","PAYMENT_TYPE_BANKING_TRANSFER","PAYMENT_TYPE_FOOD_VOUCHER","PAYMENT_TYPE_FUEL_VOUCHER","PAYMENT_TYPE_GIFT_VOUCHER","PAYMENT_TYPE_MEAL_VOUCHER"]}},"components/schemas/TipoExpiracaoRecorrencia":{"id":"components/schemas/TipoExpiracaoRecorrencia","kind":"json-schema","title":"TipoExpiracaoRecorrencia","data":{"description":"Enum de tipo de expiração de recorrência","type":"string","enum":["DATA","NUNCA"],"x-enum-varnames":["RECURRENCE_EXPIRATION_TYPE_DATE","RECURRENCE_EXPIRATION_TYPE_FOREVER"]}},"components/schemas/TipoFrequenciaRecorrencia":{"id":"components/schemas/TipoFrequenciaRecorrencia","kind":"json-schema","title":"TipoFrequenciaRecorrencia","data":{"description":"Enum de tipo de frequência de recorrência","type":"string","enum":["MENSAL","ANUAL"],"x-enum-varnames":["RECURRENCE_FREQUENCY_TYPE_MONTH","RECURRENCE_FREQUENCY_TYPE_YEAR"]}},"components/schemas/VendedorResumo":{"id":"components/schemas/VendedorResumo","kind":"json-schema","title":"VendedorResumo","data":{"description":"Resumo dos dados do vendedor responsável pelo contrato","type":"object","properties":{"id":{"description":"ID do vendedor","type":"string","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"description":"Nome do vendedor","type":"string","example":"Maria Oliveira"}}}},"schema_210":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"integer","default":10},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"string","enum":["DATA_INICIO","DATA_FIM"]},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"type":"string"},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"array","items":{"enum":["BOLETO_BANCARIO","CARTAO_CREDITO","CARTAO_DEBITO","CARTEIRA_DIGITAL","CASHBACK","CHEQUE","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","DINHEIRO","OUTRO","DEBITO_AUTOMATICO","LINK_PAGAMENTO","PIX_PAGAMENTO_INSTANTANEO","COBRANCA_PIX","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","TRANSFERENCIA_BANCARIA","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_REFEICAO"],"type":"string"}},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"string","enum":["TODOS","ATIVO","INATIVO","PROXIMO_AO_VENCIMENTO"]},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_217"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Digite "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'Bearer <JWT>'"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", onde JWT é o access_token recebido no login (passo 2 do fluxo de autenticação)."},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/open-api-scheduled-sales","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/open-api-scheduled-sales","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/open-api-scheduled-sales.json?download"},{"url":"/_bundle/docs/open-api-scheduled-sales.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Contratos","description":"Operações relacionadas a contratos"}},"baseSlug":"/docs/open-api-scheduled-sales","routesMapping":{}}