{"items":[{"type":"link","label":"Contratos","link":"/docs/contracts-apis-openapi","routeSlug":"/docs/contracts-apis-openapi","content":{"contentType":"overview","meta":{"name":"Contratos"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"contracts-apis-openapi.json","url":"/_bundle/docs/contracts-apis-openapi.json?download"},{"kind":"download","label":"contracts-apis-openapi.yaml","url":"/_bundle/docs/contracts-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/contracts-apis-openapi","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":"A API de Contratos tem como objetivo automatizar a gestão de vendas recorrentes, sejam elas de produtos ou serviços. Por meio dessa funcionalidade, é possível criar contratos que geram automaticamente as vendas conforme a periodicidade configurada, garantindo maior eficiência operacional e redução de processos manuais. Esta API oferece endpoints que permitem criar, consultar o próximo número de contratos e consultar, possibilitando a integração direta com sistemas externos para controle e acompanhamento das recorrências."},"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":"Controle de contratos recorrentes:"},"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/19712815184781-Controle-de-contratos-recorrentes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/19712815184781-Controle-de-contratos-recorrentes"},"children":[]}]}]}]}]}],"sectionId":"/docs/contracts-apis-openapi"}],"sectionId":"/docs/contracts-apis-openapi"}]}]}},{"type":"group","label":"v1","link":"/docs/contracts-apis-openapi/v1","routeSlug":"/docs/contracts-apis-openapi/v1","items":[{"label":"Criar um novo contrato","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/contracts-apis-openapi/v1/criarcontrato","routeSlug":"/docs/contracts-apis-openapi/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":"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/ContratoToCreateRequest"}},"schemaId":"components/schemas/ContratoToCreateRequest","pointer":"/paths/~1v1~1contratos/post/requestBody"}],"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/contracts-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/ContratoToCreateRequest"}},"responseCodes":["200","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/contracts-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ContratoToCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContratoToCreateRequest"}},"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/ContratoToCreateResponse"}},"schemaId":"components/schemas/ContratoToCreateResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1contratos/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContratoToCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContratoToCreateResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/criarcontrato"}],"panels":[]}]},"httpPath":"/v1/contratos"},{"label":"Retornar os contratos por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/contracts-apis-openapi/v1/listarcontratos","routeSlug":"/docs/contracts-apis-openapi/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)."}},"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":[]}]}]}]},{"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_151","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_152","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 (máximo 50)"},"children":[]}]}]}],"example":10},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_153","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."},"children":[]}]}]}]},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_153","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."},"children":[]}]}]}]},{"name":"busca_textual","in":"query","schemaId":"schema_154","description":"Busca textual por nome","example":"Contrato 1"},{"name":"cliente_id","in":"query","schemaId":"schema_155","description":"id do cliente"},{"name":"data_inicio","in":"query","schemaId":"schema_156","description":"Data inicio do intervalo de busca","required":true,"example":"2026-08-15"},{"name":"data_fim","in":"query","schemaId":"schema_156","description":"Data fim do intervalo de busca","required":true,"example":"2027-08-15"}],"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/contracts-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","example":1,"schemaId":"schema_151"},{"name":"tamanho_pagina","in":"query","example":10,"schemaId":"schema_152"},{"name":"campo_ordenado_ascendente","in":"query","example":"DATA_INICIO","schemaId":"schema_153"},{"name":"campo_ordenado_descendente","in":"query","example":"DATA_INICIO","schemaId":"schema_153"},{"name":"busca_textual","in":"query","required":false,"example":"Contrato 1","schemaId":"schema_154"},{"name":"cliente_id","in":"query","schemaId":"schema_155"},{"name":"data_inicio","in":"query","required":true,"example":"2026-08-15","schemaId":"schema_156"},{"name":"data_fim","in":"query","required":true,"example":"2027-08-15","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/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/contracts-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/ListagemContratoResponse"}},"schemaId":"components/schemas/ListagemContratoResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1contratos/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListagemContratoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListagemContratoResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/listarcontratos"}],"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/contracts-apis-openapi/v1/getnextcontractnumber","routeSlug":"/docs/contracts-apis-openapi/v1/getnextcontractnumber","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":"getNextContractNumber","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":"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/contratos/proximo-numero","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/contracts-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","400","401","429","500"],"pointer":"/v1/contratos/proximo-numero","href":"v1/getnextcontractnumber","openApiOperationId":"getNextContractNumber","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/contracts-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~1contratos~1proximo-numero/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/getnextcontractnumber"}],"panels":[]}]},"httpPath":"/v1/contratos/proximo-numero"}],"content":{"contentType":"group","meta":{"name":"v1"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"v1","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conjunto de recursos para acompanhar e administrar operações  relacionadas a contratos - esses recursos incluem criar um novo contrato e retornar os contratos por filtro"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/contratos","summary":"Criar um novo contrato","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/criarcontrato","deprecated":false},{"title":"/v1/contratos","summary":"Retornar os contratos por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/listarcontratos","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/getnextcontractnumber","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ContratoToCreateRequest":{"id":"components/schemas/ContratoToCreateRequest","kind":"json-schema","title":"ContratoToCreateRequest","data":{"type":"object","required":["id_cliente","itens","condicao_pagamento","termos"],"properties":{"id_cliente":{"type":"string","format":"uuid","description":"id do cliente","example":"123e4567-e89b-12d3-a456-426614174000"},"data_emissao":{"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 emissão"},"children":[]}]}]}],"example":"2021-01-01"},"id_categoria":{"type":"string","format":"uuid","description":"id da categoria","example":"123e4567-e89b-12d3-a456-426614174000"},"id_centro_custo":{"type":"string","format":"uuid","description":"id do centro de custo","example":"123e4567-e89b-12d3-a456-426614174000"},"id_vendedor":{"type":"string","format":"uuid","description":"id do vendedor","example":"123e4567-e89b-12d3-a456-426614174000"},"observacoes":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observações do pagamento"},"children":[]}]}]}],"example":"Pagamento realizado em parcela única."},"observacoes_pagamento":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observações complementares da nota fiscal"},"children":[]}]}]}],"example":"Pagamento à vista."},"termos":{"$ref":"#/components/schemas/Termo"},"composicao_de_valor":{"$ref":"#/components/schemas/ComposicaoDeValor"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamento"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}}},"components/schemas/ComposicaoDeValor":{"id":"components/schemas/ComposicaoDeValor","kind":"json-schema","title":"ComposicaoDeValor","data":{"type":"object","properties":{"frete":{"type":"number","format":"double","description":"Valor do frete","example":10},"desconto":{"$ref":"#/components/schemas/Desconto"}}}},"components/schemas/Desconto":{"id":"components/schemas/Desconto","kind":"json-schema","title":"Desconto","data":{"type":"object","required":["tipo","valor"],"properties":{"tipo":{"type":"string","description":"Tipo de desconto","enum":["PORCENTAGEM","VALOR"],"example":"PORCENTAGEM"},"valor":{"type":"number","format":"double","description":"Valor do desconto","example":10}}}},"components/schemas/ContratoToCreateResponse":{"id":"components/schemas/ContratoToCreateResponse","kind":"json-schema","title":"ContratoToCreateResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"id do contrato","example":"123e4567-e89b-12d3-a456-426614174000"},"id_legado":{"type":"integer","format":"int64","description":"id legado","example":1234},"id_venda":{"type":"string","format":"uuid","description":"id da venda","example":"6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9"}}}},"components/schemas/Termo":{"id":"components/schemas/Termo","kind":"json-schema","title":"Termo","data":{"type":"object","required":["tipo_frequencia","tipo_expiracao","data_inicio","data_fim","numero"],"properties":{"tipo_frequencia":{"type":"string","enum":["MENSAL","ANUAL"],"example":"MENSAL"},"tipo_expiracao":{"type":"string","enum":["DATA","NUNCA"],"example":"DATA"},"data_inicio":{"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 início"},"children":[]}]}]}],"example":"2021-01-01"},"data_fim":{"type":"string","format":"date","description":"Data de fim","example":"2021-12-31"},"intervalo_frequencia":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intervalo de frequência deve ser sempre maior ou igual a 1"},"children":[]}]}]}],"example":1},"dia_emissao_venda":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dia de emissão do contrato"},"children":[]}]}]}],"example":1},"numero":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"O número do contrato deve ser único"},"children":[]}]}]}],"example":1}}}},"components/schemas/CondicaoPagamento":{"id":"components/schemas/CondicaoPagamento","kind":"json-schema","title":"CondicaoPagamento","data":{"type":"object","required":["dia_vencimento","primeira_data_vencimento"],"properties":{"tipo_pagamento":{"type":"string","description":"Tipo de pagamento","enum":["BOLETO_BANCARIO","CARTAO_CREDITO","CARTAO_DEBITO","CARTEIRA_DIGITAL","CASHBACK","CHEQUE","CREDITO_LOJA","CREDITO_VIRTUAL","DEPOSITO_BANCARIO","DINHEIRO","OUTRO","DEBITO_AUTOMATICO","CARTAO_CREDITO_VIA_LINK","PIX_PAGAMENTO_INSTANTANEO","PIX_COBRANCA","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","TRANSFERENCIA_BANCARIA","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO"],"example":"BOLETO_BANCARIO"},"id_conta_financeira":{"type":"string","format":"uuid","description":"id da conta financeira","example":"123e4567-e89b-12d3-a456-426614174000"},"dia_vencimento":{"type":"integer","description":"Dia de vencimento","example":10},"primeira_data_vencimento":{"type":"string","format":"date","description":"Primeira data de vencimento","example":"2021-01-10"}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"type":"object","required":["id","quantidade","valor"],"properties":{"id":{"type":"string","format":"uuid","description":"id do item","example":"123e4567-e89b-12d3-a456-426614174000"},"quantidade":{"type":"integer","description":"Quantidade do produto","example":10},"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 produto"},"children":[]}]}]}],"example":"Produto 1"},"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 unitário do item"},"children":[]}]}]}],"example":100},"valor_custo":{"type":"number","format":"double","description":"Valor de custo do item","example":100}}}},"components/schemas/ListagemContratoResponse":{"id":"components/schemas/ListagemContratoResponse","kind":"json-schema","title":"ListagemContratoResponse","data":{"type":"object","properties":{"itens_totais":{"type":"integer","example":6},"items":{"type":"array","items":{"$ref":"#/components/schemas/ListagemContratoItemResponse"}}}}},"components/schemas/ListagemContratoItemResponse":{"id":"components/schemas/ListagemContratoItemResponse","kind":"json-schema","title":"ListagemContratoItemResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"id do contrato"},"cliente":{"$ref":"#/components/schemas/ClienteContratoResponse"},"status":{"type":"string","description":"Status do contrato","example":"ATIVO","enum":["ATIVO","INATIVO"]},"proximo_vencimento":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data do próximo vencimento"},"children":[]}]}]}],"example":"2026-08-15"},"data_inicio":{"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 início"},"children":[]}]}]}],"example":"2026-08-15"},"numero":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número do contrato"},"children":[]}]}]}],"example":1014}}}},"components/schemas/ClienteContratoResponse":{"id":"components/schemas/ClienteContratoResponse","kind":"json-schema","title":"ClienteContratoResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"id do cliente","example":"123e4567-e89b-12d3-a456-426614174000"},"nome":{"type":"string","description":"Nome do cliente","example":"João da Silva"}}}},"schema_151":{"kind":"json-schema","data":{"type":"number","default":1},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"number","default":10},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"string","enum":["DATA_INICIO","DATA_FIM"],"example":"DATA_INICIO"},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"string"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"integer","format":"int64","nullable":true,"example":4512645},"id":"schema_157"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}},"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/contracts-apis-openapi","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/contracts-apis-openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/contracts-apis-openapi.json?download"},{"url":"/_bundle/docs/contracts-apis-openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Contratos","description":"A API de Contratos tem como objetivo automatizar a gestão de vendas recorrentes, sejam elas de produtos ou serviços. Por meio dessa funcionalidade, é possível criar contratos que geram automaticamente as vendas conforme a periodicidade configurada, garantindo maior eficiência operacional e redução de processos manuais. Esta API oferece endpoints que permitem criar, consultar o próximo número de contratos e consultar, possibilitando a integração direta com sistemas externos para controle e acompanhamento das recorrências.\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**Controle de contratos recorrentes:**  \n[https://ajuda.contaazul.com/hc/pt-br/sections/19712815184781-Controle-de-contratos-recorrentes](https://ajuda.contaazul.com/hc/pt-br/sections/19712815184781-Controle-de-contratos-recorrentes)\n"}},"baseSlug":"/docs/contracts-apis-openapi","routesMapping":{}}