{"items":[{"type":"link","label":"Vendas","link":"/docs/sales-apis-openapi","routeSlug":"/docs/sales-apis-openapi","content":{"contentType":"overview","meta":{"name":"Vendas"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"sales-apis-openapi.json","url":"/_bundle/docs/sales-apis-openapi.json?download"},{"kind":"download","label":"sales-apis-openapi.yaml","url":"/_bundle/docs/sales-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/sales-apis-openapi","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Vendas (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 Vendas (v1) permite que sistemas externos integrem funcionalidades de vendas diretamente com o ERP da Conta Azul. Com ela, é possível criar, atualizar, consultar e excluir vendas, bem como recuperar informações detalhadas sobre os itens das vendas e gerar documentos associados, como PDFs de vendas."},"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":"link","inline":true,"attributes":{"href":"https://ajuda.contaazul.com/hc/pt-br/sections/19712754054285-Controle-de-vendas"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://ajuda.contaazul.com/hc/pt-br/sections/19712754054285-Controle-de-vendas"},"children":[]}]}]}]}]}],"sectionId":"/docs/sales-apis-openapi"}],"sectionId":"/docs/sales-apis-openapi"}]}]}},{"type":"group","label":"v1","link":"/docs/sales-apis-openapi/v1","routeSlug":"/docs/sales-apis-openapi/v1","items":[{"label":"Retornar os vendedores","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/listvendedores","routeSlug":"/docs/sales-apis-openapi/v1/listvendedores","metadata":{"seo":{"title":"Retornar os vendedores","description":"Retorna a lista de vendedores cadastrados na Conta Azul. Útil quando você precisa atribuir um vendedor a uma venda ou exibir opções de vendedores em sua interface."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVendedores","name":"Retornar os vendedores","isWebhook":false,"pointer":"/paths/~1v1~1venda~1vendedores/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar os vendedores","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna a lista de vendedores cadastrados na Conta Azul. Útil quando você precisa atribuir um vendedor a uma venda ou exibir opções de vendedores em sua interface."},"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/venda/vendedores","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/venda/vendedores","href":"v1/listvendedores","openApiOperationId":"listVendedores","summary":"Retornar os vendedores"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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_210"}},"schemaId":"schema_210"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1vendedores/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_210","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_210"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/listvendedores"}],"panels":[]}]},"httpPath":"/v1/venda/vendedores"},{"label":"Retornar a venda por id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/getvendabyid","routeSlug":"/docs/sales-apis-openapi/v1/getvendabyid","metadata":{"seo":{"title":"Retornar a venda por id","description":"Recupera os detalhes de uma venda específica por ID (pode ser UUID ou id legado). Útil quando quiser exibir ou sincronizar todos os dados de uma venda específica."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVendaById","name":"Retornar a venda por id","isWebhook":false,"pointer":"/paths/~1v1~1venda~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar a venda 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 uma venda específica por ID (pode ser UUID ou id legado). Útil quando quiser exibir ou sincronizar todos os dados de uma venda específica."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_211","description":"O legacy id ou uuid da venda a ser obtida","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v1~1venda~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/venda/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_211"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/venda/{id}","href":"v1/getvendabyid","openApiOperationId":"getVendaById","summary":"Retornar a venda por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/ObterVendaResponse"}},"schemaId":"components/schemas/ObterVendaResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ObterVendaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ObterVendaResponse"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getvendabyid"}],"panels":[]}]},"httpPath":"/v1/venda/{id}"},{"label":"Atualizar uma venda por id","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/editsale","routeSlug":"/docs/sales-apis-openapi/v1/editsale","metadata":{"seo":{"title":"Atualizar uma venda por id","description":"Permite atualizar uma venda existente. Útil se sua aplicação permite editar vendas depois que foram criadas no ERP."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editSale","name":"Atualizar uma venda por id","isWebhook":false,"pointer":"/paths/~1v1~1venda~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Atualizar uma venda por id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite atualizar uma venda existente. Útil se sua aplicação permite editar vendas depois que foram criadas no ERP."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_211","description":"O uuid da venda a ser editada","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v1~1venda~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VendaParaEdicaoRequest"}},"schemaId":"components/schemas/VendaParaEdicaoRequest","pointer":"/paths/~1v1~1venda~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/venda/{id}","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_211"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VendaParaEdicaoRequest"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/venda/{id}","href":"v1/editsale","openApiOperationId":"editSale","summary":"Atualizar uma venda por id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/VendaParaEdicaoRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VendaParaEdicaoRequest"}},"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/VendaEditadaResponse"}},"schemaId":"components/schemas/VendaEditadaResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VendaEditadaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VendaEditadaResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/editsale"}],"panels":[]}]},"httpPath":"/v1/venda/{id}"},{"label":"Retornar as vendas por filtro","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/searchvendas","routeSlug":"/docs/sales-apis-openapi/v1/searchvendas","metadata":{"seo":{"title":"Retornar as vendas por filtro","description":"Retorna as vendas filtradas, podendo fazer uso de parâmetros de consulta como data inicial/final, cliente, situação, tipos de venda, IDs de produtos, IDs de categorias, paginação, entre outros. Use esse endpoint para construir telas de listagem, dashboards ou relatórios de vendas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchVendas","name":"Retornar as vendas por filtro","isWebhook":false,"pointer":"/paths/~1v1~1venda~1busca/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar as vendas 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":"Retorna as vendas filtradas, podendo fazer uso de parâmetros de consulta como data inicial/final, cliente, situação, tipos de venda, IDs de produtos, IDs de categorias, paginação, entre outros. Use esse endpoint para construir telas de listagem, dashboards ou relatórios de vendas."},"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_212","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_213","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. O parâmetro tamanho_pagina aceita somente os valores definidos no enum. Se um valor fora dessa lista for informado, a requisição não é processada e a API retorna 400 Bad Request, com a mensagem indicando quais valores são válidos."},"children":[]}]}]}],"example":10},{"name":"campo_ordenado_ascendente","in":"query","schemaId":"schema_214","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação ascendente. Se informado ele desconsidera o valor do  campo_ordenado_descendente. É possível ordenar por numero da venda (NUMERO),  pelo nome do cliente (CLIENTE) ou pela data da venda (DATA)"},"children":[]}]}]}],"example":"numero"},{"name":"campo_ordenado_descendente","in":"query","schemaId":"schema_214","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente  não deverá ser informado. É possível ordenar por numero da venda (NUMERO), pelo nome do  cliente (CLIENTE) ou pela data da venda (DATA)"},"children":[]}]}]}],"example":"numero"},{"name":"termo_busca","in":"query","schemaId":"schema_215"},{"name":"data_inicio","in":"query","schemaId":"schema_216","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 da emissão da venda"},"children":[]}]}]}]},{"name":"data_fim","in":"query","schemaId":"schema_216","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data final da emissão da venda"},"children":[]}]}]}]},{"name":"data_criacao_de","in":"query","schemaId":"schema_216","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 da criação da venda"},"children":[]}]}]}]},{"name":"data_criacao_ate","in":"query","schemaId":"schema_217","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data final da criação da venda"},"children":[]}]}]}]},{"name":"data_alteracao_de","in":"query","schemaId":"schema_218","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração de (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-20T07:59:59"},{"name":"data_alteracao_ate","in":"query","schemaId":"schema_218","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração até (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-29T07:59:59"},{"name":"ids_vendedores","in":"query","schemaId":"schema_219","description":"ids dos vendedores"},{"name":"ids_clientes","in":"query","schemaId":"schema_219","description":"ids dos clientes"},{"name":"ids_natureza_operacao","in":"query","schemaId":"schema_219","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ids da natureza da operação"},"children":[]}]}]}]},{"name":"situacoes","in":"query","schemaId":"schema_220","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situações das vendas"},"children":[]}]}]}]},{"name":"tipos","in":"query","schemaId":"schema_220","description":"Tipos de vendas"},{"name":"origens","in":"query","schemaId":"schema_220","description":"Origens das vendas"},{"name":"numeros","in":"query","schemaId":"schema_221","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Números das vendas"},"children":[]}]}]}]},{"name":"ids_categorias","in":"query","schemaId":"schema_219","description":"ids das categorias"},{"name":"ids_produtos","in":"query","schemaId":"schema_219","description":"ids dos produtos"},{"name":"pendente","in":"query","schemaId":"schema_222","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica se a venda está pendente"},"children":[]}]}]}]},{"name":"totais","in":"query","schemaId":"schema_211","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tipo de total de venda. Possiveis valores "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WAITING_APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]}]}]}]},{"name":"ids_legado_donos","in":"query","schemaId":"schema_221","description":"ids legados dos donos"},{"name":"ids_legado_clientes","in":"query","schemaId":"schema_221","description":"ids legados dos clientes"},{"name":"ids_legado_produtos","in":"query","schemaId":"schema_221","description":"ids legados dos produtos"},{"name":"ids_legado_categorias","in":"query","schemaId":"schema_221","description":"ids legados das categorias"}],"pointer":"/paths/~1v1~1venda~1busca/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/venda/busca","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"pagina","in":"query","required":false,"example":1,"schemaId":"schema_212"},{"name":"tamanho_pagina","in":"query","required":false,"example":10,"schemaId":"schema_213"},{"name":"campo_ordenado_ascendente","in":"query","required":false,"example":"numero","schemaId":"schema_214"},{"name":"campo_ordenado_descendente","in":"query","required":false,"example":"numero","schemaId":"schema_214"},{"name":"termo_busca","in":"query","required":false,"schemaId":"schema_215"},{"name":"data_inicio","in":"query","required":false,"example":"2023-12-30","schemaId":"schema_216"},{"name":"data_fim","in":"query","required":false,"example":"2023-12-30","schemaId":"schema_216"},{"name":"data_criacao_de","in":"query","required":false,"example":"2023-12-30","schemaId":"schema_216"},{"name":"data_criacao_ate","in":"query","required":false,"example":"2023-12-31","schemaId":"schema_217"},{"name":"data_alteracao_de","in":"query","required":false,"example":"2025-10-20T07:59:59","schemaId":"schema_218"},{"name":"data_alteracao_ate","in":"query","required":false,"example":"2025-10-29T07:59:59","schemaId":"schema_218"},{"name":"ids_vendedores","in":"query","required":false,"schemaId":"schema_219"},{"name":"ids_clientes","in":"query","required":false,"schemaId":"schema_219"},{"name":"ids_natureza_operacao","in":"query","required":false,"schemaId":"schema_219"},{"name":"situacoes","in":"query","required":false,"schemaId":"schema_220"},{"name":"tipos","in":"query","required":false,"schemaId":"schema_220"},{"name":"origens","in":"query","required":false,"schemaId":"schema_220"},{"name":"numeros","in":"query","required":false,"schemaId":"schema_221"},{"name":"ids_categorias","in":"query","required":false,"schemaId":"schema_219"},{"name":"ids_produtos","in":"query","required":false,"schemaId":"schema_219"},{"name":"pendente","in":"query","required":false,"schemaId":"schema_222"},{"name":"totais","in":"query","required":false,"schemaId":"schema_211"},{"name":"ids_legado_donos","in":"query","required":false,"schemaId":"schema_221"},{"name":"ids_legado_clientes","in":"query","required":false,"schemaId":"schema_221"},{"name":"ids_legado_produtos","in":"query","required":false,"schemaId":"schema_221"},{"name":"ids_legado_categorias","in":"query","required":false,"schemaId":"schema_221"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/venda/busca","href":"v1/searchvendas","openApiOperationId":"searchVendas","summary":"Retornar as vendas por filtro"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/ListagemVendasResponse"}},"schemaId":"components/schemas/ListagemVendasResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1busca/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListagemVendasResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListagemVendasResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/searchvendas"}],"panels":[]}]},"httpPath":"/v1/venda/busca"},{"label":"Criar uma nova venda","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/createvenda","routeSlug":"/docs/sales-apis-openapi/v1/createvenda","metadata":{"seo":{"title":"Criar uma nova venda","description":"Cria uma nova venda no sistema da Conta Azul. Ideal para registrar vendas vindas de sistemas externos diretamente no ERP da Conta Azul."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVenda","name":"Criar uma nova venda","isWebhook":false,"pointer":"/paths/~1v1~1venda/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Criar uma nova venda","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cria uma nova venda no sistema da Conta Azul. Ideal para registrar vendas vindas de sistemas externos diretamente no ERP da Conta Azul."},{"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/CriacaoVendaRequest"}},"schemaId":"components/schemas/CriacaoVendaRequest","pointer":"/paths/~1v1~1venda/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/venda","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/CriacaoVendaRequest"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/venda","href":"v1/createvenda","openApiOperationId":"createVenda","summary":"Criar uma nova venda"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/CriacaoVendaRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CriacaoVendaRequest"}},"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/CriacaoVendaResponse"}},"schemaId":"components/schemas/CriacaoVendaResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CriacaoVendaResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CriacaoVendaResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/createvenda"}],"panels":[]}]},"httpPath":"/v1/venda"},{"label":"Retornar o PDF de uma venda","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/printvendapdf","routeSlug":"/docs/sales-apis-openapi/v1/printvendapdf","metadata":{"seo":{"title":"Retornar o PDF de uma venda","description":"Gera e retorna um PDF da venda identificada pelo ID. Use quando precisar mostrar ao usuário ou armazenar uma versão impressa da venda."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"printVendaPdf","name":"Retornar o PDF de uma venda","isWebhook":false,"pointer":"/paths/~1v1~1venda~1{id}~1imprimir/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o PDF de uma venda","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":"Gera e retorna um PDF da venda identificada pelo ID. Use quando precisar mostrar ao usuário ou armazenar uma versão impressa da venda."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_223","description":"id da venda a ser impressa, pode ser passado id ou uuid","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v1~1venda~1{id}~1imprimir/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/venda/{id}/imprimir","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_223"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/venda/{id}/imprimir","href":"v1/printvendapdf","openApiOperationId":"printVendaPdf","summary":"Retornar o PDF de uma venda"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_224"}},"schemaId":"schema_224"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1{id}~1imprimir/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_224","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_224"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/printvendapdf"}],"panels":[]}]},"httpPath":"/v1/venda/{id}/imprimir"},{"label":"Excluir vendas em lote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/deletevendasbatch","routeSlug":"/docs/sales-apis-openapi/v1/deletevendasbatch","metadata":{"seo":{"title":"Excluir vendas em lote","description":"Permite excluir várias vendas de uma vez. Útil para excluir em lote vendas de forma automatizada. Útil durante sincronizações ou processos de limpeza de dados."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteVendasBatch","name":"Excluir vendas em lote","isWebhook":false,"pointer":"/paths/~1v1~1venda~1exclusao-lote/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Excluir vendas em lote","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permite excluir várias vendas de uma vez. Útil para excluir em lote vendas de forma automatizada. Útil durante sincronizações ou processos de limpeza de dados."},"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/ExclusaoLote"}},"schemaId":"components/schemas/ExclusaoLote","pointer":"/paths/~1v1~1venda~1exclusao-lote/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/venda/exclusao-lote","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/ExclusaoLote"}},"responseCodes":["200","400","401","429","500"],"pointer":"/v1/venda/exclusao-lote","href":"v1/deletevendasbatch","openApiOperationId":"deleteVendasBatch","summary":"Excluir vendas em lote"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ExclusaoLote","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExclusaoLote"}},"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/ExclusaoResponse"}},"schemaId":"components/schemas/ExclusaoResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1exclusao-lote/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExclusaoResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExclusaoResponse"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/deletevendasbatch"}],"panels":[]}]},"httpPath":"/v1/venda/exclusao-lote"},{"label":"Retornar os itens de uma venda pelo id da venda","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/getvendaitens","routeSlug":"/docs/sales-apis-openapi/v1/getvendaitens","metadata":{"seo":{"title":"Retornar os itens de uma venda pelo id da venda","description":"Retorna a lista de itens de uma venda, dado o ID da venda. Use para exibir um detalhe da venda (todos produtos/serviços) ou para sincronizar os itens da venda para outros sistemas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVendaItens","name":"Retornar os itens de uma venda pelo id da venda","isWebhook":false,"pointer":"/paths/~1v1~1venda~1{id_venda}~1itens/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar os itens de uma venda pelo id da venda","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retorna a lista de itens de uma venda, dado o ID da venda. Use para exibir um detalhe da venda (todos produtos/serviços) ou para sincronizar os itens da venda para outros sistemas."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token de autorização Bearer JWT"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id_venda","in":"path","schemaId":"schema_225","description":"id da venda","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v1~1venda~1{id_venda}~1itens/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagina","in":"query","schemaId":"schema_212","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_213","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tamanho da página"},"children":[]}]}]}],"example":10}],"pointer":"/paths/~1v1~1venda~1{id_venda}~1itens/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/venda/{id_venda}/itens","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-apis-openapi","description":"Mock server","isMockServer":true}],"parameters":{"path":[{"name":"id_venda","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_225"}],"query":[{"name":"pagina","in":"query","example":1,"schemaId":"schema_212"},{"name":"tamanho_pagina","in":"query","example":10,"schemaId":"schema_213"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/venda/{id_venda}/itens","href":"v1/getvendaitens","openApiOperationId":"getVendaItens","summary":"Retornar os itens de uma venda pelo id da venda"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/ItensPaginados"}},"schemaId":"components/schemas/ItensPaginados"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"404","description":"Not Found"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1{id_venda}~1itens/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ItensPaginados","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ItensPaginados"}}},{"code":"400"},{"code":"401"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getvendaitens"}],"panels":[]}]},"httpPath":"/v1/venda/{id_venda}/itens"},{"label":"Retornar o próximo número de venda disponível","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/sales-apis-openapi/v1/getnextvendanumber","routeSlug":"/docs/sales-apis-openapi/v1/getnextvendanumber","metadata":{"seo":{"title":"Retornar o próximo número de venda disponível","description":"Retorna o próximo número de venda disponível, segundo a numeração usada no ERP da Conta Azul. Pode ser usado antes de criar uma venda para garantir que você está usando uma sequência de número válida/nova."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNextVendaNumber","name":"Retornar o próximo número de venda disponível","isWebhook":false,"pointer":"/paths/~1v1~1venda~1proximo-numero/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retornar o próximo número de venda 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":"Retorna o próximo número de venda disponível, segundo a numeração usada no ERP da Conta Azul. Pode ser usado antes de criar uma venda para garantir que você está usando uma sequência de número válida/nova."},"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/venda/proximo-numero","servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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/venda/proximo-numero","href":"v1/getnextvendanumber","openApiOperationId":"getNextVendaNumber","summary":"Retornar o próximo número de venda disponível"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-v2.contaazul.com"},{"url":"/_mock/docs/sales-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_226"}},"schemaId":"schema_226"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"429","description":"Too Many Requests"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1venda~1proximo-numero/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_226","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_226"}}},{"code":"400"},{"code":"401"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/v1/getnextvendanumber"}],"panels":[]}]},"httpPath":"/v1/venda/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 vendas - esses recursos incluem retornar os vendedores, retornar a venda por id, atualizar uma venda por id, retornar as vendas por filtro, criar uma nova venda, retornar o PDF de uma venda, excluir vendas em lote e retornar os itens de uma venda  pelo id da venda"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/venda/vendedores","summary":"Retornar os vendedores","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/listvendedores","deprecated":false},{"title":"/v1/venda/{id}","summary":"Retornar a venda por id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getvendabyid","deprecated":false},{"title":"/v1/venda/{id}","summary":"Atualizar uma venda por id","prefix":{"name":"put","color":"put"},"badges":[],"link":"/v1/editsale","deprecated":false},{"title":"/v1/venda/busca","summary":"Retornar as vendas por filtro","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/searchvendas","deprecated":false},{"title":"/v1/venda","summary":"Criar uma nova venda","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/createvenda","deprecated":false},{"title":"/v1/venda/{id}/imprimir","summary":"Retornar o PDF de uma venda","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/printvendapdf","deprecated":false},{"title":"/v1/venda/exclusao-lote","summary":"Excluir vendas em lote","prefix":{"name":"post","color":"post"},"badges":[],"link":"/v1/deletevendasbatch","deprecated":false},{"title":"/v1/venda/{id_venda}/itens","summary":"Retornar os itens de uma venda pelo id da venda","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getvendaitens","deprecated":false},{"title":"/v1/venda/proximo-numero","summary":"Retornar o próximo número de venda disponível","prefix":{"name":"get","color":"get"},"badges":[],"link":"/v1/getnextvendanumber","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ExclusaoLote":{"id":"components/schemas/ExclusaoLote","kind":"json-schema","title":"ExclusaoLote","data":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":10,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lista de uuids das vendas a serem excluídas"},"children":[]}]}]}]}},"required":["ids"],"example":{"ids":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"]}}},"components/schemas/ItensPaginados":{"id":"components/schemas/ItensPaginados","kind":"json-schema","title":"ItensPaginados","data":{"type":"object","properties":{"itens":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"itens_totais":{"type":"integer","example":25},"totais":{"$ref":"#/components/schemas/Totais"}}}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"uuid do item vendido"},"id_item":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001","description":"uuid do item"},"nome":{"type":"string","example":"Produto 1","description":"Nome do item vendido"},"descricao":{"type":"string","example":"Descrição do produto 1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição do item vendido"},"children":[]}]}]}]},"tipo":{"type":"string","example":"PRODUTO","enum":["PRODUTO","SERVICO","ATIVOS_IMOBILIZADOS","FINANCEIRO","KIT_PRODUTOS"],"description":"Tipo do item vendido"},"quantidade":{"type":"number","example":1,"description":"Quantidade do item vendido"},"valor":{"type":"number","example":100,"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 vendido"},"children":[]}]}]}]},"custo":{"type":"number","example":100,"description":"Valor de custo do item vendido"}}}},"components/schemas/Totais":{"id":"components/schemas/Totais","kind":"json-schema","title":"Totais","data":{"type":"object","properties":{"quantidade_produtos":{"type":"integer","example":1,"description":"Quantidade total de produtos vendidos"},"quantidade_servicos":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade total de serviços vendidos"},"children":[]}]}]}]},"quantidade_nao_conciliados":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidade total de itens não conciliados"},"children":[]}]}]}]}}}},"components/schemas/ObterVendaResponse":{"id":"components/schemas/ObterVendaResponse","kind":"json-schema","title":"ObterVendaResponse","data":{"type":"object","properties":{"cliente":{"$ref":"#/components/schemas/ClientePegarVendaPorId"},"evento_financeiro":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}},"notificacao":{"$ref":"#/components/schemas/Notificacao"},"natureza_operacao":{"$ref":"#/components/schemas/NaturezaOperacao"},"venda":{"$ref":"#/components/schemas/Negociacao"},"vendedor":{"$ref":"#/components/schemas/Vendedor"},"contrato":{"$ref":"#/components/schemas/Contrato"}}}},"components/schemas/ListagemVendasResponse":{"id":"components/schemas/ListagemVendasResponse","kind":"json-schema","title":"ListagemVendasResponse","data":{"type":"object","properties":{"totais":{"$ref":"#/components/schemas/TotaisVenda"},"quantidades":{"$ref":"#/components/schemas/QuantidadesVenda"},"total_itens":{"type":"integer","example":10,"description":"Total de itens"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/Venda"}}}}},"components/schemas/TotaisVenda":{"id":"components/schemas/TotaisVenda","kind":"json-schema","title":"TotaisVenda","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valores das de vendas com status Aprovado, Cancelado, Esperando aprovação e Total"},"children":[]}]}]}],"properties":{"total":{"type":"number","format":"double","description":"Valor total obtido de todas as vendas","example":1000},"aprovado":{"type":"number","format":"double","description":"Valor obtido das vendas aprovadas","example":500},"cancelado":{"type":"number","format":"double","description":"Valor obtido das vendas canceladas","example":200},"esperando_aprovacao":{"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 obtido das vendas esperando aprovação"},"children":[]}]}]}],"example":300}}}},"components/schemas/QuantidadesVenda":{"id":"components/schemas/QuantidadesVenda","kind":"json-schema","title":"QuantidadesVenda","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quantidades de vendas com status Aprovado, Cancelado, Esperando aprovação e Total"},"children":[]}]}]}],"properties":{"total":{"type":"number","format":"double","description":"Quantidade total de vendas realizadas","example":10},"aprovado":{"type":"number","format":"double","description":"Quantidade de vendas aprovadas","example":5},"cancelado":{"type":"number","format":"double","description":"Quantidade de vendas canceladas","example":3},"esperando_aprovacao":{"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":"Quantidade de vendas esperando aprovação"},"children":[]}]}]}],"example":2}}}},"components/schemas/Venda":{"id":"components/schemas/Venda","kind":"json-schema","title":"Venda","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"id da venda","example":"123e4567-e89b-12d3-a456-426614174000"},"total":{"type":"number","format":"double","description":"Total da venda","example":1000},"id_legado":{"type":"integer","description":"id legado da venda","example":123456},"data":{"type":"string","description":"Data da venda","example":"2023-12-31"},"criado_em":{"format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de criação da venda"},"children":[]}]}]}],"example":"2025-05-16T17:51:04.63"},"data_alteracao":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data de alteração da venda (ISO 8601, São Paulo/GMT-3)"},"children":[]}]}]}],"example":"2025-10-17T02:00:08.841"},"tipo":{"type":"string","example":"PRODUTO","description":"Tipo da venda"},"itens":{"type":"string","example":"PRODUTO","description":"Tipo de itens"},"condicao_pagamento":{"type":"boolean","example":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Condição de pagamento"},"children":[]}]}]}]},"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 da venda"},"children":[]}]}]}],"example":1001},"cliente":{"$ref":"#/components/schemas/Cliente"},"situacao":{"$ref":"#/components/schemas/Situacao"},"versao":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versão da venda"},"children":[]}]}]}],"example":1},"status_email":{"type":"object","properties":{"status":{"type":"string","example":"ENVIADO","description":"Status"},"enviado_em":{"type":"string","format":"date","example":"2023-12-31","description":"Data de envio"}}},"id_contrato":{"type":"string","format":"uuid","description":"id do contrato","example":"123e4567-e89b-12d3-a456-426614174000"},"origem":{"type":"string","description":"Origem da venda","example":"API"}}}},"components/schemas/Cliente":{"id":"components/schemas/Cliente","kind":"json-schema","title":"Cliente","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"},"email":{"type":"string","description":"Email do cliente","example":"exemplo@email.com"},"telefone":{"type":"string","description":"Telefone do cliente","example":"11912345678"},"endereco":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endereço do cliente"},"children":[]}]}]}],"example":"Rua das Flores, 123"},"cidade":{"type":"string","description":"Cidade do cliente","example":"São Paulo"},"estado":{"type":"string","description":"Estado do cliente","example":"SP"},"pais":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"País do cliente"},"children":[]}]}]}],"example":"Brasil"},"cep":{"type":"string","description":"CEP do cliente","example":"12345-678"}}}},"components/schemas/Situacao":{"id":"components/schemas/Situacao","kind":"json-schema","title":"Situacao","data":{"type":"object","properties":{"nome":{"type":"string","example":"Aprovado","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da situação"},"children":[]}]}]}]},"descricao":{"type":"string","example":"Venda aprovada e processada","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da situação"},"children":[]}]}]}]}}}},"components/schemas/ClientePegarVendaPorId":{"id":"components/schemas/ClientePegarVendaPorId","kind":"json-schema","title":"ClientePegarVendaPorId","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"tipo_pessoa":{"type":"string","description":"Tipo de pessoa","example":"Física"},"documento":{"type":"string","description":"Documento","example":"12345678901"},"nome":{"type":"string","description":"Nome","example":"João da Silva"}}}},"components/schemas/NaturezaOperacao":{"id":"components/schemas/NaturezaOperacao","kind":"json-schema","title":"NaturezaOperacao","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"tipo_operacao":{"$ref":"#/components/schemas/TipoOperacao"},"template_operacao":{"$ref":"#/components/schemas/TemplateNaturezaOperacao"},"label":{"type":"string","description":"Label","example":"Venda a Não Contribuinte"},"mudanca_financeira":{"type":"boolean","example":true},"mudanca_estoque":{"$ref":"#/components/schemas/MudancaEstoque"}}}},"components/schemas/Negociacao":{"id":"components/schemas/Negociacao","kind":"json-schema","title":"Negociacao","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id da negociação"},"children":[]}]}]}],"example":"123e4567-e89b-12d3-a456-426614174000"},"status":{"$ref":"#/components/schemas/Status"},"id_legado":{"type":"integer","example":123456},"tipo_negociacao":{"$ref":"#/components/schemas/TipoNegociacao"},"numero":{"type":"integer","example":1001},"id_categoria":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"data_compromisso":{"format":"date","example":"2023-12-31"},"configuracao_de_desconto":{"$ref":"#/components/schemas/ConfiguracaoDesconto"},"composicao_valor":{"$ref":"#/components/schemas/ComposicaoValor"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamento"},"total_itens":{"$ref":"#/components/schemas/ItensTotaisNegociacao"},"observacoes":{"type":"string","example":"Cliente confirmou o prazo de pagamento"},"id_cliente":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"versao":{"type":"integer","example":1},"tipo_pendencia":{"$ref":"#/components/schemas/TipoPendente"},"situacao":{"$ref":"#/components/schemas/SituacaoNegociacao"},"id_natureza_operacao":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"id_centro_custo":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"introducao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introdução da venda em orçamento"},"children":[]}]}]}],"example":"Orçamento do produto 1 e serviço 1"},"origem":{"type":"string","description":"Origem da venda","example":"API"}}}},"components/schemas/Notificacao":{"id":"components/schemas/Notificacao","kind":"json-schema","title":"Notificacao","data":{"type":"object","properties":{"id_referencia":{"type":"string","example":"notificacao-123456","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id de referência da notificação"},"children":[]}]}]}]},"enviado_para":{"type":"string","example":"exemplo@email.com","description":"Enviado para"},"enviado_em":{"type":"string","format":"date-time","description":"Data e hora de envio","example":"2023-12-31T12:00:00Z"},"aberto_em":{"type":"string","format":"date-time","description":"Data e hora de abertura","example":"2023-12-31T12:00:00Z"},"status":{"$ref":"#/components/schemas/StatusVisualizacaoMensagem"}}}},"components/schemas/TipoOperacao":{"id":"components/schemas/TipoOperacao","kind":"json-schema","title":"TipoOperacao","data":{"type":"string","enum":["VENDA","REMESSA","COMPRA","DEVOLUCAO"],"example":"VENDA"}},"components/schemas/TemplateNaturezaOperacao":{"id":"components/schemas/TemplateNaturezaOperacao","kind":"json-schema","title":"TemplateNaturezaOperacao","data":{"type":"string","example":"VENDA_MERCADORIAS","enum":["VENDA_MERCADORIAS","VENDA_SUFRAMA","VENDA_ENTREGA_FUTURA","VENDA_CONSIGNADA","VENDA_NAO_CONTRIBUINTE","VENDA_EXPORTACAO","VENDA_ORDEM","VENDA_INDUSTRIALIZACAO","PRESTACAO_SERVICO"]}},"components/schemas/MudancaEstoque":{"id":"components/schemas/MudancaEstoque","kind":"json-schema","title":"MudancaEstoque","data":{"type":"string","example":"ENTRADA_ESTOQUE","enum":["ENTRADA_ESTOQUE","SAIDA_ESTOQUE","NAO_ALTERA_ESTOQUE"]}},"components/schemas/TipoNegociacao":{"id":"components/schemas/TipoNegociacao","kind":"json-schema","title":"TipoNegociacao","data":{"type":"string","example":"VENDA","enum":["VENDA","COMPRA"]}},"components/schemas/Status":{"id":"components/schemas/Status","kind":"json-schema","title":"Status","data":{"type":"string","example":"EM_ANDAMENTO","enum":["REVISAO_PENDENTE","EM_ORCAMENTO","ORCAMENTO_ACEITO","ORCAMENTO_RECUSADO","EM_ANDAMENTO","CONTRATO","CANCELADO","PREVISAO","INCOMPLETA"]}},"components/schemas/ConfiguracaoDesconto":{"id":"components/schemas/ConfiguracaoDesconto","kind":"json-schema","title":"ConfiguracaoDesconto","data":{"type":"object","properties":{"tipo_desconto":{"$ref":"#/components/schemas/TipoDesconto"},"taxa_desconto":{"type":"number","format":"double","example":10}}}},"components/schemas/ComposicaoValor":{"id":"components/schemas/ComposicaoValor","kind":"json-schema","title":"ComposicaoValor","data":{"type":"object","properties":{"valor_bruto":{"type":"number","format":"double","example":1000},"desconto":{"type":"number","format":"double","example":100},"frete":{"type":"number","format":"double","example":50},"impostos":{"type":"number","format":"double","example":50},"impostos_deduzidos":{"type":"number","format":"double","example":20},"seguro":{"type":"number","format":"double","example":30},"despesas_incidentais":{"type":"number","format":"double","example":20},"valor_liquido":{"type":"number","format":"double","example":900}}}},"components/schemas/CondicaoPagamento":{"id":"components/schemas/CondicaoPagamento","kind":"json-schema","title":"CondicaoPagamento","data":{"type":"object","properties":{"tipo_pagamento":{"$ref":"#/components/schemas/FormaPagamento"},"id_conta_financeira":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"pagamento_a_vista":{"type":"boolean","example":false},"parcelas":{"type":"array","items":{"$ref":"#/components/schemas/ParcelaNegociacao"}},"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 sobre o pagamento"},"children":[]}]}]}],"example":"Observações sobre o pagamento"},"opcao_condicao_pagamento":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opção de condição de pagamento"},"children":[]}]}]}],"example":"À vista"},"nsu":{"type":"string","example":"1234567890"},"pagamento_cartao":{"$ref":"#/components/schemas/PagamentoCartao"}}}},"components/schemas/ItensTotaisNegociacao":{"id":"components/schemas/ItensTotaisNegociacao","kind":"json-schema","title":"ItensTotaisNegociacao","data":{"type":"object","properties":{"contagem_produtos":{"type":"integer","format":"int64","example":1},"contagem_servicos":{"type":"integer","format":"int64","example":1},"contagem_nao_conciliados":{"type":"integer","format":"int64","example":1}}}},"components/schemas/TipoPendente":{"id":"components/schemas/TipoPendente","kind":"json-schema","title":"TipoPendente","data":{"type":"object","properties":{"nome":{"enum":["NENHUMA","RESERVA_DE_ESTOQUE","CONCILIACAO_ITENS","PROCESSAMENTO_RESERVA_DE_ESTOQUE","ESPERANDO_CONFIRMACAO","AGUARDANDO_GERACAO_NOTA_FISCAL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da pendência"},"children":[]}]}]}],"example":"NENHUMA"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da pendência"},"children":[]}]}]}],"example":"Nenhuma"}}}},"components/schemas/SituacaoNegociacao":{"id":"components/schemas/SituacaoNegociacao","kind":"json-schema","title":"SituacaoNegociacao","data":{"type":"object","properties":{"nome":{"enum":["EM_ANDAMENTO","APROVADO","FATURADO","CANCELADO","ORCAMENTO","ORCAMENTO_ACEITO","ORCAMENTO_RECUSADO","CONTRATO","VENDA"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da situação"},"children":[]}]}]}],"example":"APROVADO"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da situação"},"children":[]}]}]}],"example":"Aprovado"},"ativado":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ativado ou não"},"children":[]}]}]}],"example":true}}}},"components/schemas/StatusVisualizacaoMensagem":{"id":"components/schemas/StatusVisualizacaoMensagem","kind":"json-schema","title":"StatusVisualizacaoMensagem","data":{"type":"string","example":"ENVIADO","enum":["ENVIADO","LIDO"]}},"components/schemas/TipoDesconto":{"id":"components/schemas/TipoDesconto","kind":"json-schema","title":"TipoDesconto","data":{"type":"string","example":"VALOR","enum":["PORCENTAGEM","VALOR"]}},"components/schemas/ParcelaNegociacao":{"id":"components/schemas/ParcelaNegociacao","kind":"json-schema","title":"ParcelaNegociacao","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"id da parcela","example":"123e4567-e89b-12d3-a456-426614174000"},"numero":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da parcela"},"children":[]}]}]}]},"data_vencimento":{"format":"date","example":"2023-12-31","description":"Data de vencimento"},"valor":{"type":"number","format":"double","description":"Valor da parcela","example":26.99},"descricao":{"type":"string","example":"Parcela 1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[]}]}]}]}}}},"components/schemas/PagamentoCartao":{"id":"components/schemas/PagamentoCartao","kind":"json-schema","title":"PagamentoCartao","data":{"type":"object","properties":{"tipo_bandeira":{"$ref":"#/components/schemas/BandeiraCartao"},"codigo_transacao":{"type":"string","example":"ABC123XYZ789"},"id_adquirente":{"type":"integer","format":"int64","example":123456789}}}},"components/schemas/BandeiraCartao":{"id":"components/schemas/BandeiraCartao","kind":"json-schema","title":"BandeiraCartao","data":{"type":"string","example":"VISA","enum":["VISA","MASTERCARD","AMERICAN_EXPRESS","SOROCRED","DINERS_CLUB","ELO","HIPERCARD","AURA","CABAL","ALELO","BANES_CARD","CALCARDS","CREDZ","DISCOVER","GOODCARD","GREENCARD","HIPER","JCB","MAIS","MAXVAN","POLICARD","REDECOMPRAS","SODEXO","VALECARD","VEROCHEQUE","VR","TICKET","OUTROS"]}},"components/schemas/FormaPagamento":{"id":"components/schemas/FormaPagamento","kind":"json-schema","title":"FormaPagamento","data":{"type":"string","example":"CARTAO_CREDITO","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"]}},"components/schemas/CriacaoVendaRequest":{"id":"components/schemas/CriacaoVendaRequest","kind":"json-schema","title":"CriacaoVendaRequest","data":{"type":"object","required":["id_cliente","numero","situacao","data_venda","itens","condicao_pagamento"],"properties":{"id_cliente":{"type":"string","format":"uuid","description":"id do cliente","example":"123e4567-e89b-12d3-a456-426614174000"},"numero":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da venda"},"children":[]}]}]}],"example":1001},"situacao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situação da venda"},"children":[]}]}]}],"example":"EM_ANDAMENTO","enum":["EM_ANDAMENTO","APROVADO"]},"data_venda":{"type":"string","format":"date","description":"Data da venda","example":"2023-12-31"},"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":"40bbdaa5-65c2-49e9-b892-470fd1093ed3"},"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 sobre a venda"},"children":[]}]}]}],"example":"Observações sobre a venda"},"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 sobre o pagamento"},"children":[]}]}]}],"example":"Observações sobre o pagamento"},"itens":{"type":"array","items":{"$ref":"#/components/schemas/ItemVendaRequest"}},"composicao_de_valor":{"$ref":"#/components/schemas/ValorComposicaoRequest"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamentoRequest"}}}},"components/schemas/ItemVendaRequest":{"id":"components/schemas/ItemVendaRequest","kind":"json-schema","title":"ItemVendaRequest","data":{"type":"object","required":["id","quantidade","valor"],"properties":{"descricao":{"type":"string","example":"Produto A","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição do item da venda"},"children":[]}]}]}]},"quantidade":{"type":"number","format":"double","example":2,"description":"Quantidade do item da venda"},"valor":{"type":"number","format":"double","example":50,"description":"Valor do item da venda"},"id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"id do item da venda"},"valor_custo":{"type":"number","format":"double","example":40,"description":"Valor de custo do item da venda."},"itens_kit":{"type":"array","items":{"$ref":"#/components/schemas/ItemKitRequest"}}}}},"components/schemas/ItemKitRequest":{"id":"components/schemas/ItemKitRequest","kind":"json-schema","title":"ItemKitRequest","data":{"type":"object","required":["id_produto","id_kit","quantidade","valor"],"properties":{"id_produto":{"type":"string","format":"uuid","example":"568e8400-e29b-41d4-a716-446655440000","description":"id do produto que pertence ao kit"},"id_kit":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id do kit que contém o produto"},"children":[]}]}]}]},"quantidade":{"type":"number","format":"double","example":2,"description":"Quantidade dos itens do kit"},"valor":{"type":"number","format":"double","example":50,"description":"Valor dos itens do kit"}}}},"components/schemas/ValorComposicaoRequest":{"id":"components/schemas/ValorComposicaoRequest","kind":"json-schema","title":"ValorComposicaoRequest","data":{"type":"object","properties":{"frete":{"type":"number","format":"double","example":100,"description":"Valor de frete."},"desconto":{"$ref":"#/components/schemas/DiscountMonolithTranslatedDTO"}}}},"components/schemas/CondicaoPagamentoRequest":{"id":"components/schemas/CondicaoPagamentoRequest","kind":"json-schema","title":"CondicaoPagamentoRequest","data":{"type":"object","required":["opcao_condicao_pagamento","parcelas"],"properties":{"tipo_pagamento":{"type":"string","description":"Forma de pagamento","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"],"example":"CARTAO_CREDITO"},"id_conta_financeira":{"type":"string","format":"uuid","example":"567e8400-e29b-41d4-a716-446655440000","description":"id da conta financeira"},"opcao_condicao_pagamento":{"type":"string","example":"À vista","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deve ser em um dos três formatos: - 1º: Ex: À vista. - 2º: Ex1: 30, 60, 90. Ex2: 15, 30, 45. - 3º: Ex1: 3x. Ex2: 12x"},"children":[]}]}]}]},"nsu":{"type":"string","example":"1234567890","description":"NSU"},"parcelas":{"type":"array","items":{"$ref":"#/components/schemas/ParcelaRequest"}}}}},"components/schemas/ParcelaRequest":{"id":"components/schemas/ParcelaRequest","kind":"json-schema","title":"ParcelaRequest","data":{"type":"object","required":["data_vencimento","valor"],"properties":{"data_vencimento":{"type":"string","format":"date","example":"2023-12-31","description":"Data de vencimento"},"valor":{"type":"number","format":"double","example":100,"description":"Valor da parcela"},"descricao":{"type":"string","example":"Parcela 1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[]}]}]}]}}}},"components/schemas/CriacaoVendaResponse":{"id":"components/schemas/CriacaoVendaResponse","kind":"json-schema","title":"CriacaoVendaResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id único da venda"},"children":[]}]}]}],"example":"123e4567-e89b-12d3-a456-426614174000"},"id_legado":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id legado necessário para a venda"},"children":[]}]}]}],"example":123456},"id_cliente":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id do cliente associado à venda"},"children":[]}]}]}],"example":"123e4567-e89b-12d3-a456-426614174001"},"numero":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da venda"},"children":[]}]}]}],"example":1001},"origem":{"type":"string","description":"Origem da venda","example":"Online"},"id_categoria":{"type":"string","format":"uuid","description":"id da categoria da venda","example":"123e4567-e89b-12d3-a456-426614174002"},"data_venda":{"type":"string","format":"date-time","description":"Data da venda","example":"2023-10-01T12:00:00Z"},"situacao":{"$ref":"#/components/schemas/SituacaoResponse"},"pendencia":{"$ref":"#/components/schemas/TipoPendenciaResponse"},"valor_composicao":{"$ref":"#/components/schemas/ComposicaoValorResponse"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamentoResponse"},"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 sobre a venda"},"children":[]}]}]}],"example":"Cliente solicitou entrega rápida"},"id_vendedor":{"type":"string","format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id do vendedor responsável pela venda"},"children":[]}]}]}],"example":"123e4567-e89b-12d3-a456-426614174003"},"versao":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versão da venda"},"children":[]}]}]}],"example":1}}}},"components/schemas/SituacaoResponse":{"id":"components/schemas/SituacaoResponse","kind":"json-schema","title":"SituacaoResponse","data":{"type":"object","properties":{"nome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da situação"},"children":[]}]}]}],"example":"Situação Exemplo"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da situação"},"children":[]}]}]}],"example":"Descrição da situação exemplo"}}}},"components/schemas/TipoPendenciaResponse":{"id":"components/schemas/TipoPendenciaResponse","kind":"json-schema","title":"TipoPendenciaResponse","data":{"type":"object","properties":{"nome":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nome da pendência"},"children":[]}]}]}],"example":"AGUARDANDO_CONFIRMACAO"},"descricao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da pendência"},"children":[]}]}]}],"example":"Aguardando confirmação"}}}},"components/schemas/ComposicaoValorResponse":{"id":"components/schemas/ComposicaoValorResponse","kind":"json-schema","title":"ComposicaoValorResponse","data":{"type":"object","properties":{"valor_bruto":{"type":"number","format":"double","description":"Valor bruto da venda","example":100},"desconto":{"$ref":"#/components/schemas/DiscountMonolithTranslatedDTO"},"frete":{"type":"number","format":"double","description":"Valor do frete","example":10},"valor_liquido":{"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 líquido da venda"},"children":[]}]}]}],"example":90}}}},"components/schemas/DiscountMonolithTranslatedDTO":{"id":"components/schemas/DiscountMonolithTranslatedDTO","kind":"json-schema","title":"DiscountMonolithTranslatedDTO","data":{"type":"object","required":["tipo","valor"],"properties":{"tipo":{"type":"string","description":"Tipo de desconto","example":"VALOR","enum":["PORCENTAGEM","VALOR"]},"valor":{"type":"number","format":"double","description":"Valor do desconto","example":5}}}},"components/schemas/CondicaoPagamentoResponse":{"id":"components/schemas/CondicaoPagamentoResponse","kind":"json-schema","title":"CondicaoPagamentoResponse","data":{"type":"object","properties":{"id_legado":{"type":"integer","format":"int64","example":123456789,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id legado da condição de pagamento"},"children":[]}]}]}]},"tipo_pagamento":{"type":"string","example":"CARTAO_CREDITO","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","LINK_PAGAMENTO","PIX_PAGAMENTO_INSTANTANEO","COBRANCA_PIX","PROGRAMA_FIDELIDADE","SEM_PAGAMENTO","TRANSFERENCIA_BANCARIA","VALE_ALIMENTACAO","VALE_COMBUSTIVEL","VALE_PRESENTE","VALE_REFEICAO"]},"id_conta_financeira":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"id da conta financeira"},"opcao_condicao_pagamento":{"type":"string","example":"Parcelado","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opção de condição de pagamento"},"children":[]}]}]}]},"parcelas":{"type":"array","items":{"$ref":"#/components/schemas/ParcelaResponse"}},"observacoes_pagamento":{"type":"string","example":"Pagamento realizado em 3 parcelas","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observações sobre o pagamento"},"children":[]}]}]}]},"nsu":{"type":"string","example":"1234567890","description":"NSU"},"troco_total":{"type":"number","format":"double","example":10.5,"description":"Troco total"}}}},"components/schemas/ParcelaResponse":{"id":"components/schemas/ParcelaResponse","kind":"json-schema","title":"ParcelaResponse","data":{"type":"object","properties":{"data_vencimento":{"type":"string","format":"date","example":"2023-12-31","description":"Data de vencimento"},"valor":{"type":"number","format":"double","example":100,"description":"Valor da parcela"},"descricao":{"type":"string","example":"Parcela 1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Descrição da parcela"},"children":[]}]}]}]},"numero":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da parcela"},"children":[]}]}]}]}}}},"components/schemas/ExclusaoResponse":{"id":"components/schemas/ExclusaoResponse","kind":"json-schema","title":"ExclusaoResponse","data":{"type":"object","properties":{"atualizados":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indica quantidade excluída"},"children":[]}]}]}],"example":1},"ignorados":{"type":"integer","description":"Indica quantidade ignorada","example":1}}}},"components/schemas/VendaParaEdicaoRequest":{"id":"components/schemas/VendaParaEdicaoRequest","kind":"json-schema","title":"VendaParaEdicaoRequest","data":{"type":"object","required":["versao","id_cliente","numero","situacao","data_venda","itens","condicao_pagamento"],"properties":{"id_cliente":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":"uuid do cliente"},"id_vendedor":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"ID do vendedor"},"numero":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Número da venda"},"children":[]}]}]}]},"data_venda":{"type":"string","format":"date","example":"2023-12-31","description":"Data da venda"},"situacao":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Situação da venda"},"children":[]}]}]}],"example":"APROVADO","enum":["EM_ANDAMENTO","APROVADO","FATURADO","CANCELADO"]},"observacoes":{"type":"string","example":"Cliente solicitou entrega rápida","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observações sobre a venda"},"children":[]}]}]}]},"observacoes_pagamento":{"type":"string","example":"Pagamento realizado em 3 parcelas","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observações sobre o pagamento"},"children":[]}]}]}]},"id_natureza_operacao":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"id da natureza da operação"},"children":[]}]}]}]},"versao":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versão da venda é obrigatório na edição"},"children":[]}]}]}]},"itens":{"type":"array","$ref":"#/components/schemas/ItemVendaRequest"},"composicao_de_valor":{"$ref":"#/components/schemas/ValorComposicaoRequest"},"condicao_pagamento":{"$ref":"#/components/schemas/CondicaoPagamentoRequest"}}}},"components/schemas/VendaEditadaResponse":{"id":"components/schemas/VendaEditadaResponse","kind":"json-schema","title":"VendaEditadaResponse","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"uuid da venda editada"},"id_legado":{"type":"integer","example":123456,"description":"id legado"}}}},"components/schemas/Vendedor":{"id":"components/schemas/Vendedor","kind":"json-schema","title":"Vendedor","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"id do vendedor"},"nome":{"type":"string","example":"João da Silva","description":"Nome do vendedor"},"id_legado":{"type":"integer","example":123456,"description":"id legado do vendedor"}}}},"components/schemas/Contrato":{"id":"components/schemas/Contrato","kind":"json-schema","title":"Contrato","data":{"type":"object","properties":{"uuid":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000","description":"id do contrato"},"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 do contrato"},"children":[]}]}]}],"example":"2023-12-31"},"data_fim":{"type":"string","format":"date","description":"Data final do contrato","example":"2024-12-31"},"dia_vencimento":{"type":"integer","example":10,"description":"Dia do vencimento de cada fatura gerada pelo contrato"},"periodo":{"type":"string","example":"MENSAL","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Período de faturamento do contrato"},"children":[]}]}]}],"enum":["MENSAL","SEMANAL","ANUAL"]},"periodicidade":{"type":"integer","example":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Periodicidade do contrato, ou seja, a cada quantos períodos será gerada uma fatura. Exemplo: periodicidade 2 e período MENSAL significa que a fatura será gerada a cada 2 meses."},"children":[]}]}]}]}}}},"schema_210":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Vendedor"}},"id":"schema_210"},"schema_211":{"kind":"json-schema","data":{"type":"string"},"id":"schema_211"},"schema_212":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_212"},"schema_213":{"kind":"json-schema","data":{"enum":[10,20,50,100,200,500,1000],"type":"integer"},"id":"schema_213"},"schema_214":{"kind":"json-schema","data":{"type":"string","enum":["NUMERO","CLIENTE","DATA"]},"id":"schema_214"},"schema_215":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Termo para busca das vendas por nome, email do cliente ou número da venda"},"children":[]}]}]}]},"id":"schema_215"},"schema_216":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2023-12-30"},"id":"schema_216"},"schema_217":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2023-12-31"},"id":"schema_217"},"schema_218":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_218"},"schema_219":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_219"},"schema_220":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_220"},"schema_221":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer"}},"id":"schema_221"},"schema_222":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_222"},"schema_223":{"kind":"json-schema","data":{"oneOf":[{"type":"string","format":"uuid"},{"type":"integer"}]},"id":"schema_223"},"schema_224":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_224"},"schema_225":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_225"},"schema_226":{"kind":"json-schema","data":{"type":"integer","format":"int64","nullable":true,"example":4512645},"id":"schema_226"}},"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/sales-apis-openapi","isMockServer":true,"description":"Mock server"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/sales-apis-openapi","position":"last","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/sales-apis-openapi.json?download"},{"url":"/_bundle/docs/sales-apis-openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Vendas","description":"A API de Vendas (v1) permite que sistemas externos integrem funcionalidades de vendas diretamente com o ERP da Conta Azul. Com ela, é possível criar, atualizar, consultar e excluir vendas, bem como recuperar informações detalhadas sobre os itens das vendas e gerar documentos associados, como PDFs de vendas.\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[https://ajuda.contaazul.com/hc/pt-br/sections/19712754054285-Controle-de-vendas](https://ajuda.contaazul.com/hc/pt-br/sections/19712754054285-Controle-de-vendas)\n"}},"baseSlug":"/docs/sales-apis-openapi","routesMapping":{}}