openapi: 3.0.1 info: title: Baixas v1 API version: v1 description: "A API de Baixas tem como objetivo automatizar e simplificar o processo de conciliação financeira, permitindo o registro e o acompanhamento de pagamentos recebidos. Com ela, é possível criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa, deletar uma baixa e retornar a baixa, garantindo que o status financeiro das cobranças seja atualizado de maneira precisa e em tempo real, reduzindo o retrabalho e evitando inconsistências entre sistemas.\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**Lançamentos Financeiros:** \n[https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar](https://ajuda.contaazul.com/hc/pt-br/sections/20564397198989-Lan%C3%A7amentos-financeiros-contas-a-receber-e-a-pagar)\n" servers: - url: https://api-v2.contaazul.com description: Servidor de produção security: - BearerAuth: [] tags: - name: v1 description: Conjunto de recursos para acompanhar e administrar operações relacionadas ao gerenciamento de baixas - esses recursos incluem criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa por id, deletar baixa por id e retornar a baixa por id paths: /v1/financeiro/eventos-financeiros/parcelas/{parcela_id}/baixa: post: summary: Criar uma nova baixa operationId: criarBaixa description: Permite registrar uma nova baixa vinculada a uma parcela específica. Por meio desse endpoint, é possível informar os dados do pagamento, como data, valor, juros, multa, descontos e método de pagamento. Ao registrar a baixa, o sistema atualiza automaticamente o status da parcela refletindo a quitação realizada. tags: - v1 parameters: - name: parcela_id in: path required: true schema: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BaixaCriacaoRequestDTO' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaixaCriacaoResponseDTO' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error get: summary: Retornar as baixas pelo id da parcela operationId: listarBaixas description: Permite consultar todas as baixas associadas a uma determinada parcela. Essa funcionalidade possibilita o acompanhamento detalhado de pagamentos realizados, facilitando a auditoria e o controle financeiro. tags: - v1 parameters: - name: parcela_id in: path required: true schema: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/BaixaResponseDTO' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/parcelas/baixa/{baixa_id}: patch: summary: Atualizar parcialmente uma baixa por id operationId: atualizarBaixa description: Permite atualizar parcialmente as informações de uma baixa. Use a baixa parcial quando houver pagamento ou recebimento parcial de uma fatura, seja por negociação com cliente/fornecedor ou em situações de inadimplência parcial. Por meio desse endpoint, é possível corrigir dados como valor, conta financeira, data de pagamento ou observações, mantendo o controle de versão para evitar conflitos de atualização. tags: - v1 parameters: - name: baixa_id in: path required: true schema: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BaixaAtualizacaoRequestDTO' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaixaCriacaoResponseDTO' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error delete: summary: Deletar baixa por id operationId: deletarBaixa description: Permite excluir uma baixa existente do sistema. Esse endpoint deve ser utilizado com cautela, pois a exclusão impacta diretamente o saldo e o histórico financeiro da parcela associada. tags: - v1 parameters: - name: baixa_id in: path required: true schema: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error get: summary: Retornar a baixa por id operationId: buscarBaixa description: Permite consultar os detalhes de uma baixa específica a partir do seu identificador único (baixa_id). O retorno inclui informações completas sobre a baixa, como data de pagamento, valores envolvidos, conta financeira utilizada, método de pagamento e observações registradas. tags: - v1 parameters: - name: baixa_id in: path required: true schema: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BaixaResponseDTO' '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/contas-a-receber/cobranca/{id_cobranca}: get: summary: Retornar a cobrança por id operationId: buscarCobrancaPorId description: Permite consultar os detalhes de uma cobrança específica utilizando seu identificador único (id_cobranca). tags: - v1 parameters: - name: id_cobranca in: path required: true schema: type: string format: uuid description: Identificador único da cobrança responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GerarCobrancaResponseDto' '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error delete: summary: Deletar cobrança por id operationId: deletarCobrancaPorId description: Permite cancelar uma cobrança existente identificada por id_cobranca. É recomendada apenas quando a cobrança foi gerada incorretamente ou precisa ser invalidada antes de seu pagamento. tags: - v1 parameters: - name: id_cobranca in: path required: true schema: type: string format: uuid description: Identificador único da cobrança responses: '200': description: OK '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/contas-a-receber/gerar-cobranca: post: summary: Criar uma nova cobrança operationId: criarCobranca description: Permite criar uma nova cobrança, por meio desse endpoint, é possível informar o valor, data de vencimento, descrição da fatura e demais parâmetros que definem a cobrança. Essa funcionalidade facilita a geração automatizada de cobranças. tags: - v1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GerarCobrancaRequestDto' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GerarCobrancaResponseDto' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/contratos: post: summary: Criar um novo contrato operationId: criarContrato description: Permite criar um novo contrato, definindo as informações necessárias para configuração da recorrência, como período, produtos/serviços vinculados e demais parâmetros do contrato. tags: - v1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ContratoToCreateRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContratoToCreateResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error get: summary: Retornar os contratos por filtro operationId: listarContratos description: Permite consultar contratos existentes, com suporte a filtros que facilitam a busca e a gestão dos contratos criados (ex. por cliente, data, status, entre outros). tags: - v1 parameters: - in: query name: pagina description: Página example: 1 schema: type: number default: 1 - in: query name: tamanho_pagina description: Tamanho da página (máximo 50) example: 10 schema: type: number default: 10 - in: query name: campo_ordenado_ascendente description: Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. schema: type: string enum: - DATA_INICIO - DATA_FIM example: DATA_INICIO - in: query name: campo_ordenado_descendente description: Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. schema: type: string enum: - DATA_INICIO - DATA_FIM example: DATA_INICIO - in: query name: busca_textual description: Busca textual por nome example: Contrato 1 schema: type: string required: false - in: query name: cliente_id description: id do cliente schema: type: string format: uuid - in: query name: data_inicio description: Data inicio do intervalo de busca example: '2026-08-15' required: true schema: type: string format: date - in: query name: data_fim description: Data fim do intervalo de busca example: '2027-08-15' required: true schema: type: string format: date responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListagemContratoResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/contratos/proximo-numero: get: summary: Retornar o próximo número do contrato disponível operationId: getNextContractNumber description: Permite consultar o próximo número de contrato a ser utilizado no momento da criação. tags: - v1 responses: '200': description: OK content: application/json: schema: type: integer format: int64 nullable: true example: 4512645 '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/centro-de-custo: summary: Endpoint de Centros de Custo get: summary: Retornar os centros de custo por filtro operationId: searchCostCenters tags: - v1 description: Permite consultar os centros de custo cadastrados. Suporta filtros como página, tamanho de página, busca por texto, status (ativo/inativo/todos) e ordenação. Utilizado para consultar lançamentos financeiros e facilitar análise orçamentária. parameters: - in: query name: pagina description: Página example: 1 schema: type: number required: true - in: query name: tamanho_pagina description: Tamanho da página example: 10 schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: number required: true - in: query name: busca description: Busca textual por nome ou código example: '010' schema: type: string required: false - in: query name: filtro_rapido description: Filtro rápido para itens ativos, inativos ou todos example: ATIVO schema: type: string enum: - ATIVO - INATIVO - TODOS required: false - in: query name: campo_ordenado_ascendente description: Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por nome ou por código example: nome schema: type: string required: false - in: query name: campo_ordenado_descendente description: Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por nome ou por código example: nome schema: type: string required: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CentroDeCustoResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error post: summary: Criar um novo centro de custo operationId: createCostCenter tags: - v1 description: Permite criar um novo centro de custo, definindo campos como código, nome, parâmetros que ajudam a organizar os custos da empresa de forma estruturada. requestBody: description: Dados do centro de custo a ser criado required: true content: application/json: schema: $ref: '#/components/schemas/CriacaoCentroDeCustoRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CentroDeCusto' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/{id_evento}/parcelas: summary: Endpoint de parcelas por evento financeiro get: summary: Retornar as parcelas pelo id do evento financeiro operationId: getInstallmentsByEventId description: Permite listar as parcelas vinculadas a um evento financeiro específico (id_evento). Útil para acompanhar cada parcela de um lançamento de contas a pagar ou receber, com seus valores, vencimentos e status e outras informações pertinentes. tags: - v1 parameters: - name: id_evento in: path description: uuid ou id legado do evento example: 35473eec-4e74-11ee-b500-9f61de8a8b8b required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Parcela' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/categorias: summary: Endpoint de Categorias get: summary: Retornar as categorias por filtro operationId: searchCategories tags: - v1 description: Permite listar as categorias utilizadas para classificação de receitas ou despesas. Auxilia no controle, agrupamento e geração de relatórios financeiros baseados em categorias. parameters: - in: query name: pagina description: Página example: 1 schema: type: number required: true - in: query name: tamanho_pagina description: Tamanho da página example: 10 schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: number required: true - in: query name: campo_ordenado_ascendente description: Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por 'NOME' ou 'TIPO' example: NOME schema: type: string enum: - NOME - TIPO required: false - in: query name: campo_ordenado_descendente description: Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por 'NOME' ou 'TIPO' example: TIPO schema: type: string enum: - NOME - TIPO required: false - in: query name: busca description: Busca textual por nome ou código example: '010' schema: type: string required: false - in: query name: tipo description: Tipo da categoria example: RECEITA schema: type: string enum: - RECEITA - DESPESA required: false - in: query name: apenas_filhos description: Filtrar apenas categorias filhas example: true schema: type: boolean required: false - in: query name: nome description: Nome da categoria example: Eletrônicos schema: type: string required: false - in: query name: permite_apenas_filhos description: Permite apenas categorias filhas example: true schema: type: boolean required: true responses: '200': description: OK content: application/json: schema: type: object properties: itens_totais: type: integer example: 6 itens: type: array items: $ref: '#/components/schemas/Categoria' totais: $ref: '#/components/schemas/Totais' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/categorias/configuracao-padrao: summary: Configuração padrão de categorias get: summary: Retornar a configuração de de-para de categorias operationId: getDefaultCategoryConfig tags: - v1 description: Retorna o de-para entre as operações financeiras e as categorias configuradas para o tenant, incluindo opcionalmente a sugestão padrão de categoria para cada operação. parameters: - in: query name: sugestao_padrao description: Quando verdadeiro (padrão), inclui o objeto `sugestao_padrao` em cada item. Quando falso, o campo `sugestao_padrao` é retornado como `null`. example: true schema: type: boolean default: true required: false responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/ConfiguracaoPadraoCategoria' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/categorias-dre: get: summary: Retornar as categorias DRE operationId: searchDreCategories description: Permite listar as categorias de DRE (Demonstração do Resultado do Exercício) usadas para a estrutura contábil-financeira da empresa, facilitando o fechamento financeiro e contábil. tags: - v1 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EstruturaDRE' '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/conta-financeira: summary: Endpoint de Contas Financeiras get: summary: Retornar as contas financeiras por filtro operationId: searchFinancialAccounts tags: - v1 description: Permite consultar as contas financeiras existentes no sistema (contas bancárias, cartões, poupança, etc.). Suporta filtros como tipo de conta, nome, se estão ativas, entre outros. parameters: - name: pagina in: query description: Página required: false example: 1 schema: type: integer default: 1 - name: tamanho_pagina in: query description: Tamanho da página example: 10 schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: integer required: false - name: tipos in: query description: Lista de tipos de conta example: APLICACAO required: false schema: type: array items: type: string enum: - APLICACAO - CAIXINHA - CONTA_CORRENTE - CARTAO_CREDITO - INVESTIMENTO - OUTROS - MEIOS_RECEBIMENTO - POUPANCA - COBRANCAS_CONTA_AZUL - RECEBA_FACIL_CARTAO - name: nome in: query description: Nome da conta example: Conta corrente required: false schema: type: string - name: apenas_ativo in: query description: Filtrar apenas contas ativas example: true required: false schema: type: boolean - name: esconde_conta_digital in: query description: Esconder contas digitais example: true required: false schema: type: boolean - name: mostrar_caixinha in: query description: Mostrar contas de caixinha example: true required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: type: object properties: itens_totais: type: integer example: 6 itens: type: array items: $ref: '#/components/schemas/ContaFinanceira' totais: $ref: '#/components/schemas/Totais' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/conta-financeira/{id_conta_financeira}/saldo-atual: summary: Endpoint de saldo atual da conta financeira get: summary: Retornar o saldo atual pelo id da conta financeira operationId: searchBalanceByFinancialAccountId tags: - v1 description: Permite obter o saldo atual de uma conta financeira específica identificada por id_conta_financeira. Útil para monitoramento em tempo real de saldos das contas da empresa. parameters: - name: id_conta_financeira in: path description: uuid da conta financeira example: 35473eec-4e74-11ee-b500-9f61de8a8b8b required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SaldoAtualResponse' '400': description: Bad Request content: application/json: schema: type: object properties: code: type: integer example: 400 message: type: string example: O valor 'fbbccb85-a71a-4dfdb699-56ac1b5f1115' fornecido no parâmetro 'id_conta_financeira' não é um identificador (uuid) válido. example: code: 400 message: O valor 'fbbccb85-a71a-4dfdb699-56ac1b5f1115' fornecido no parâmetro 'id_conta_financeira' não é um identificador (uuid) válido. '401': description: Unauthorized content: application/json: schema: type: object properties: code: type: integer example: 401 message: type: string example: The Token has expired. example: code: 401 message: The Token has expired. '429': description: Too Many Requests '500': description: Internal Server Error content: application/json: schema: type: object properties: code: type: integer example: 500 message: type: string example: Ocorreu um erro inesperado no servidor. Tente novamente mais tarde. example: code: 500 message: Ocorreu um erro inesperado no servidor. Tente novamente mais tarde. /v1/financeiro/transferencias: summary: Endpoint de Transferências entre Contas Financeiras get: summary: Retornar as transferências entre contas financeiras por filtro operationId: searchAccountingExportTransfers tags: - v1 description: Permite consultar as transferências realizadas entre contas financeiras mediante filtros como período de datas e contas financeiras específicas. Para viabilizar a conciliação financeira automática e sincronizar corretamente as movimentações no meu sistema. parameters: - name: pagina in: query description: Número da página para paginação dos resultados example: 1 required: false schema: type: integer default: 1 minimum: 1 - name: tamanho_pagina in: query description: Quantidade de itens por página example: 10 required: false schema: type: integer default: 10 enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 - name: ids_conta_financeira in: query description: Lista de identificadores (UUIDs) das contas financeiras para filtrar as transferências. Retorna transferências onde as contas especificadas sejam origem ou destino. example: - 35473eec-4e74-11ee-b500-9f61de8a8b8b - 8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f required: false schema: type: array items: type: string format: uuid - name: data_inicio in: query description: Data inicial do período para filtrar as transferências (formato ISO date) example: '2026-01-01' required: false schema: type: string format: date - name: data_fim in: query description: Data final do período para filtrar as transferências (formato ISO date) example: '2026-12-31' required: false schema: type: string format: date responses: '200': description: OK - Retorna a lista paginada de transferências entre contas financeiras content: application/json: schema: $ref: '#/components/schemas/TransferenciaContaFinanceiraResponse' examples: exemplo_sucesso: summary: Exemplo de resposta com transferências value: itens_totais: 2 itens: - id: 35473eec-4e74-11ee-b500-9f61de8a8b8b descricao: Transferência para conta poupança valor: 1500.5 data: '2026-02-15' origem: data: '2026-02-15' composicao_valor: valor_bruto: 1500.5 juros: 0 multa: 0 valor_liquido: 1500.5 desconto: 0 taxa: 0 conta_financeira: id: 8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f nome: Conta Corrente Principal instituicao_bancaria: codigo: 1 nome: Banco do Brasil destino: data: '2026-02-15' composicao_valor: valor_bruto: 1500.5 juros: 0 multa: 0 valor_liquido: 1500.5 desconto: 0 taxa: 0 conta_financeira: id: 7d1b2c34-8a5e-4f6d-b9c2-3e4f5a6b7c8d nome: Conta Poupança instituicao_bancaria: codigo: 1 nome: Banco do Brasil - id: 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d descricao: Transferência para investimento valor: 5000 data: '2026-02-20' origem: data: '2026-02-20' composicao_valor: valor_bruto: 5000 juros: 0 multa: 0 valor_liquido: 5000 desconto: 0 taxa: 0 conta_financeira: id: 8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f nome: Conta Corrente Principal instituicao_bancaria: codigo: 341 nome: Itaú destino: data: '2026-02-20' composicao_valor: valor_bruto: 5000 juros: 0 multa: 0 valor_liquido: 5000 desconto: 0 taxa: 0 conta_financeira: id: 6c5d4e3f-2a1b-9c8d-7e6f-5a4b3c2d1e0f nome: Conta Investimento instituicao_bancaria: codigo: 341 nome: Itaú exemplo_vazio: summary: Exemplo de resposta sem transferências value: itens_totais: 0 itens: [] '400': description: Bad Request - Parâmetros inválidos na requisição content: application/json: schema: type: object properties: code: type: integer example: 400 message: type: string example: A data de início não pode ser posterior à data de fim. examples: data_invalida: summary: Erro de validação de datas value: code: 400 message: A data de início não pode ser posterior à data de fim. uuid_invalido: summary: Erro de UUID inválido value: code: 400 message: O valor fornecido no parâmetro 'ids_conta_financeira' não é um identificador (uuid) válido. '401': description: Unauthorized - Token de autenticação inválido ou expirado content: application/json: schema: type: object properties: code: type: integer example: 401 message: type: string example: The Token has expired. example: code: 401 message: The Token has expired. '429': description: Too Many Requests - Limite de requisições excedido '500': description: Internal Server Error - Erro interno no servidor content: application/json: schema: type: object properties: code: type: integer example: 500 message: type: string example: Ocorreu um erro inesperado no servidor. Tente novamente mais tarde. example: code: 500 message: Ocorreu um erro inesperado no servidor. Tente novamente mais tarde. /v1/financeiro/eventos-financeiros/contas-a-receber: post: summary: Criar um novo evento financeiro de contas a receber operationId: createReceivableFinancialEvent description: Permite criar um novo evento financeiro de contas a receber, passando dados como data de competência, valor, descrição, conta financeira, condições de pagamento, entre outros. Facilita o registro de receitas previstas ou realizadas. tags: - v1 requestBody: description: Dados do evento financeiro de contas a receber required: true content: application/json: schema: $ref: '#/components/schemas/EventoFinanceiroRequest' responses: '202': description: Evento financeiro de contas a receber criado com sucesso content: application/json: schema: $ref: '#/components/schemas/ProtocolResponseDTO' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/contas-a-receber/buscar: summary: Endpoint de Contas a Receber get: summary: Retornar as receitas por filtro operationId: searchInstallmentsToReceiveByFilter description: Permite consultar as parcelas de receitas (contas a receber) mediante filtros como data de vencimento, data de competência, data de pagamento, data de alteração, valor, status, dentre outros. Essa funcionalidade ajuda no controle e análise de entradas financeiras com base nas condições definidas. tags: - v1 parameters: - name: pagina in: query description: Página example: 1 required: true schema: type: integer default: 1 minimum: 1 - name: tamanho_pagina in: query description: Tamanho da página example: 10 schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: integer minimum: 1 required: true - name: campo_ordenado_ascendente in: query description: Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por nome required: false example: nome schema: type: string - name: campo_ordenado_descendente in: query description: Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por nome example: nome required: false schema: type: string - name: descricao in: query description: Descrição da conta example: Conta Corrente required: false schema: type: string - name: data_vencimento_de in: query description: Data de vencimento de (ISO date format) example: '2027-08-15' required: true schema: type: string format: date - name: data_vencimento_ate in: query description: Data de vencimento até (ISO date format) example: '2027-08-20' required: true schema: type: string format: date - name: data_competencia_de in: query description: Data de competência de (ISO date format) example: '2025-08-15' required: false schema: type: string format: date - name: data_competencia_ate in: query description: Data de competência até (ISO date format) example: '2025-08-20' required: false schema: type: string format: date - name: data_pagamento_de in: query description: Data de pagamento de (ISO date format) example: '2025-08-15' required: false schema: type: string format: date - name: data_pagamento_ate in: query description: Data de pagamento até (ISO date format) example: '2025-08-20' required: false schema: type: string format: date - name: data_alteracao_de in: query description: Data de alteração de (ISO 8601, São Paulo/GMT-3) example: '2025-10-20T07:00:00' required: false schema: type: string format: date-time - name: data_alteracao_ate in: query description: Data de alteração até (ISO 8601, São Paulo/GMT-3) example: '2025-10-20T07:59:59' required: false schema: type: string format: date-time - name: valor_de in: query description: Valor de example: '100' required: false schema: type: string pattern: ^[0-9]+(\.[0-9]{1,2})?$ example: '999.99' - name: valor_ate in: query description: Valor até example: '500' required: false schema: type: string pattern: ^[0-9]+(\.[0-9]{1,2})?$ example: '999.99' - name: status in: query description: Status da conta example: ATRASADO required: false schema: type: array items: type: string enum: - PERDIDO - RECEBIDO - EM_ABERTO - RENEGOCIADO - RECEBIDO_PARCIAL - ATRASADO - name: ids_contas_financeiras in: query description: Lista de IDs de contas financeiras required: false schema: type: array items: type: string - name: ids_categorias in: query description: Lista de IDs de categorias required: false schema: type: array items: type: string - name: ids_centros_de_custo in: query description: Lista de IDs de centros de custo required: false schema: type: array items: type: string - name: ids_clientes in: query description: Lista de IDs de clientes required: false schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContasAReceberResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/contas-a-pagar: post: summary: Criar um novo evento financeiro de contas a pagar operationId: createPayableFinancialEvent description: Permite criar um novo evento financeiro de contas a pagar, informando dados como valor, condições de pagamento, descrição, conta financeira, entre outros. Esse endpoint facilita o registro das obrigações financeiras da empresa. tags: - v1 requestBody: description: Dados do evento financeiro de contas a pagar required: true content: application/json: schema: $ref: '#/components/schemas/EventoFinanceiroRequest' responses: '202': description: Evento financeiro de conta a pagar criado com sucesso content: application/json: schema: $ref: '#/components/schemas/ProtocolResponseDTO' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/contas-a-pagar/buscar: get: summary: Retornar as despesas por filtro operationId: searchInstallmentsToPayByFilter description: Permite consultar as parcelas de despesas (contas a pagar) conforme filtros como data de vencimento, data competência, data de alteração, valor, status, conta financeira, etc. Essa consulta possibilita monitorar as obrigações financeiras pendentes ou pagas, favorecendo a gestão e o planejamento. tags: - v1 parameters: - name: pagina in: query description: Página example: 1 required: true schema: type: integer default: 1 minimum: 1 - name: tamanho_pagina in: query description: Tamanho da página example: 10 required: true schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: integer minimum: 1 - name: campo_ordenado_ascendente in: query required: false description: Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por id do centro de custo (id), pelo código (CODIGO), pelo nome (NOME) e por ativo (ATIVO) example: nome schema: type: string enum: - ID - CODIGO - NOME - ATIVO - name: campo_ordenado_descendente in: query required: false description: Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por id do centro de custo (id), pelo código (CODIGO), pelo nome (NOME) ou por ativo (ATIVO) example: nome schema: type: string enum: - ID - CODIGO - NOME - ATIVO - name: descricao in: query description: Descrição da conta example: Pagamento do salário required: false schema: type: string - name: data_vencimento_de in: query description: Date de vencimento de (ISO date format) example: '2027-08-15' required: true schema: type: string format: date - name: data_vencimento_ate in: query description: Data de vencimento até (ISO date format) example: '2027-08-20' required: true schema: type: string format: date - name: data_competencia_de in: query description: Data de competência de (ISO date format) example: '2025-08-15' required: false schema: type: string format: date - name: data_competencia_ate in: query description: Data de competência até (ISO date format) example: '2025-08-20' required: false schema: type: string format: date - name: data_pagamento_de in: query description: Data de pagamento de (ISO date format) example: '2025-08-15' required: false schema: type: string format: date - name: data_pagamento_ate in: query description: Data de pagamento até (ISO date format) example: '2025-08-20' required: false schema: type: string format: date - name: data_alteracao_de in: query description: Data de alteração de (ISO 8601, São Paulo/GMT-3) example: '2025-10-20T07:00:00' required: false schema: type: string format: date-time - name: data_alteracao_ate in: query description: Data de alteração até (ISO 8601, São Paulo/GMT-3) example: '2025-10-20T07:59:59' required: false schema: type: string format: date-time - name: valor_de in: query description: Valor de example: '100' required: false schema: type: string pattern: ^[0-9]+(\.[0-9]{1,2})?$ example: '110.10' - name: valor_ate in: query description: Valor até example: '500' required: false schema: type: string pattern: ^[0-9]+(\.[0-9]{1,2})?$ example: '110.10' - name: status in: query description: Lista de status da conta example: ATRASADO required: false schema: type: array items: type: string enum: - PERDIDO - RECEBIDO - EM_ABERTO - RENEGOCIADO - RECEBIDO_PARCIAL - ATRASADO - name: ids_contas_financeiras in: query description: Lista de IDs de contas financeiras example: 35473eec-4e74-11ee-b500-9f61de8a8b8b required: false schema: type: array items: type: string - name: ids_categorias in: query description: Lista de IDs de categorias example: 35473eec-4e74-11ee-b500-9f61de8a8b8b required: false schema: type: array items: type: string - name: ids_centros_de_custo in: query description: Lista de IDs de centros de custo example: 35473eec-4e74-11ee-b500-9f61de8a8b8b required: false schema: type: array items: type: string responses: '200': description: OK content: application/json: schema: type: object properties: itens_totais: type: integer example: 6 itens: type: array items: $ref: '#/components/schemas/ContaAPagar' totais: type: object properties: ativo: type: integer example: 6 inativo: type: integer example: 0 todos: type: integer example: 6 '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/parcelas/{id}: summary: Endpoint de busca de parcelas por id get: summary: Retornar a parcela por id operationId: getInstallmentById description: Permite consultar os detalhes de uma parcela específica (de conta a receber ou a pagar) identificada pelo seu id. A resposta traz campos como data de vencimento, valor, status, conta financeira, entre outros. tags: - v1 parameters: - in: path name: id required: true schema: type: string format: uuid example: 9986f173-f531-4660-96ae-04b71c879264 description: Identificador único da parcela responses: '200': description: Informações da parcela retornadas com sucesso content: application/json: schema: $ref: '#/components/schemas/Parcela' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error patch: summary: Atualizar parcialmente uma parcela por id operationId: updateInstallment description: Permite atualizar parcialmente uma parcela existente identificada pelo id, alterando campos como data de vencimento, valor, observações, conta financeira e outros campos permitidos. Essa operação ajuda a ajustar lançamentos financeiros sem a necessidade de recriá-los. tags: - v1 parameters: - in: path name: id required: true schema: type: string format: uuid example: 9986f173-f531-4660-96ae-04b71c879264 requestBody: description: Campos aceitos para atualização da parcela required: true content: application/json: schema: $ref: '#/components/schemas/ParcelaAtualizacaoRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ParcelaAtualizacaoResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/alteracoes: summary: Endpoint de busca de IDs dos eventos financeiros alterados get: summary: Retornar os IDs dos eventos financeiros alterados em um período operationId: getAlteredFinancialEvents description: 'Permite consultar os IDs dos eventos financeiros (contas a pagar e a receber) que foram alterados em um período definido por data de ínico e fim. Essa funcionalidade é útil para identificar quais eventos sofreram modificações recentes, facilitando a sincronização e o monitoramento de mudanças nos dados financeiros. Importante: As informações disponíveis indicam a data e hora em que o evento foi salvo, sem detalhar quais campos foram modificados em cada operação. Salvar um recurso sem alterações reais pode gerar uma entrada no histórico e atualizar a data do último registro.' tags: - v1 parameters: - name: pagina in: query description: Página required: false example: 1 schema: type: integer default: 1 - name: tamanho_pagina in: query description: Tamanho da página required: false example: 10 schema: type: integer default: 10 - name: data_inicio in: query description: Data inicial do período para filtrar os eventos financeiros alterados (ISO 8601, São Paulo/GMT-3) example: '2026-01-01T23:59:59' required: true schema: type: string format: date-time - name: data_fim in: query description: Data final do período para filtrar os eventos financeiros alterados (ISO 8601, São Paulo/GMT-3) example: '2026-03-12T23:59:59' required: true schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: type: object properties: itens_totais: type: integer example: 1 itens: type: array items: $ref: '#/components/schemas/EventoFinanceiro' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/financeiro/eventos-financeiros/saldo-inicial: summary: Endpoint de busca dos saldos iniciais das contas financeiras get: summary: Retornar os saldos iniciais das contas financeiras operationId: getInitialBalancesOfFinancialAccounts description: Permite consultar os saldos iniciais das contas financeiras em um período definido por data de início e fim. tags: - v1 parameters: - name: pagina in: query description: Página required: false example: 1 schema: type: integer default: 1 - name: tamanho_pagina in: query description: Tamanho da página required: false example: 10 schema: type: integer default: 10 - name: data_inicio in: query description: Data inicial do período para filtrar os saldos iniciais (ISO 8601, São Paulo/GMT-3) example: '2026-01-01T23:59:59' required: true schema: type: string format: date-time - name: data_fim in: query description: Data final do período para filtrar os saldos iniciais (ISO 8601, São Paulo/GMT-3) example: '2026-03-12T23:59:59' required: true schema: type: string format: date-time responses: '200': description: OK content: application/json: schema: type: object properties: itens_totais: type: integer example: 1 itens: type: array items: $ref: '#/components/schemas/SaldoInicialContaFinanceira' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/produto/busca: get: summary: Obter produtos por filtro operationId: getProductsByFilter parameters: - name: pagina in: query required: false schema: type: integer default: 1 example: 1 - name: tamanho_pagina in: query required: false schema: type: integer default: 10 example: 10 - name: campo_ordenacao in: query required: false schema: type: string default: NOME enum: - NOME - CODIGO - VALOR_VENDA - ESTOQUE example: NOME - name: direcao_ordenacao in: query required: false description: Direção da ordenação (ASC para ascendente, DESC para descendente). schema: type: string default: ASC enum: - ASC - DESC - name: busca in: query required: false description: Buscar produtos por nome ou código. example: Produto schema: type: string - name: status in: query required: false description: Status do produto. schema: type: string enum: - ATIVO - INATIVO - TODOS default: TODOS - name: inicio in: query required: false schema: type: number example: 10.5 - name: fim in: query required: false schema: type: number example: 100.5 responses: '200': description: Resposta bem-sucedida content: application/json: schema: $ref: '#/components/schemas/ListagemDeProdutosPorFiltroResponse' tags: - v1 /v1/produto: post: summary: Criar um novo produto operationId: createProduct tags: - v1 requestBody: description: Ao cadastrar um novo produto, deve-se observar o formato. Caso seja VARIACAO, o item "variação" é obrigatório. required: true content: application/json: schema: $ref: '#/components/schemas/CriacaoProdutoRequest' responses: '200': description: Produto criado com sucesso content: application/json: schema: $ref: '#/components/schemas/ProdutoResponse' /v1/produto/{id}: delete: summary: Excluir um produto existente operationId: deleteProduct parameters: - name: id in: path required: true example: 123e4567-e89b-12d3-a456-426614174000 schema: type: string format: uuid responses: '204': description: Produto excluído com sucesso '404': description: Produto não encontrado tags: - v1 /v1/produto/desativar: post: summary: Desativar produtos description: Desativa uma lista de produtos pelo ID. operationId: deactivateProducts requestBody: required: true content: application/json: schema: type: array items: description: Lista de IDs dos produtos a serem desativados. type: string format: uuid example: - 123e4567-e89b-12d3-a456-426614174000 - 34471cce-67a2-48b8-a526-1120c0704ed3 responses: '200': description: Produtos desativados com sucesso. content: application/json: schema: $ref: '#/components/schemas/ProdutoDesativadoResponse' '400': description: Requisição inválida. '500': description: Erro interno do servidor. tags: - v1 /v1/orcamentos: get: security: - BearerAuth: [] description: Recupera a lista de orçamentos com base nos filtros informados. tags: - v1 summary: Retornar orçamentos por filtros operationId: listarOrcamentosPorFiltros parameters: - description: Número da página name: pagina in: query schema: type: integer default: 1 - description: Tamanho da página name: tamanho_pagina in: query schema: type: integer default: 10 - description: Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar pela data da venda (DATA), pelo número da venda (NUMERO) ou pelo nome do cliente (CLIENTE) name: campo_ordenado_ascendente in: query example: DATA schema: type: string enum: - DATA - NUMERO - CLIENTE - description: Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar pela data da venda (DATA), pelo número da venda (NUMERO) ou pelo nome do cliente (CLIENTE) name: campo_ordenado_descendente in: query example: DATA schema: type: string enum: - DATA - NUMERO - CLIENTE - description: Termo de busca name: termo_busca in: query schema: type: string - description: 'Data inicial (formato: YYYY-MM-DD)' name: data_inicio in: query schema: type: string - description: 'Data final (formato: YYYY-MM-DD)' name: data_fim in: query schema: type: string - description: 'Data de criação inicial (formato: YYYY-MM-DD)' name: data_criacao_de in: query schema: type: string - description: 'Data de criação final (formato: YYYY-MM-DD)' name: data_criacao_ate in: query schema: type: string - description: 'Data de alteração inicial (formato: YYYY-MM-DDThh:mm:ss)' name: data_alteracao_de in: query schema: type: string - description: 'Data de alteração final (formato: YYYY-MM-DDThh:mm:ss)' name: data_alteracao_ate in: query schema: type: string - description: IDs dos vendedores (UUID) name: ids_vendedores in: query explode: true schema: type: array items: type: string - description: IDs dos clientes (UUID) name: ids_clientes in: query explode: true schema: type: array items: type: string - description: IDs das naturezas de operação (UUID) name: ids_natureza_operacao in: query explode: true schema: type: array items: type: string - description: IDs das categorias (UUID) name: ids_categorias in: query explode: true schema: type: array items: type: string - description: IDs dos produtos (UUID) name: ids_produtos in: query explode: true schema: type: array items: type: string - description: Situações dos orçamentos name: situacoes in: query explode: true schema: type: array items: enum: - ORCAMENTO - ORCAMENTO_ACEITO - ORCAMENTO_RECUSADO type: string - description: Origens dos orçamentos name: origens in: query explode: true schema: type: array items: type: string - description: Números dos orçamentos name: numeros in: query explode: true schema: type: array items: type: integer - description: IDs legados dos donos name: ids_legado_donos in: query explode: true schema: type: array items: type: integer - description: IDs legados dos clientes name: ids_legado_clientes in: query explode: true schema: type: array items: type: integer - description: IDs legados dos produtos name: ids_legado_produtos in: query explode: true schema: type: array items: type: integer responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListagemOrcamentosPorFiltro' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' post: security: - BearerAuth: [] description: Cria um novo orçamento no sistema da Conta Azul. tags: - v1 summary: Criar um orçamento operationId: criarOrcamento requestBody: content: application/json: schema: $ref: '#/components/schemas/CriarOrcamento' description: Dados do orçamento a ser criado required: true responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/ResumoCriacaoOrcamento' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' delete: security: - BearerAuth: [] description: Permite excluir vários orçamentos de uma vez. Útil durante sincronizações ou processos de limpeza de dados. tags: - v1 summary: Excluir orçamentos em lote operationId: excluirOrcamentosEmLote requestBody: content: application/json: schema: $ref: '#/components/schemas/ExclusaoLoteOrcamento' description: IDs dos orçamentos a serem excluídos required: true responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' /v1/orcamentos/{id}: get: security: - BearerAuth: [] description: Recupera os detalhes de um orçamento específico por ID. Útil quando quiser exibir ou sincronizar todos os dados de um orçamento específico. tags: - v1 summary: Retornar o orçamento por ID operationId: obterOrcamentoPorID parameters: - description: ID do orçamento (UUID) name: id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Orcamento' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' /v1/protocolo/{id}: get: summary: Retornar o protocolo por id operationId: buscarProtocoloPorId description: Permite consultar os detalhes de um protocolo específico identificado por id. tags: - v1 parameters: - name: id in: path required: true example: 123e4567-e89b-12d3-a456-426614174000 schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ProtocolResponseDTO_2' '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/vendedores: get: summary: Retornar os vendedores operationId: listVendedores 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. tags: - v1 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Vendedor' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/{id}: get: summary: Retornar a venda por id operationId: getVendaById 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. tags: - v1 parameters: - name: id in: path required: true example: 123e4567-e89b-12d3-a456-426614174000 schema: type: string description: O legacy id ou uuid da venda a ser obtida responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ObterVendaResponse' '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error put: summary: Atualizar uma venda por id operationId: editSale description: Permite atualizar uma venda existente. Útil se sua aplicação permite editar vendas depois que foram criadas no ERP. tags: - v1 parameters: - name: id in: path required: true example: 123e4567-e89b-12d3-a456-426614174000 schema: type: string description: O uuid da venda a ser editada requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VendaParaEdicaoRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/VendaEditadaResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/busca: get: summary: Retornar as vendas por filtro operationId: searchVendas 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. tags: - v1 parameters: - name: pagina in: query required: false description: Página example: 1 schema: type: integer default: 1 - name: tamanho_pagina in: query required: false description: Tamanho da página example: 10 schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: integer - name: campo_ordenado_ascendente in: query required: false description: 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) example: numero schema: type: string enum: - NUMERO - CLIENTE - DATA - name: campo_ordenado_descendente in: query required: false description: 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) example: numero schema: type: string enum: - NUMERO - CLIENTE - DATA - name: termo_busca in: query required: false schema: type: string description: Termo para busca das vendas por nome, email do cliente ou número da venda - name: data_inicio in: query required: false schema: type: string format: date example: '2023-12-30' description: Data de início da emissão da venda - name: data_fim in: query required: false schema: type: string format: date example: '2023-12-30' description: Data final da emissão da venda - name: data_criacao_de in: query required: false schema: type: string format: date example: '2023-12-30' description: Data de início da criação da venda - name: data_criacao_ate in: query required: false schema: type: string format: date example: '2023-12-31' description: Data final da criação da venda - name: data_alteracao_de in: query description: Data de alteração de (ISO 8601, São Paulo/GMT-3) example: '2025-10-20T07:59:59' required: false schema: type: string format: date-time - name: data_alteracao_ate in: query description: Data de alteração até (ISO 8601, São Paulo/GMT-3) example: '2025-10-29T07:59:59' required: false schema: type: string format: date-time - name: ids_vendedores in: query required: false schema: type: array items: type: string format: uuid description: ids dos vendedores - name: ids_clientes in: query required: false schema: type: array items: type: string format: uuid description: ids dos clientes - name: ids_natureza_operacao in: query required: false schema: type: array items: type: string format: uuid description: ids da natureza da operação - name: situacoes in: query required: false schema: type: array items: type: string description: Situações das vendas - name: tipos in: query required: false schema: type: array items: type: string description: Tipos de vendas - name: origens in: query required: false schema: type: array items: type: string description: Origens das vendas - name: numeros in: query required: false schema: type: array items: type: integer description: Números das vendas - name: ids_categorias in: query required: false schema: type: array items: type: string format: uuid description: ids das categorias - name: ids_produtos in: query required: false schema: type: array items: type: string format: uuid description: ids dos produtos - name: pendente in: query required: false schema: type: boolean description: Indica se a venda está pendente - name: totais in: query required: false schema: type: string description: Tipo de total de venda. Possiveis valores `WAITING_APPROVED`, `APPROVED`, `CANCELED`, `ALL` - name: ids_legado_donos in: query required: false schema: type: array items: type: integer description: ids legados dos donos - name: ids_legado_clientes in: query required: false schema: type: array items: type: integer description: ids legados dos clientes - name: ids_legado_produtos in: query required: false schema: type: array items: type: integer description: ids legados dos produtos - name: ids_legado_categorias in: query required: false schema: type: array items: type: integer description: ids legados das categorias responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ListagemVendasResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda: post: summary: Criar uma nova venda operationId: createVenda description: Cria uma nova venda no sistema da Conta Azul. Ideal para registrar vendas vindas de sistemas externos diretamente no ERP da Conta Azul. tags: - v1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CriacaoVendaRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CriacaoVendaResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/{id}/imprimir: get: summary: Retornar o PDF de uma venda operationId: printVendaPdf 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. tags: - v1 parameters: - in: path name: id required: true example: 123e4567-e89b-12d3-a456-426614174000 schema: oneOf: - type: string format: uuid - type: integer description: id da venda a ser impressa, pode ser passado id ou uuid responses: '200': description: OK content: application/pdf: schema: type: string format: binary '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/exclusao-lote: post: summary: Excluir vendas em lote operationId: deleteVendasBatch 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. tags: - v1 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ExclusaoLote' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ExclusaoResponse' '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/{id_venda}/itens: get: summary: Retornar os itens de uma venda pelo id da venda operationId: getVendaItens 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. tags: - v1 parameters: - in: path name: id_venda required: true example: 123e4567-e89b-12d3-a456-426614174000 schema: type: string format: uuid description: id da venda - in: query name: pagina example: 1 schema: type: integer default: 1 description: Página - in: query name: tamanho_pagina example: 10 schema: enum: - 10 - 20 - 50 - 100 - 200 - 500 - 1000 type: integer description: Tamanho da página responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ItensPaginados' '400': description: Bad Request '401': description: Unauthorized '404': description: Not Found '429': description: Too Many Requests '500': description: Internal Server Error /v1/venda/proximo-numero: get: summary: Retornar o próximo número de venda disponível operationId: getNextVendaNumber 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. tags: - v1 responses: '200': description: OK content: application/json: schema: type: integer format: int64 nullable: true example: 4512645 '400': description: Bad Request '401': description: Unauthorized '429': description: Too Many Requests '500': description: Internal Server Error /v1/contratos/{id}: get: security: - BearerAuth: [] description: Recupera os detalhes de um contrato específico por ID. Útil quando quiser exibir ou sincronizar todos os dados de um contrato específico. tags: - v1 summary: Retornar o contrato por id operationId: obterContratoPorID parameters: - description: ID do contrato (UUID) name: id in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContratoResumo' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' delete: security: - BearerAuth: [] description: Remove um contrato existente. O contrato será excluído permanentemente, cancelando todas as vendas associadas (agendadas e efetivadas). Contratos em reajuste de valor não podem ser removidos. tags: - v1 summary: Remover um contrato operationId: removerContrato parameters: - description: ID do contrato (UUID) name: id in: path required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' /v1/contratos/{id}/encerrar: post: security: - BearerAuth: [] description: Encerra um contrato ativo. O contrato será desativado e não poderá mais gerar novas cobranças. Contratos que estão passando por reajuste de valor não podem ser encerrados. tags: - v1 summary: Encerrar um contrato operationId: encerrarContrato parameters: - description: ID do contrato (UUID) name: id in: path required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/ErroAPI' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErroAPI' components: schemas: CategoriaParcela: type: object description: Estrutura resumida de categoria enviada em itens de parcela properties: id: type: string format: uuid description: Identificador único da categoria example: b134ec6b-30f8-4edc-9a8f-4787fd3381ac nome: description: Nome da categoria type: string example: Adiantamento Salarial TipoDePagamento: description: Enum de tipo de pagamento type: string enum: - BOLETO_BANCARIO - CARTAO_CREDITO - CARTAO_DEBITO - CARTEIRA_DIGITAL - CASHBACK - CHEQUE - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - DINHEIRO - OUTRO - DEBITO_AUTOMATICO - LINK_PAGAMENTO - PIX_PAGAMENTO_INSTANTANEO - COBRANCA_PIX - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - TRANSFERENCIA_BANCARIA - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO x-enum-varnames: - PAYMENT_TYPE_BANKING_BILLET - PAYMENT_TYPE_CREDIT_CARD - PAYMENT_TYPE_DEBIT_CARD - PAYMENT_TYPE_DIGITAL_WALLET - PAYMENT_TYPE_CASHBACK - PAYMENT_TYPE_CHECK - PAYMENT_TYPE_STORE_CREDIT - PAYMENT_TYPE_VIRTUAL_CREDIT - PAYMENT_TYPE_BANKING_DEPOSIT - PAYMENT_TYPE_CASH - PAYMENT_TYPE_OTHER - PAYMENT_TYPE_AUTOMATIC_DEBIT - PAYMENT_TYPE_PAYMENT_LINK - PAYMENT_TYPE_INSTANT_PAYMENT - PAYMENT_TYPE_PIX_CHARGE - PAYMENT_TYPE_FIDELITY_PROGRAM - PAYMENT_TYPE_WITHOUT_PAYMENT - PAYMENT_TYPE_BANKING_TRANSFER - PAYMENT_TYPE_FOOD_VOUCHER - PAYMENT_TYPE_FUEL_VOUCHER - PAYMENT_TYPE_GIFT_VOUCHER - PAYMENT_TYPE_MEAL_VOUCHER BaixaCriacaoResponseDTO: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único gerado automaticamente após a criação versao: type: integer format: int64 example: 1 description: Versão da baixa data_pagamento: type: string format: date example: '2023-10-01' description: Data do pagamento composicao_valor: $ref: '#/components/schemas/ValorComposicaoDTO' conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da conta financeira metodo_pagamento: type: string example: CARTAO_CREDITO description: Método de pagamento enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO observacao: type: string example: 'Pagamento referente à fatura #1234.' description: Observação nsu: type: string example: '1234567890' description: Número sequencial único CriacaoVendaRequest: 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: Número da venda example: 1001 situacao: type: string description: Situação da venda 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: Observações sobre a venda example: Observações sobre a venda observacoes_pagamento: type: string description: Observações sobre o pagamento 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' EstoqueCriacaoProduto: type: object properties: valor_venda: description: Valor de venda do produto. type: number format: double example: 99.99 custo_medio: description: Valor de custo médio do produto. type: number format: double example: 50 estoque_disponivel: description: Quantidade de estoque disponível do produto. type: number format: double example: 50.5 estoque_minimo: description: Quantidade mínima de estoque do produto. type: number format: double example: 1 estoque_maximo: description: Quantidade máxima de estoque do produto. type: number format: double example: 100 LocalPrestacaoServicoResumo: description: Resumo do local de prestação de serviço do contrato type: object properties: nome: description: Nome do local de prestação de serviço type: string example: Escritório Central CondicaoPagamento: type: object required: - dia_vencimento - primeira_data_vencimento properties: tipo_pagamento: type: string description: Tipo de pagamento enum: - BOLETO_BANCARIO - CARTAO_CREDITO - CARTAO_DEBITO - CARTEIRA_DIGITAL - CASHBACK - CHEQUE - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - DINHEIRO - OUTRO - DEBITO_AUTOMATICO - CARTAO_CREDITO_VIA_LINK - PIX_PAGAMENTO_INSTANTANEO - PIX_COBRANCA - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - TRANSFERENCIA_BANCARIA - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO example: BOLETO_BANCARIO id_conta_financeira: type: string format: uuid description: id da conta financeira example: 123e4567-e89b-12d3-a456-426614174000 dia_vencimento: type: integer description: Dia de vencimento example: 10 primeira_data_vencimento: type: string format: date description: Primeira data de vencimento example: '2021-01-10' TipoPendenciaResponse: type: object properties: nome: type: string description: Nome da pendência example: AGUARDANDO_CONFIRMACAO descricao: type: string description: Descrição da pendência example: Aguardando confirmação VariacaoResponse: type: object properties: tipos: type: array items: $ref: '#/components/schemas/TipoVariacao' produtos: type: array items: $ref: '#/components/schemas/ItemVariacao' ListagemContratoResponse: type: object properties: itens_totais: type: integer example: 6 items: type: array items: $ref: '#/components/schemas/ListagemContratoItemResponse' RateioCentroCusto: type: object properties: id_centro_custo: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b nome_centro_custo: type: string example: Contabilidade valor: type: number format: double example: 30.5 CondicaoPagamentoResumo: description: Resumo das condições de pagamento do contrato type: object properties: dia_vencimento: description: Dia do mês para vencimento do pagamento type: integer example: 15 nome_conta_financeira: description: Nome da conta financeira vinculada ao pagamento type: string example: Conta Corrente observacoes_pagamento: description: Observações sobre o pagamento type: string example: Pagamento mensal tipo_pagamento: description: Tipo de pagamento do contrato allOf: - $ref: '#/components/schemas/TipoDePagamento' example: CARTAO_CREDITO ClientePegarVendaPorId: 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 MudancaEstoque: type: string example: ENTRADA_ESTOQUE enum: - ENTRADA_ESTOQUE - SAIDA_ESTOQUE - NAO_ALTERA_ESTOQUE CondicaoPagamento_3: 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: Observações sobre o pagamento example: Observações sobre o pagamento opcao_condicao_pagamento: type: string description: Opção de condição de pagamento example: À vista nsu: type: string example: '1234567890' pagamento_cartao: $ref: '#/components/schemas/PagamentoCartao' ObterVendaResponse: 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' ProductListChildResponse: type: object properties: id: type: string format: uuid example: 34471cce-67a2-48b8-a526-1120c0704ed3 id_legado: type: integer description: ID Legado do produto. example: 12345 nome: type: string description: Nome do Produto. example: Produto Exemplo codigo_sku: type: string description: Código SKU. example: SKU123456 codigo_ean: type: string description: Código EAN. example: '1234567890123' tipo: type: string description: Tipo do produto. example: VARIACAO enum: - PRODUTO - VARIACAO - KIT_PRODUTOS status: type: string description: Status do produto example: ATIVO enum: - ATIVO - INATIVO - TODOS estoque: type: number format: double description: Estoque. example: 50 valor_venda: type: number format: double description: Valor de venda. example: 99.99 custo_medio: type: number format: double description: Custo médio. example: 50 filhos: type: array description: Lista de produtos filhos. Neste nível retorna vazio. items: {} variacao: type: integer description: Quantidade de filhos/variações. Neste nível retorna 0. example: 0 nivel_estoque: type: string description: Nível do estoque example: MINIMO enum: - MINIMO - MAXIMO - PADRAO estoque_minimo: type: number format: double description: Estoque mínimo. example: 10 estoque_maximo: type: number format: double description: Estoque máximo. example: 200 movimentado: type: boolean description: Indica se o produto foi movimentado example: true id_pai: type: string format: uuid description: ID do produto pai example: 34471cce-67a2-48b8-a526-1120c0704ed3 integracao_ecommerce_ativa: type: boolean description: Indica se a integração com o e-commerce está ativa. example: true ConfiguracaoDesconto: type: object properties: tipo_desconto: $ref: '#/components/schemas/TipoDesconto' taxa_desconto: type: number format: double example: 10 ProductVariationOptionRequest: type: object required: - id - descricao properties: id: description: Identificador único da opção de variação é obrigatório. Cada opção de variação deve ter um identificador único em cada cadastro de produto. Ao informar a variação no produto, o mesmo identificador do elemento tipos.opcoes deve ser informado em produtos.opcoes. type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 descricao: description: Descrição da opção de variação é obrigatório. type: string example: Descrição da opção de variação BandeiraCartao: 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 TemplateNaturezaOperacao: 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 TotaisVenda: type: object description: Valores das de vendas com status Aprovado, Cancelado, Esperando aprovação e Total 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: Valor obtido das vendas esperando aprovação example: 300 ContaFinanceiraDetalhes: type: object description: Detalhes de uma conta financeira properties: id: type: string format: uuid description: Identificador único da conta financeira example: 8f2a3e45-1c9d-4b3a-a7f1-9e8d7c6b5a4f nome: type: string description: Nome da conta financeira example: Conta Corrente Principal instituicao_bancaria: $ref: '#/components/schemas/InstituicaoBancaria' description: Informações da instituição bancária GerarCobrancaRequestAtributosDto: type: object properties: desconto_antecipado: $ref: '#/components/schemas/GerarCobrancaRequestAtributosDescontoAntecipado' PeriodoDeAgendamento: description: Enum de período de agendamento type: string enum: - MENSAL - SEMANAL - ANUAL x-enum-varnames: - SCHEDULED_PERIOD_MONTH - SCHEDULED_PERIOD_WEEK - SCHEDULED_PERIOD_YEAR SugestaoPadrao: type: object nullable: true description: Sugestão padrão de categoria para a operação. Quando `sugestao_padrao=false`, este campo é retornado como `null`. properties: id: type: string format: uuid nullable: true description: Identificador da categoria sugerida example: 1bb1b4fa-0fba-49e6-9fb6-a0342b7575eb nome: type: string description: Nome da operação financeira correspondente à sugestão example: Fretes recebidos ResumoCriacaoOrcamento: description: Modelo de resposta da criação de orçamento type: object properties: id: description: ID do orçamento criado type: string example: cae40e8a-8330-4469-9bf7-51cbf3e8e2cd ConfiguracaoRecorrenciaResumo: description: Resumo da configuração de recorrência do contrato type: object properties: vigencia_restante: description: Vigência restante do contrato type: integer example: 12 vigencia_total: description: Vigência total do contrato type: integer example: 24 PagamentoCartao: type: object properties: tipo_bandeira: $ref: '#/components/schemas/BandeiraCartao' codigo_transacao: type: string example: ABC123XYZ789 id_adquirente: type: integer format: int64 example: 123456789 ContratoResumo: description: Resumo do modelo que representa um contrato de venda recorrente type: object properties: cliente: $ref: '#/components/schemas/ClienteResumo' composicao_valor: $ref: '#/components/schemas/ComposicaoValorResumo' condicao_pagamento: $ref: '#/components/schemas/CondicaoPagamentoResumo' configuracao_recorrencia: $ref: '#/components/schemas/ConfiguracaoRecorrenciaResumo' data_proxima_emissao: description: Data da próxima emissão type: string example: '2026-09-15' data_proximo_vencimento: description: Data do próximo vencimento type: string example: '2026-09-15' data_ultima_emissao: description: Data da última emissão type: string example: '2026-08-15' id: description: ID do contrato type: string example: 123e4567-e89b-12d3-a456-426614174000 id_proxima_venda_agendada: description: ID da próxima venda agendada type: string example: 123e4567-e89b-12d3-a456-426614174002 id_ultima_venda_confirmada: description: ID da última venda confirmada type: string example: 123e4567-e89b-12d3-a456-426614174001 local_prestacao_servico: $ref: '#/components/schemas/LocalPrestacaoServicoResumo' observacoes: description: Observações adicionais sobre o contrato type: string example: Contrato de venda recorrente para serviços de consultoria. status: description: Status do contrato allOf: - $ref: '#/components/schemas/Status_2' example: ATIVO termos: $ref: '#/components/schemas/TermosResumo' vendedor: $ref: '#/components/schemas/VendedorResumo' AnexoBaixa: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b referencia: type: string example: 5b04139f-fcca-4c64-8d01-1dd568eb420e nome: type: string example: baixa_03_05.pdf descricao: type: string example: Pgto 03/05 - Nota Fiscal 4567 tipo: type: string example: RECIBO_DIGITAL enum: - RECIBO_DIGITAL - RECIBO tipo_conteudo: type: string example: FILE enum: - FILE - URL url: type: string example: www.example.com EventoFinanceiroRequest: type: object required: - data_competencia - valor - observacao - descricao - contato - conta_financeira - condicao_pagamento properties: data_competencia: type: string format: date example: '2024-07-15' description: Data da competência do evento financeiro valor: type: number format: decimal example: 100 description: Valor do evento financeiro observacao: type: string example: Evento financeiro no valor de R$100,00 description: Observação do evento financeiro descricao: type: string example: Prestação de serviço description: Descrição do evento financeiro contato: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador do negociador conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador da Conta Financeira rateio: type: array items: $ref: '#/components/schemas/CategoriaRateio' condicao_pagamento: $ref: '#/components/schemas/ListaCondicaoPagamento' Negociacao: type: object properties: id: type: string format: uuid description: id da negociação 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_2' condicao_pagamento: $ref: '#/components/schemas/CondicaoPagamento_3' 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: Introdução da venda em orçamento example: Orçamento do produto 1 e serviço 1 origem: type: string description: Origem da venda example: API ItemVariacao: type: object properties: id: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 nome: type: string example: Produto Variado - Tamanho G codigo: type: string example: PROD123 codigo_ean: type: string example: '1234567890123' versao: type: integer example: 1 valor_venda: type: number format: double example: 99.99 estoque: type: number format: double example: 50 opcoes: type: array items: $ref: '#/components/schemas/ProductVariationOptionResponse' ClienteContratoResponse: 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 DiscountMonolithTranslatedDTO: 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 PerdaFinanceira: type: object properties: data: type: string format: date example: '2024-07-15' valor: type: number example: 1.99 Venda: 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: Data de criação da venda example: '2025-05-16T17:51:04.63' data_alteracao: type: string format: date-time description: Data de alteração da venda (ISO 8601, São Paulo/GMT-3) 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: Condição de pagamento numero: type: integer description: Número da venda example: 1001 cliente: $ref: '#/components/schemas/Cliente' situacao: $ref: '#/components/schemas/Situacao' versao: type: integer description: Versão da venda 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 EcommerceRequestProduto: type: object properties: condicao: type: string example: NOVO enum: - NOVO - USADO integracao_habilitada: type: boolean example: false observacao_adicional: type: string example: Descrição adicional.... titulo_seo: type: string example: Produto 1.0 descricao: type: string example: Lorem ipsum url_seo: type: string example: produto-x-1-0 VendaParaEdicaoRequest: 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: Número da venda data_venda: type: string format: date example: '2023-12-31' description: Data da venda situacao: type: string description: Situação da venda example: APROVADO enum: - EM_ANDAMENTO - APROVADO - FATURADO - CANCELADO observacoes: type: string example: Cliente solicitou entrega rápida description: Observações sobre a venda observacoes_pagamento: type: string example: Pagamento realizado em 3 parcelas description: Observações sobre o pagamento id_natureza_operacao: type: string format: uuid example: 550e8400-e29b-41d4-a716-446655440000 description: id da natureza da operação versao: type: integer example: 1 description: Versão da venda é obrigatório na edição itens: type: array $ref: '#/components/schemas/ItemVendaRequest' composicao_de_valor: $ref: '#/components/schemas/ValorComposicaoRequest' condicao_pagamento: $ref: '#/components/schemas/CondicaoPagamentoRequest' ContratoToCreateResponse: type: object properties: id: type: string format: uuid description: id do contrato example: 123e4567-e89b-12d3-a456-426614174000 id_legado: type: integer format: int64 description: id legado example: 1234 id_venda: type: string format: uuid description: id da venda example: 6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9 TransferenciaContaFinanceiraResponse: type: object description: Resposta paginada contendo a lista de transferências entre contas financeiras properties: itens_totais: type: integer format: int64 description: Número total de transferências encontradas example: 50 itens: type: array description: Lista de transferências entre contas financeiras items: $ref: '#/components/schemas/TransferenciaContaFinanceira' ParcelaRequest: 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: Descrição da parcela FormaPagamento: 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 CentroDeCusto: type: object properties: id: type: string format: uuid description: Identificador único do centro de custo example: 35473eec-4e74-11ee-b500-9f61de8a8b8b codigo: type: string nullable: true description: Código do centro de custo example: '1040' nome: type: string description: Nome do centro de custo example: Contabilidade ativo: type: boolean description: Indica se o centro de custo está ativo example: true VariacaoRequest: type: object properties: tipos: description: O tipo deve conter pelo menos uma opção. Que será utilizada para criar as variações do produto. type: array items: $ref: '#/components/schemas/TipoVariacaoRequest' produtos: type: array description: O produto deve conter pelo menos uma opção. Cada item conterá os dados do produto e as opções de variação. items: $ref: '#/components/schemas/ItemVariacaoRequest' TermosResumo: description: Resumo dos termos do contrato type: object properties: data_fim: description: Data de término do contrato type: string example: '2026-10-21' data_inicio: description: Data de início do contrato type: string example: '2026-08-15' dia_emissao_venda: description: Dia do mês para emissão da venda type: integer example: 15 intervalo_frequencia: description: 'Intervalo entre as cobranças (ex: a cada 1 mês)' type: integer example: 1 numero: description: Número do contrato type: integer example: 1 tipo_expiracao: description: Tipo de expiração do contrato allOf: - $ref: '#/components/schemas/TipoDeExpiracao' example: DATA tipo_frequencia: description: Tipo de frequência de cobrança allOf: - $ref: '#/components/schemas/PeriodoDeAgendamento' example: MENSAL GerarCobrancaRequestDto: type: object required: - conta_bancaria - descricao_fatura - id_parcela - data_vencimento - tipo properties: conta_bancaria: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único para a conta bancária. A conta deve ser do tipo "COBRANCAS_CONTA_AZUL" ou, caso seja uma Conta PJ Conta Azul, do tipo "CONTA_CORRENTE" descricao_fatura: type: string example: 'Pagamento da fatura #1234' description: Descrição da fatura id_parcela: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único para a parcela data_vencimento: type: string format: date example: '2023-10-10' description: Data de vencimento da cobrança tipo: type: string example: LINK_PAGAMENTO description: Tipo da cobrança enum: - LINK_PAGAMENTO - PIX_COBRANCA - BOLETO atributos: $ref: '#/components/schemas/GerarCobrancaRequestAtributosDto' maximo_parcelas: type: integer example: 3 description: Número máximo de parcelas exibido na fatura do cartão ContaAPagar: type: object properties: id: type: string example: c6a28b6e-efe4-11ee-8ef8-8b86c5251537 descricao: type: string example: Aluguel do escritório data_vencimento: type: string example: '2027-08-15' status: type: string example: OVERDUE status_traduzido: example: ATRASADO type: string enum: - PERDIDO - RECEBIDO - EM_ABERTO - RENEGOCIADO - RECEBIDO_PARCIAL - ATRASADO total: type: number example: 781201.79 nao_pago: type: number example: 213023.79 pago: type: number example: 0 data_criacao: type: string format: date-time example: '2027-08-15T14:30:00Z' data_alteracao: type: string description: Data de alteração da conta a pagar (ISO 8601, São Paulo/GMT-3) format: date-time example: '2027-08-15T14:30:00Z' data_competencia: type: string format: date description: Data de competência da parcela (campo data_competencia) example: '2018-03-16' categorias: type: array description: Lista de categorias associadas à parcela (id e nome) items: $ref: '#/components/schemas/CategoriaParcela' centros_custo: type: array description: Lista de centros de custo associados à parcela (id e nome) items: $ref: '#/components/schemas/CentroCustoParcela' fornecedor: $ref: '#/components/schemas/NegociadorContaAPagarOuReceber' ItemOrcamento: description: Modelo que representa um item de um orçamento type: object properties: custo: description: Custo do item do orçamento type: number example: 10 descricao: description: Descrição do item do orçamento type: string example: 'Tipo de serviço: Manutenção Preventiva' id: description: ID do item do orçamento type: string example: 9a1960f7-87e6-48c7-b30d-0ae0f8d6292e nome: description: Nome do item do orçamento type: string example: Produto 01 quantidade: description: Quantidade do item do orçamento type: number example: 1 tipo: description: Tipo do item do orçamento (PRODUTO ou SERVICO) allOf: - $ref: '#/components/schemas/TipoItemOrcamento' example: PRODUTO valor: description: Valor do item do orçamento type: number example: 10 ContratoToCreateRequest: type: object required: - id_cliente - itens - condicao_pagamento - termos properties: id_cliente: type: string format: uuid description: id do cliente example: 123e4567-e89b-12d3-a456-426614174000 data_emissao: type: string format: date description: Data de emissão example: '2021-01-01' id_categoria: type: string format: uuid description: id da categoria example: 123e4567-e89b-12d3-a456-426614174000 id_centro_custo: type: string format: uuid description: id do centro de custo example: 123e4567-e89b-12d3-a456-426614174000 id_vendedor: type: string format: uuid description: id do vendedor example: 123e4567-e89b-12d3-a456-426614174000 observacoes: type: string description: Observações do pagamento example: Pagamento realizado em parcela única. observacoes_pagamento: type: string description: Observações complementares da nota fiscal example: Pagamento à vista. termos: $ref: '#/components/schemas/Termo' composicao_de_valor: $ref: '#/components/schemas/ComposicaoDeValor' condicao_pagamento: $ref: '#/components/schemas/CondicaoPagamento' itens: type: array items: $ref: '#/components/schemas/Item' Renegociacao: type: object description: Informações de renegociação. properties: id: type: string format: uuid description: Identificador único da renegociação. example: 43adf4e9-203c-4f7e-a0f6-08abf3f8a583 valor: type: number format: double description: Valor da renegociação. example: 25 BaixaAtualizacaoRequestDTO: type: object required: - versao properties: versao: type: integer format: int64 example: 1 description: Versão atual do registro. Este valor será incrementado após sucesso na atualização data_pagamento: type: string format: date example: '2023-10-01' description: Data do pagamento composicao_valor: $ref: '#/components/schemas/ValorComposicaoDTO' conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da conta financeira metodo_pagamento: type: string example: CARTAO_CREDITO description: Método de pagamento enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUA - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO observacao: type: string example: 'Pagamento referente à fatura #1234.' description: Observação adicional nsu: type: string example: '1234567890' description: Número sequencial único Rateio: type: object properties: id_categoria: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b nome_categoria: type: string example: Eletrônicos valor: type: number format: double example: 20.5 valor_bruto: type: number format: double example: 20.5 rateio_centro_custo: type: array items: $ref: '#/components/schemas/RateioCentroCusto' CriarItemOrcamento: description: Modelo de criação de item do orçamento type: object required: - id properties: id: description: ID do item (produto ou serviço) type: string example: 623ef303-54df-4df6-b816-69416f29e093 quantidade: description: Quantidade do item; deve ser maior que zero type: number example: 1 valor: description: Valor unitário do item; deve ser maior que zero type: number example: 10 valor_custo: description: Valor de custo do item type: number example: 8 Vendedor: 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 Status_2: description: Enum de status do contrato type: string enum: - ATIVO - INATIVO - DELETADO x-enum-varnames: - STATUS_ENABLED - STATUS_DISABLED - STATUS_DELETED Orcamento: description: Modelo que representa um orçamento type: object properties: composicao_de_valor: description: Composição de valor do orçamento (frete e desconto) allOf: - $ref: '#/components/schemas/ComposicaoValorOrcamento' data_orcamento: description: Data do orçamento (YYYY-MM-DD) type: string example: '2026-05-01' data_validade: description: Data de validade do orçamento (YYYY-MM-DD) type: string example: '2026-05-01' descricao: description: Descrição do orçamento type: string example: Este orçamento refere-se a manutenção de serviço id: description: ID do orçamento type: string example: aff32f2a-2904-4918-a18b-96fa39ac435c id_cliente: description: ID do cliente do orçamento type: string example: 72f07482-bfda-44b0-a2e7-d8817bf950fa id_vendedor: description: ID do vendedor responsável pelo orçamento type: string example: 8cc4ff03-e8c6-4d7e-8c41-4245f55f8612 itens: description: Itens do orçamento type: array items: $ref: '#/components/schemas/ItemOrcamento' numero: description: Número do orçamento type: integer example: 1 observacoes: description: Observações gerais do orçamento type: string example: Entrega Grátis observacoes_pagamento: description: Observações de pagamento do orçamento type: string example: Pagamento à vista previsao_entrega: description: Previsão de entrega do orçamento type: string example: À combinar situacao: description: Situação atual do orçamento allOf: - $ref: '#/components/schemas/TipoDeSituacaoOrcamento' example: ORCAMENTO versao: description: Versão do orçamento type: integer example: 1 Item_2: 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: Descrição do item vendido 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: Valor unitário do item vendido custo: type: number example: 100 description: Valor de custo do item vendido Totais_2: type: object properties: quantidade_produtos: type: integer example: 1 description: Quantidade total de produtos vendidos quantidade_servicos: type: integer example: 1 description: Quantidade total de serviços vendidos quantidade_nao_conciliados: type: integer example: 1 description: Quantidade total de itens não conciliados ClienteResumo: description: Resumo dos dados do cliente vinculado ao contrato type: object properties: id: description: ID do cliente type: string example: 123e4567-e89b-12d3-a456-426614174000 nome: description: Nome do cliente type: string example: João da Silva Categoria: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b versao: type: integer example: 0 nome: type: string example: Eletrônicos categoria_pai: type: string nullable: true example: 3d39b8d2-8b16-42d6-abd8-6cfd9d2e06c4 tipo: type: string example: RECEITA entrada_dre: type: string example: DESPESAS_ADMINISTRATIVAS considera_custo_dre: type: boolean example: true Contrato: 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: Data de início do contrato 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: Período de faturamento do contrato enum: - MENSAL - SEMANAL - ANUAL periodicidade: type: integer example: 1 description: '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.' NaturezaOperacao: 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' InstituicaoBancaria: type: object description: Informações da instituição bancária properties: codigo: type: integer description: Código da instituição bancária example: 1 nome: type: string description: Nome da instituição bancária example: Banco do Brasil ItemVendaRequest: type: object required: - id - quantidade - valor properties: descricao: type: string example: Produto A description: Descrição do item da venda 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' ItemVariacaoRequest: type: object required: - nome - codigo - estoque - opcoes properties: nome: type: string example: Produto Variado - Tamanho G codigo: type: string example: PROD123 codigo_ean: type: string example: '1234567890123' versao: type: integer example: 1 valor_venda: type: number format: double example: 99.99 estoque: type: number format: double example: 50 opcoes: type: array items: $ref: '#/components/schemas/ProductVariationOptionRequest' CriacaoCentroDeCustoRequest: type: object required: - nome properties: codigo: type: string nullable: true description: Código do centro de custo example: '1040' nome: type: string description: Nome do centro de custo example: Contabilidade ProdutoDesativadoResponse: type: object properties: todos: type: array example: - 34471cce-67a2-48b8-a526-1120c0704ed3 - 123e4567-e89b-12d3-a456-426614174000 items: type: string format: uuid description: Lista de todos os produtos. produtos_desativados: type: array items: type: string format: uuid description: Lista de produtos desativados. example: - 34471cce-67a2-48b8-a526-1120c0704ed3 - 123e4567-e89b-12d3-a456-426614174000 EventoFinanceiro: type: object description: IDs dos eventos financeiros alterados properties: id: type: string format: uuid description: Identificador único do evento financeiro example: 35473eec-4e74-11ee-b500-9f61de8a8b8b Quitacao: type: object description: Informações de quitação de uma conta financeira incluindo data, composição de valores e detalhes da conta properties: data: type: string format: date description: Data da quitação (formato ISO date) example: '2026-02-15' composicao_valor: $ref: '#/components/schemas/ComposicaoValorTransferencia' description: Detalhamento da composição do valor da transação conta_financeira: $ref: '#/components/schemas/ContaFinanceiraDetalhes' description: Informações da conta financeira envolvida BaixaResponseDTO: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da baixa versao: type: integer format: int64 example: 1 description: Versão da baixa data_pagamento: type: string format: date example: '2023-10-01' description: Data do pagamento valor_composicao: $ref: '#/components/schemas/ValorComposicaoDTO' conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da conta financeira id_reconciliacao: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da reconciliação id_parcela: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da parcela id_solicitacao_cobranca: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da solicitação de cobrança observacao: type: string example: 'Pagamento referente à fatura #1234.' description: Observação metodo_pagamento: type: string example: CARTAO_CREDITO description: Método de pagamento enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUA - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO - PIX_COBRANCA - DEBITO_AUTOMATICO origem: type: string example: SALDO_CONTA_BANCARIA description: Origem enum: - LANCAMENTO_FINANCEIRO - DAS - FOLHA - TRANSFERENCIA - SALDO_CONTA_BANCARIA - VENDA - COMPRA - VENDA_AGENDADA - COMPRA_AGENDADA - IMPORTACAO_DOCUMENTO - IMPOSTO_RETIDO - SIC - NOTA_COMPRA - ANTECIPACAO - RENEGOCIACAO - HONORARIOS_CONTABEIS id_recibo_digital: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único do recibo digital tipo_evento_financeiro: type: string example: RECEITA description: Tipo de evento financeiro enum: - RECEITA - DESPESA nsu: type: string example: '1234567890' description: Número sequencial único id_referencia: type: string example: REF1234 description: Identificador único da referência atualizado_em: type: string format: date-time example: '2023-10-01T12:00:00Z' description: Data de atualização anexos: type: array items: $ref: '#/components/schemas/AnexoBaixaResponseDTO' VendedorResumo: description: Resumo dos dados do vendedor responsável pelo contrato type: object properties: id: description: ID do vendedor type: string example: 123e4567-e89b-12d3-a456-426614174000 nome: description: Nome do vendedor type: string example: Maria Oliveira Fatura: type: object properties: numero: type: integer format: int64 example: 123 rps: type: integer format: int64 example: 1 tipo_fatura: type: string example: NFE enum: - NFE - NFSE - NFCE TipoNegociacao: type: string example: VENDA enum: - VENDA - COMPRA ProductVariationOptionResponse: type: object properties: id: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 descricao: type: string example: G ItemNotificacaoCobranca: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b versao: type: integer format: int64 example: 1 email: type: string example: exemplo@email.com sms: type: string example: SMS whatsapp: type: string example: whatsapp status_entrega: type: string example: ENVIADO enum: - ENVIADO - INVALIDO CriarOrcamento: description: Modelo de criação de orçamento type: object required: - data_orcamento - data_validade - id_cliente - itens properties: composicao_de_valor: description: Composição dos valores do orçamento (frete e desconto) allOf: - $ref: '#/components/schemas/CriarComposicaoValorOrcamento' data_orcamento: description: Data do orçamento no formato YYYY-MM-DD type: string example: '2026-05-01' data_validade: description: Data de validade no formato YYYY-MM-DD; não pode ser anterior à data do orçamento type: string example: '2026-05-15' descricao: description: Descrição do orçamento type: string example: Proposta comercial referente ao mês de maio id_cliente: description: ID do cliente type: string example: 72f07482-bfda-44b0-a2e7-d8817bf950fa id_vendedor: description: ID do vendedor; se não informado ou inexistente, será utilizado o vendedor default type: string example: 8cc4ff03-e8c6-4d7e-8c41-4245f55f8612 itens: description: Lista de itens do orçamento; deve conter ao menos um item type: array minItems: 1 items: $ref: '#/components/schemas/CriarItemOrcamento' observacoes: description: Observações gerais type: string example: Cliente solicitou entrega rápida observacoes_pagamento: description: Observações sobre o pagamento type: string example: Pagamento em até 30 dias após aprovação previsao_entrega: description: Previsão de entrega type: string example: Entrega em até 10 dias úteis Evento: type: object properties: data_competencia: type: string format: date example: '2025-06-11' id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b condicao_pagamento: $ref: '#/components/schemas/CondicaoPagamento_2' referencia: $ref: '#/components/schemas/Referencia' agendado: type: boolean example: true tipo: type: string example: RECEITA enum: - RECEITA - DESPESA codigo_referencia: type: string description: Código de referência do evento financeiro example: '123456' rateio: type: array items: $ref: '#/components/schemas/Rateio' SaldoInicialContaFinanceira: type: object description: Informações sobre o saldo inicial de uma conta financeira, incluindo o valor e a data de competência properties: tipo: type: string example: RECEITA enum: - RECEITA - DESPESA id_conta_financeira: type: string format: uuid description: Identificador único da conta financeira example: 35473eec-4e74-11ee-b500-9f61de8a8b8b data_competencia: type: string format: date description: Data de competência da conta financeira (formato ISO date) example: '2018-03-16' saldo_inicial: type: number description: Saldo inicial da conta financeira na data de competência. Se o saldo for negativo, o tipo deve ser "DESPESA", caso contrário, "RECEITA". format: decimal example: 2500 CategoriaFinanceira: type: object properties: id: type: string format: uuid description: id da categoria financeira example: f0e9d8c7-b6a5-4321-fedc-ba9876543210 codigo: type: string description: Código da categoria financeira example: '1' nome: type: string description: Nome da categoria financeira example: Venda de Produtos ativo: type: boolean description: Indica se a categoria financeira está ativa example: true ListagemDeProdutosPorFiltroResponse: type: object properties: itens: type: array items: $ref: '#/components/schemas/ProductListResponse' itens_totais: type: integer example: 1 AnexoParcela: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b versao: type: integer format: int64 example: 1 descricao: type: string example: Boleto de cobrança nome: type: string example: boleto_03_05.pdf url: type: string example: www.exemplo.com tipo_conteudo: type: string example: URL enum: - FILE - URL referencia: type: string example: 5b04139f-fcca-4c64-8d01-1dd568eb420e tipo_anexo: type: string example: BOLETO_BANCARIO enum: - BOLETO_BANCARIO_RFB - BOLETO_BANCARIO - RECIBO - FATURA - OUTROS - RECIBO_DIGITAL id_parcela: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b ListagemOrcamentosPorFiltro: description: Listagem de orçamentos com filtros type: object properties: itens: description: Lista de orçamentos type: array items: $ref: '#/components/schemas/ItemOrcamentoPorFiltro' total_itens: description: Total de itens type: integer example: 10 ItemKitRequest: 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: id do kit que contém o produto 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 ErroAPI: description: Modelo de resposta para erros da API type: object properties: error: description: Mensagem de erro type: string example: Mensagem de erro detalhada ContaAReceber: type: object properties: id: type: string example: c6a28b6e-efe4-11ee-8ef8-8b86c5251537 descricao: type: string example: Venda de Produtos data_vencimento: type: string example: '2027-08-15' status: type: string example: OVERDUE status_traduzido: example: ATRASADO type: string enum: - PERDIDO - RECEBIDO - EM_ABERTO - RENEGOCIADO - RECEBIDO_PARCIAL - ATRASADO total: type: number example: 781201.79 nao_pago: type: number example: 213023.79 pago: type: number example: 0 data_criacao: type: string format: date-time example: '2027-08-15T14:30:00Z' data_alteracao: type: string description: Data de alteração da conta a receber (ISO 8601, São Paulo/GMT-3) format: date-time example: '2027-08-15T14:30:00Z' data_competencia: type: string format: date description: Data de competência da parcela (campo data_competencia) example: '2018-03-16' categorias: type: array description: Lista de categorias associadas à parcela (id e nome) items: $ref: '#/components/schemas/CategoriaParcela' centros_custo: type: array description: Lista de centros de custo associados à parcela (id e nome) items: $ref: '#/components/schemas/CentroCustoParcela' cliente: $ref: '#/components/schemas/NegociadorContaAPagarOuReceber' renegociacao: $ref: '#/components/schemas/RenegociacaoContaAReceber' ProdutoResponse: type: object properties: id: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 identificador_legado: type: string example: '123' ativo: type: boolean example: true versao: type: integer example: 1 nome: type: string example: Nome do Produto codigo_sku: type: string example: PROD123 codigo_ean: type: string example: '1234567890123' observacao: type: string example: Descrição do Produto status: type: string description: Status do produto example: ATIVO enum: - ATIVO - INATIVO formato: type: string example: VARIACAO description: Formato do produto. enum: - SIMPLES - VARIACAO estoque: $ref: '#/components/schemas/Estoque' dimensoes: $ref: '#/components/schemas/Dimensao' ecommerce: $ref: '#/components/schemas/Ecommerce' variacao: description: Caso o formato não seja do tipo VARIACAO, este campo será nulo. $ref: '#/components/schemas/VariacaoResponse' ExclusaoLote: type: object properties: ids: type: array items: type: string format: uuid minItems: 1 maxItems: 10 description: Lista de uuids das vendas a serem excluídas required: - ids example: ids: - 123e4567-e89b-12d3-a456-426614174000 - 123e4567-e89b-12d3-a456-426614174001 Cliente: 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: Endereço do cliente 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: País do cliente example: Brasil cep: type: string description: CEP do cliente example: 12345-678 TipoVariacaoRequest: type: object required: - descricao - opcoes properties: descricao: type: string example: Tamanho opcoes: type: array items: $ref: '#/components/schemas/ProductVariationOptionRequest' ValorComposicao: type: object properties: multa: type: number format: double example: 10 juros: type: number format: double example: 1 valor_bruto: type: number format: double example: 20 desconto: type: number format: double example: 0.1 taxa: type: number format: double example: 0.03 valor_liquido: type: number format: double example: 9 ParcelaNegociacao: type: object properties: id: type: string format: uuid description: id da parcela example: 123e4567-e89b-12d3-a456-426614174000 numero: type: integer example: 1 description: Número da parcela 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: Descrição da parcela Totais: type: object properties: ativo: type: integer description: Total de centros de custo ativos example: 6 inativo: type: integer description: Total de centros de custo inativos example: 0 todos: type: integer description: Total de centros de custo example: 6 CriacaoVendaResponse: type: object properties: id: type: string format: uuid description: id único da venda example: 123e4567-e89b-12d3-a456-426614174000 id_legado: type: integer format: int64 description: id legado necessário para a venda example: 123456 id_cliente: type: string format: uuid description: id do cliente associado à venda example: 123e4567-e89b-12d3-a456-426614174001 numero: type: integer format: int64 description: Número da venda 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: Observações sobre a venda example: Cliente solicitou entrega rápida id_vendedor: type: string format: uuid description: id do vendedor responsável pela venda example: 123e4567-e89b-12d3-a456-426614174003 versao: type: integer format: int64 description: Versão da venda example: 1 ComposicaoValorResponse: 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: Valor líquido da venda example: 90 SolicitacaoCobranca: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b versao: type: integer format: int64 example: 1 status_solicitacao_cobranca: type: string example: AGUARDANDO_CONFIRMACAO enum: - AGUARDANDO_CONFIRMACAO - EM_CANCELAMENTO - REGISTRADO - QUITADO - CANCELADO - INVALIDO - EXPIRADO - FALHA_EMISSAO - FALHA_CANCELAR - REMESSA_GERADO - REMESSA_PENDENTE - PAGO - EXTORNADO valor_composicao: $ref: '#/components/schemas/ValorComposicao' data_vencimento: type: string format: date example: '2025-09-05' data_quitacao: type: string format: date example: '2025-09-05' tipo_solicitacao_cobranca: type: string example: BOLETO enum: - BOLETO - LINK_PAGAMENTO - BOLETO_REGISTRADO - PIX_COBRANCA id_cliente: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b id_referencia: type: string example: 5b04139f-fcca-4c64-8d01-1dd568eb420e url: type: string example: www.exemplo.com detalhe_erro: type: string example: Erro de valor... conta_financeira: $ref: '#/components/schemas/ContaFinanceira' notificacao_cobranca: $ref: '#/components/schemas/NotificacaoCobranca' confirmado_em: type: string format: date example: '2025-09-05' descricao: type: string example: Reembolso de Despesas referencia_externa: type: string example: 5b04139f-fcca-4c64-8d01-1dd568eb420e recuperado: type: boolean example: false combinado: type: boolean example: false atributos_personalizados: type: string example: atributos Status: type: string example: EM_ANDAMENTO enum: - REVISAO_PENDENTE - EM_ORCAMENTO - ORCAMENTO_ACEITO - ORCAMENTO_RECUSADO - EM_ANDAMENTO - CONTRATO - CANCELADO - PREVISAO - INCOMPLETA CondicaoPagamentoRequest: 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: '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' nsu: type: string example: '1234567890' description: NSU parcelas: type: array items: $ref: '#/components/schemas/ParcelaRequest' TipoDeDesconto: description: Enum de tipo de desconto type: string enum: - PORCENTAGEM - VALOR x-enum-varnames: - DISCOUNT_TYPE_PERCENT - DISCOUNT_TYPE_VALUE ListagemVendasResponse: 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' CriarComposicaoValorOrcamento: description: Modelo de criação da composição de valor do orçamento, incluindo frete e desconto type: object properties: desconto: description: Detalhes do desconto aplicado ao orçamento allOf: - $ref: '#/components/schemas/CriarDescontoOrcamento' frete: description: Valor do frete; deve ser maior ou igual a 0 type: number minimum: 0 example: 5 ProtocolResponseDTO: type: object properties: protocolo: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador do protocolo status: type: string description: Status do protocolo example: SUCCESS enum: - PENDING - SUCCESS - ERROR data_criacao: type: string format: date-time example: '2024-10-22T14:30:00Z' description: Data de criação do protocolo Baixa: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b versao: type: integer example: 1 data_pagamento: type: string format: date example: '2025-05-20' valor_composicao: $ref: '#/components/schemas/ValorComposicao' conta_financeira: $ref: '#/components/schemas/ContaFinanceira' id_reconciliacao: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b id_parcela: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b id_solicitacao_cobranca: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b observacao: type: string example: Pgto 03/05 - Nota Fiscal 4567 metodo_pagamento: type: string example: DEPOSITO_BANCARIO enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO - PIX_COBRANCA - DEBITO_AUTOMATICO origem: type: string example: LANCAMENTO_FINANCEIRO enum: - LANCAMENTO_FINANCEIRO - DAS - FOLHA - TRANSFERENCIA - SALDO_CONTA_BANCARIA - VENDA - COMPRA - VENDA_AGENDADA - COMPRA_AGENDADA - IMPORTACAO_DOCUMENTO - IMPOSTO_RETIDO - SIC - NOTA_COMPRA - ANTECIPACAO - RENEGOCIACAO - HONORARIOS_CONTABEIS id_recibo_digital: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b tipo_evento_financeiro: type: string example: RECEITA enum: - RECEITA - DESPESA nsu: type: string example: 000215783210 id_referencia: type: string example: 5b04139f-fcca-4c64-8d01-1dd568eb420e atualizado_em: type: string format: date-time example: '2025-08-05T08:37:05' anexos: type: array items: $ref: '#/components/schemas/AnexoBaixa' SituacaoResponse: type: object properties: nome: type: string description: Nome da situação example: Situação Exemplo descricao: type: string description: Descrição da situação example: Descrição da situação exemplo CriacaoProdutoRequest: type: object required: - nome - formato - estoque - dimensao properties: nome: type: string example: Nome do Produto codigo_sku: type: string example: SKU12345 codigo_ean: type: string example: '1234567890123' observacao: type: string example: Descrição do produto formato: type: string example: VARIACAO enum: - SIMPLES - VARIACAO estoque: $ref: '#/components/schemas/EstoqueCriacaoProduto' dimensao: $ref: '#/components/schemas/Dimensao' variacao: $ref: '#/components/schemas/VariacaoRequest' ecommerce: $ref: '#/components/schemas/EcommerceRequestProduto' ItensPaginados: type: object properties: itens: type: array items: $ref: '#/components/schemas/Item_2' itens_totais: type: integer example: 25 totais: $ref: '#/components/schemas/Totais_2' NotificacaoCobranca: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b solicitacao_cobranca_ids: type: array example: - 35473eec-4e74-11ee-b500-9f61de8a8b8b items: type: string format: uuid versao: type: integer format: int64 example: 1 enviado_em: type: string format: date example: '2025-09-05' aberto_em: type: string format: date example: '2025-09-05' itens_notificacao_cobranca: type: array items: $ref: '#/components/schemas/ItemNotificacaoCobranca' assunto: type: string example: Fatura Vencida corpo: type: string example: Verificamos que o prazo de vencimento era [X] dias atrás... respondido_para: type: string example: exemplo@email.com agendado: type: boolean example: false auto_notificacao: type: boolean example: false envio_instantaneo: type: boolean example: false CriarDescontoOrcamento: description: Modelo de criação de desconto aplicado ao orçamento type: object properties: tipo: description: 'Tipo de desconto: VALOR ou PORCENTAGEM' allOf: - $ref: '#/components/schemas/TipoDeDesconto' example: VALOR valor: description: Valor do desconto; se o tipo for PORCENTAGEM, deve ser entre 0 e 100 type: number minimum: 0 example: 10 TipoPendente: type: object properties: nome: enum: - NENHUMA - RESERVA_DE_ESTOQUE - CONCILIACAO_ITENS - PROCESSAMENTO_RESERVA_DE_ESTOQUE - ESPERANDO_CONFIRMACAO - AGUARDANDO_GERACAO_NOTA_FISCAL description: Nome da pendência example: NENHUMA descricao: type: string description: Descrição da pendência example: Nenhuma TransferenciaContaFinanceira: type: object description: Representa uma transferência entre contas financeiras da empresa properties: id: type: string format: uuid description: Identificador único da transferência example: 35473eec-4e74-11ee-b500-9f61de8a8b8b descricao: type: string description: Descrição ou motivo da transferência example: Transferência para conta poupança valor: type: number format: decimal description: Valor da transferência example: 1500.5 data: type: string format: date description: Data em que a transferência foi realizada (formato ISO date) example: '2026-02-15' origem: $ref: '#/components/schemas/Quitacao' description: Informações da conta financeira de origem da transferência destino: $ref: '#/components/schemas/Quitacao' description: Informações da conta financeira de destino da transferência ComposicaoValorResumo: description: Resumo da composição de valores do contrato type: object properties: desconto: description: Valor do desconto aplicado type: number example: 200 frete: description: Valor do frete type: number example: 50 valor_bruto: description: Valor bruto do contrato type: number example: 1200 valor_impostos_servico: description: Valor total dos impostos sobre o serviço type: number example: 100 valor_liquido: description: Valor líquido do contrato type: number example: 1050 SaldoAtualResponse: type: object description: Saldo atual da conta financeira properties: saldo_atual: type: number format: double example: 1000.36 ExclusaoResponse: type: object properties: atualizados: type: integer description: Indica quantidade excluída example: 1 ignorados: type: integer description: Indica quantidade ignorada example: 1 ComposicaoValorOrcamento: description: Modelo que representa a composição de valor de um orçamento type: object properties: desconto: description: Desconto aplicado ao orçamento allOf: - $ref: '#/components/schemas/DescontoOrcamento' frete: description: Valor do frete do orçamento type: number example: 5 ExclusaoLoteOrcamento: description: Modelo de lista de ids para exclusão de orçamentos em lote type: object required: - ids properties: ids: description: Lista de ids dos orçamentos a serem excluídos type: array maxItems: 10 minItems: 1 items: type: string example: - 7d7c9d4a-27aa-457e-b981-2df4c81970f7 - c44e254d-0040-46e2-bccf-6898d0981201 VendaEditadaResponse: 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 AnexoBaixaResponseDTO: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único do anexo referencia: type: string example: REF1234 description: Referência associada ao anexo nome: type: string example: pagamento_recibo.pdf description: Nome do anexo descricao: type: string example: 'Recibo de pagamento referente à fatura #1234.' description: Descrição detalhada do anexo tipo: type: string example: RECIBO_DIGITAL description: Tipo do anexo enum: - RECIBO_DIGITAL - RECIBO tipo_conteudo: type: string example: FILE description: Tipo de conteúdo do anexo enum: - FILE - URL url: type: string example: https://example.com/attachment.pdf description: URL do anexo ComposicaoValorTransferencia: type: object description: Composição detalhada do valor de uma transação financeira properties: valor_bruto: type: number format: decimal description: Valor bruto da transação antes de qualquer ajuste example: 1500.5 juros: type: number format: decimal description: Valor de juros aplicado example: 0 multa: type: number format: decimal description: Valor de multa aplicado example: 0 valor_liquido: type: number format: decimal description: Valor líquido após todos os ajustes (valor_bruto + juros + multa - desconto - taxa) example: 1500.5 desconto: type: number format: decimal description: Valor de desconto aplicado example: 0 taxa: type: number format: decimal description: Valor de taxa aplicado example: 0 StatusVisualizacaoMensagem: type: string example: ENVIADO enum: - ENVIADO - LIDO ListagemContratoItemResponse: type: object properties: id: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 description: id do contrato cliente: $ref: '#/components/schemas/ClienteContratoResponse' status: type: string description: Status do contrato example: ATIVO enum: - ATIVO - INATIVO proximo_vencimento: type: string description: Data do próximo vencimento example: '2026-08-15' data_inicio: type: string description: Data de início example: '2026-08-15' numero: type: integer description: Número do contrato example: 1014 CondicaoPagamentoResponse: type: object properties: id_legado: type: integer format: int64 example: 123456789 description: id legado da condição de pagamento 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: Opção de condição de pagamento parcelas: type: array items: $ref: '#/components/schemas/ParcelaResponse' observacoes_pagamento: type: string example: Pagamento realizado em 3 parcelas description: Observações sobre o pagamento nsu: type: string example: '1234567890' description: NSU troco_total: type: number format: double example: 10.5 description: Troco total ProductListResponse: type: object properties: id: type: string format: uuid example: 34471cce-67a2-48b8-a526-1120c0704ed3 id_legado: type: integer description: ID Legado do produto. example: 12345 nome: type: string description: Nome do Produto. example: Produto Exemplo codigo_sku: type: string description: Código SKU. example: SKU123456 codigo_ean: type: string description: Código EAN. example: '1234567890123' tipo: type: string description: Tipo do produto. example: VARIACAO enum: - PRODUTO - VARIACAO - KIT_PRODUTOS status: type: string description: Status do produto example: ATIVO enum: - ATIVO - INATIVO - TODOS estoque: type: number format: double description: Estoque. example: 50 valor_venda: type: number format: double description: Valor de venda. example: 99.99 custo_medio: type: number format: double description: Custo médio. example: 50 filhos: type: array description: Lista de produtos filhos. items: $ref: '#/components/schemas/ProductListChildResponse' example: - id: 123e4567-e89b-12d3-a456-426614174000 id_legado: 12345 nome: Produto Filho 1 codigo_sku: SKU123456 codigo_ean: '1234567890123' tipo: PRODUTO status: ATIVO estoque: 20 valor_venda: 49.99 custo_medio: 25 filhos: [] variacao: 0 nivel_estoque: MINIMO estoque_minimo: 5 estoque_maximo: 100 movimentado: true id_pai: 34471cce-67a2-48b8-a526-1120c0704ed3 integracao_ecommerce_ativa: true - id: 123e4567-e89b-12d3-a456-426614174001 id_legado: 12346 nome: Produto Filho 2 codigo_sku: SKU123457 codigo_ean: '1234567890124' tipo: VARIACAO status: INATIVO estoque: 10 valor_venda: 29.99 custo_medio: 15 filhos: [] variacao: 0 nivel_estoque: MAXIMO estoque_minimo: 2 estoque_maximo: 50 movimentado: false id_pai: 34471cce-67a2-48b8-a526-1120c0704ed3 integracao_ecommerce_ativa: false variacao: type: integer description: Quantidade de filhos/variações. example: 2 nivel_estoque: type: string description: Nível do estoque example: MINIMO enum: - MINIMO - MAXIMO - PADRAO estoque_minimo: type: number format: double description: Estoque mínimo. example: 10 estoque_maximo: type: number format: double description: Estoque máximo. example: 200 movimentado: type: boolean description: Indica se o produto foi movimentado example: true id_pai: type: string format: uuid description: ID do produto pai example: 34471cce-67a2-48b8-a526-1120c0704ed3 integracao_ecommerce_ativa: type: boolean description: Indica se a integração com o e-commerce está ativa. example: true CentroCustoRateio: type: object properties: id_centro_custo: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único do centro de custo valor: type: number format: decimal example: 100 description: Valor atribuído ao centro de custo no rateio ParcelaCondicaoPagamento: type: object required: - descricao - data_vencimento - nota - conta_financeira - detalhe_valor properties: descricao: type: string example: Mensalidade (2/6) description: Descrição da parcela data_vencimento: type: string format: date example: '2024-07-15' description: Data de vencimento da parcela nota: type: string example: Pagamento realizado via PIX description: Nota adicional sobre a parcela conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador da conta financeira associada à parcela detalhe_valor: $ref: '#/components/schemas/ComposicaoValor' metodo_pagamento: type: string description: Método de pagamento da parcela example: PIX_PAGAMENTO_INSTANTANEO enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO - PIX_COBRANCA - DEBITO_AUTOMATICO ValorComposicaoDTO: type: object required: - valor_bruto properties: multa: type: number format: double example: 5 description: Valor da multa, deve ser maior ou igual a zero juros: type: number format: double example: 2.5 description: Valor dos juros, deve ser maior ou igual a zero valor_bruto: type: number format: double example: 150 description: Valor bruto, deve ser informado e maior ou igual a zero desconto: type: number format: double example: 10 description: Valor do desconto, deve ser maior ou igual a zero taxa: type: number format: double example: 3.75 description: Valor da taxa, deve ser maior ou igual a zero CategoriaDRE: type: object properties: id: type: string format: uuid description: id do item da categoria DRE example: a1b2c3d4-e5f6-7890-1234-567890abcdef descricao: type: string description: Descrição do item example: Receita Operacional Bruta codigo: type: string description: Código de identificação do item example: '01' posicao: type: integer format: int64 description: Ordem de posicionamento do item na estrutura example: 1 indica_totalizador: type: boolean description: Indica se o item é um totalizador de subitens example: true representa_soma_custo_medio: type: boolean description: Indica se o item representa a soma do custo médio do produto example: false subitens: type: array description: Lista de subitens aninhados items: $ref: '#/components/schemas/CategoriaDRE' categorias_financeiras: type: array description: Categorias financeiras associadas a este item da DRE items: $ref: '#/components/schemas/CategoriaFinanceira' CentroDeCustoResponse: type: object properties: itens_totais: type: integer example: 6 items: type: array items: $ref: '#/components/schemas/CentroDeCusto' totais: $ref: '#/components/schemas/Totais' ListaCondicaoPagamento: type: object required: - parcelas properties: parcelas: type: array items: $ref: '#/components/schemas/ParcelaCondicaoPagamento' description: Lista de parcelas da condição de pagamento CentroCustoParcela: type: object description: Estrutura resumida de centro de custo enviada em itens de parcela properties: id: type: string format: uuid example: 428389c6-4e74-11ee-a3eb-9b5f0f22a7c1 description: Identificador único do centro de custo nome: type: string example: Centro de custo de Teste description: Nome do centro de custo ComposicaoValor_2: 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 Item: type: object required: - id - quantidade - valor properties: id: type: string format: uuid description: id do item example: 123e4567-e89b-12d3-a456-426614174000 quantidade: type: integer description: Quantidade do produto example: 10 descricao: type: string description: Descrição do produto example: Produto 1 valor: type: number format: double description: Valor unitário do item example: 100 valor_custo: type: number format: double description: Valor de custo do item example: 100 ProtocolResponseDTO_2: type: object properties: id: type: string format: uuid description: Identificador do protocolo example: 123e4567-e89b-12d3-a456-426614174000 resposta: type: string description: Mensagem do protocolo example: Operação realizada com sucesso. status: type: string description: 'Status do protocolo: - PENDING: em processamento - SUCCESS: criado - ERROR: erro na criação' enum: - PENDING - SUCCESS - ERROR example: SUCCESS evento_financeiro_id: type: string format: uuid description: Identificador do evento financeiro example: 123e4567-e89b-12d3-a456-426614174000 TipoVariacao: type: object properties: id: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 descricao: type: string example: Tamanho opcoes: type: array items: $ref: '#/components/schemas/ProductVariationOptionResponse' Estoque: type: object properties: estoque_total: type: number format: double example: 100 valor_venda: type: number format: double example: 99.99 custo_medio: type: number format: double example: 50 estoque_disponivel: type: number format: double example: 80 estoque_minimo: type: number format: double example: 10 estoque_maximo: type: number format: double example: 200 Ecommerce: type: object properties: condicao: type: string example: NOVO enum: - NOVO - USADO integracao_ativa: type: boolean example: true descricao_adicional: type: string example: Descrição adicional do produto titulo_seo: type: string example: Título SEO descricao_seo: type: string example: Descrição SEO url_seo: type: string example: url-seo ParcelaAtualizacaoRequest: type: object required: - versao properties: nota: type: string description: Nota da parcela example: Pgto 3/5 descricao: type: string description: Descrição da parcela example: Valor líquido referente ao serviço prestado vencimento: type: string format: date example: '2024-07-15' composicao_valor: $ref: '#/components/schemas/ComposicaoValor' versao: type: integer example: 1 description: Sempre enviar o valor atual da versão data_pagamento_esperado: type: string format: date example: '2024-07-15' metodo_pagamento: type: string example: CARTAO_CREDITO enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO - PIX_COBRANCA - DEBITO_AUTOMATICO perda: $ref: '#/components/schemas/PerdaFinanceira' nsu: type: string example: '1029384756' pagamento_agendado: type: boolean example: false id_conta_financeira: type: string format: uuid example: e12a84ed-fb5c-4b8c-af56-4448b947337c ClienteOrcamento: type: object properties: email: description: Email do cliente type: string example: exemplo@email.com id: description: id do cliente type: string example: 123e4567-e89b-12d3-a456-426614174000 nome: description: Nome do cliente type: string example: João da Silva ItemOrcamentoPorFiltro: type: object properties: cliente: description: Cliente allOf: - $ref: '#/components/schemas/ClienteOrcamento' data_alteracao: description: Data de alteração do orçamento (ISO 8601, São Paulo/GMT-3) type: string example: '2025-10-17T02:00:08.841' data_criacao: description: Data de criação do orçamento type: string example: '2025-05-16T17:51:04.63' data_orcamento: description: Data do orçamento type: string example: '2023-12-31' id: description: id do orçamento type: string example: 123e4567-e89b-12d3-a456-426614174000 id_contrato: description: id do contrato type: string example: 123e4567-e89b-12d3-a456-426614174000 itens: description: Categoria dos itens incluídos no orçamento (PRODUTO, SERVICO, ou PRODUTO_E_SERVICO) allOf: - $ref: '#/components/schemas/TipoDeItens' example: PRODUTO numero: description: Número do orçamento type: integer example: 1001 origem: description: Origem do orçamento type: string example: NFE situacao: description: Situação do orçamento allOf: - $ref: '#/components/schemas/TipoDeSituacaoOrcamento' example: ORCAMENTO total: description: Total do orçamento type: number example: 1000 versao: description: Versão do orçamento type: integer example: 1 TipoOperacao: type: string enum: - VENDA - REMESSA - COMPRA - DEVOLUCAO example: VENDA Referencia: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b revisao: type: string example: '1' origem: type: string example: LANCAMENTO_FINANCEIRO enum: - LANCAMENTO_FINANCEIRO - DAS - FOLHA - TRANSFERENCIA - SALDO_CONTA_BANCARIA - VENDA - COMPRA - VENDA_AGENDADA - COMPRA_AGENDADA - IMPORTACAO_DOCUMENTO - IMPOSTO_RETIDO - SIC - NOTA_COMPRA - ANTECIPACAO - RENEGOCIACAO - HONORARIOS_CONTABEIS DescontoOrcamento: description: Modelo que representa o desconto de um orçamento type: object properties: tipo: description: Tipo do desconto (VALOR ou PORCENTAGEM) allOf: - $ref: '#/components/schemas/TipoDeDesconto' example: VALOR valor: description: Valor do desconto type: number example: 10 Situacao: type: object properties: nome: type: string example: Aprovado description: Nome da situação descricao: type: string example: Venda aprovada e processada description: Descrição da situação CategoriaRateio: type: object required: - id_categoria - valor properties: id_categoria: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da categoria valor: type: number format: decimal example: 100 description: Valor atribuído à categoria no rateio rateio_centro_custo: type: array items: $ref: '#/components/schemas/CentroCustoRateio' description: Lista de rateios por centro de custo BaixaCriacaoRequestDTO: type: object required: - data_pagamento - conta_financeira - composicao_valor properties: data_pagamento: type: string format: date example: '2023-10-01' description: Data do pagamento composicao_valor: $ref: '#/components/schemas/ValorComposicaoDTO' conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da conta financeira metodo_pagamento: type: string example: CARTAO_CREDITO description: Método de pagamento enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO observacao: type: string example: 'Pagamento referente à fatura #1234.' description: Observação nsu: type: string example: '1234567890' description: Número sequencial único EstruturaDRE: type: object properties: itens: type: array description: Lista principal de itens da DRE items: $ref: '#/components/schemas/CategoriaDRE' TipoDesconto: type: string example: VALOR enum: - PORCENTAGEM - VALOR ValorComposicaoRequest: type: object properties: frete: type: number format: double example: 100 description: Valor de frete. desconto: $ref: '#/components/schemas/DiscountMonolithTranslatedDTO' RenegociacaoContaAReceber: type: object description: Informações de renegociação. properties: id: type: string format: uuid description: Identificador único da renegociação. example: 43adf4e9-203c-4f7e-a0f6-08abf3f8a583 valor: type: number format: double description: Valor da renegociação. example: 25 id_evento: type: string format: uuid description: Identificador único do evento relacionado à renegociação. example: 6460daeb-6db1-4a50-a15d-b9dfb54200ca TipoDeExpiracao: description: Enum de tipo de expiração type: string enum: - DATA - VEZES - NUNCA x-enum-varnames: - EXPIRATION_TYPE_DATE - EXPIRATION_TYPE_TIMES - EXPIRATION_TYPE_FOREVER ContasAReceberResponse: type: object properties: itens_totais: type: integer example: 6 itens: type: array items: $ref: '#/components/schemas/ContaAReceber' totais: $ref: '#/components/schemas/Totais' TipoItemOrcamento: description: Enum de tipo de item de orçamento type: string enum: - PRODUTO - SERVICO x-enum-varnames: - PROPOSAL_PRODUCT - PROPOSAL_SERVICE ConfiguracaoPadraoCategoria: type: object description: Item do de-para entre uma operação financeira e a categoria configurada para o tenant properties: tipo_operacao: type: string description: 'Tipo da operação financeira. Valores possíveis: - `FRETES_RECEBIDOS`: Categoria para valor de frete inserido na venda. - `FRETES_PAGOS`: Categoria para valor de frete inserido na compra. - `IMPOSTOS_RETIDOS_EM_VENDAS`: Categoria para valor dos impostos retidos na venda. - `DESCONTOS_INCONDICIONAIS_OBTIDOS`: Categoria para descontos obtidos na compra. - `DESCONTOS_INCONDICIONAIS_CONCEDIDOS`: Categoria para descontos concedidos na venda. - `DESCONTOS_FINANCEIROS_OBTIDOS`: Categoria para descontos obtidos, no caso de baixas em despesas com desconto. - `DESCONTOS_FINANCEIROS_CONCEDIDOS`: Categoria para descontos concedidos, no caso de baixas em receitas com desconto. - `MULTAS_RECEBIDAS`: Categoria para multas recebidas, em baixas no Contas a receber. - `MULTAS_PAGAS`: Categoria para multas pagas, em baixas no Contas a pagar. - `JUROS_RECEBIDOS`: Categoria para juros recebidos em baixas no Contas a receber. - `JUROS_PAGOS`: Categoria para juros pagos, em baixas no Contas a pagar. - `TARIFAS`: Categorias para tarifas pagas, em baixas no contas a receber. - `PERDAS`: Categoria para perdas, quando a parcela é dada como perda no Contas a receber.' example: FRETES_RECEBIDOS enum: - FRETES_RECEBIDOS - FRETES_PAGOS - IMPOSTOS_RETIDOS_EM_VENDAS - DESCONTOS_INCONDICIONAIS_OBTIDOS - DESCONTOS_INCONDICIONAIS_CONCEDIDOS - DESCONTOS_FINANCEIROS_OBTIDOS - DESCONTOS_FINANCEIROS_CONCEDIDOS - MULTAS_RECEBIDAS - MULTAS_PAGAS - JUROS_RECEBIDOS - JUROS_PAGOS - TARIFAS - PERDAS id_categoria: type: string format: uuid nullable: true description: Identificador da categoria configurada para a operação example: e82ba6fd-a291-422f-8ef7-eb383205d743 nome_categoria: type: string nullable: true description: Nome da categoria configurada para a operação example: 0.5 categoria dre sugestao_padrao: $ref: '#/components/schemas/SugestaoPadrao' Parcela: type: object properties: evento: $ref: '#/components/schemas/Evento' id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b versao: type: integer format: int64 example: 1 referencia: type: string example: 5b04139f-fcca-4c64-8d01-1dd568eb420e indice: type: integer format: int32 example: 1 conciliado: type: boolean example: true status: description: PENDENTE é o mesmo que EM_ABERTO. QUITADO é mesmo que RECEBIDO type: string example: PENDENTE enum: - PENDENTE - QUITADO - CANCELADO - RENEGOCIADO - RECEBIDO_PARCIAL - ATRASADO - PERDIDO valor_pago: type: number format: double example: 10 perda: $ref: '#/components/schemas/PerdaFinanceira' nao_pago: type: number format: double example: 5 data_vencimento: type: string format: date example: '2025-09-05' data_pagamento_previsto: type: string format: date example: '2025-09-05' descricao: type: string example: Parcela do evento financeiro de contas a pagar nota: type: string example: A data de pagamento prevista é para 01/01/2030 conta_financeira: $ref: '#/components/schemas/ContaFinanceira' id_conta_financeira: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b valor_composicao: $ref: '#/components/schemas/ValorComposicao' metodo_pagamento: type: string example: DEPOSITO_BANCARIO enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO - PIX_COBRANCA - DEBITO_AUTOMATICO nsu: type: string example: 000215783210 baixa_agendada: type: boolean example: false baixas: type: array items: $ref: '#/components/schemas/Baixa' anexos: type: array items: $ref: '#/components/schemas/AnexoParcela' solicitacoes_cobrancas: type: array items: $ref: '#/components/schemas/SolicitacaoCobranca' id_ultima_solicitacao_pagamento: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b id_boleto_bancario_autorizado: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b fatura: $ref: '#/components/schemas/Fatura' data_alteracao: type: string description: Data de alteração da parcela (ISO 8601, São Paulo/GMT-3) format: date-time example: '2025-10-22T08:37:05' valor_total_liquido: type: number format: double example: 10 id_ultimo_solicitacao_cobranca: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b renegociacao: $ref: '#/components/schemas/Renegociacao' ContaFinanceira: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da conta financeira banco: type: string description: Instituição bancária example: BANCO_BRASIL enum: - BANCO_BRASIL - BRADESCO - CAIXA_ECONOMICA - HSBC - ITAU - INTER - ORIGINAL - SANTANDER - BANCOOB - BANESTES - BANPARA - BANRISUL - BCN - BANK_BOSTON - BANCO_BRASILIA - BANCO_NORDESTE - CITIBANK - CREDISAN - NOSSA_CAIXA - MERCANTIL - REAL - SAFRA - SICREDI - SUDAMERIS - UNIBANCO - SICOOB - AILOS - BS2 - NUBANK - UNICRED - NEON - C6 - CORA - ACESSO - STONE - AGIBANK - ASAAS - TOPAZIO - DAYCOVAL - BANCO_AMAZONIA - BANESE - BTG_PACTUAL - OMNI - GENIAL - CAPITAL - RIBEIRAO_PRETO - PAN - BMG - BNP_PARIBAS_BRASIL - CCR_SAO_MIGUEL_OESTE - CREDISIS - CRESOL - FITBANK - GERENCIANET - GLOBAL_SCM - JP_MORGAN - JUNO - MERCADO_PAGO - MODAL - MONEY_PLUS - NEXT - OTIMO - PAGSEGURO - PICPAY - PJBANK - POLOCRED - RENDIMENTO - UNIPRIME - UNIPRIME_NORTE_PARANA - VORTX_DTVM - BRL_TRUST - IUGU - OUTROS - NAO_BANCO codigo_banco: type: integer example: 1 description: Código da instituição bancária nome: type: string example: Conta Corrente description: Nome da conta financeira ativo: type: boolean example: true description: Indica se a conta está ativa tipo: type: string description: Tipo da conta example: APLICACAO enum: - APLICACAO - CAIXINHA - CONTA_CORRENTE - CARTAO_CREDITO - INVESTIMENTO - OUTROS - MEIOS_RECEBIMENTO - POUPANCA - COBRANCAS_CONTA_AZUL - RECEBA_FACIL_CARTAO conta_padrao: type: boolean example: true description: Indica se é a conta padrão possui_config_boleto_bancario: type: boolean example: false description: Indica se a conta possui configuração de boleto bancário agencia: type: string example: '001' description: Agência da conta numero: type: string example: '31' description: Número da conta SituacaoNegociacao: type: object properties: nome: enum: - EM_ANDAMENTO - APROVADO - FATURADO - CANCELADO - ORCAMENTO - ORCAMENTO_ACEITO - ORCAMENTO_RECUSADO - CONTRATO - VENDA description: Nome da situação example: APROVADO descricao: type: string description: Descrição da situação example: Aprovado ativado: type: boolean description: Ativado ou não example: true Dimensao: type: object properties: altura: type: number format: double example: 10 largura: type: number format: double example: 5 profundidade: type: number format: double example: 2 GerarCobrancaResponseDto: type: object properties: id: type: string format: uuid example: 35473eec-4e74-11ee-b500-9f61de8a8b8b description: Identificador único da cobrança url: type: string example: http://www.exemplo.com.br description: URL da cobrança status: type: string example: AGUARDANDO_CONFIRMACAO enum: - AGUARDANDO_CONFIRMACAO - EM_CANCELAMENTO - REGISTRADO - QUITADO - CANCELADO - INVALIDO - EXPIRADO - FALHA_EMISSAO - FALHA_CANCELAR - REMESSA_GERADO - REMESSA_PENDENTE - PAGO - EXTORNADO description: Status da cobrança TipoDeSituacaoOrcamento: description: Enum de tipo de situação de orçamento type: string enum: - ORCAMENTO - ORCAMENTO_ACEITO - ORCAMENTO_RECUSADO x-enum-varnames: - SITUATION_TYPE_FOR_PROPOSAL - SITUATION_TYPE_FOR_PROPOSAL_ACCEPTED - SITUATION_TYPE_FOR_PROPOSAL_REFUSED ParcelaContaFinanceira: type: object properties: id: type: string format: uuid example: 6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9 versao: type: integer example: 1 nome: type: string description: Nome do banco example: Conta Corrente agencia: type: string example: '001' numero: type: string example: '123' tipo: type: string example: OUTROS enum: - APLICACAO - CAIXINHA - CONTA_CORRENTE - CARTAO_CREDITO - INVESTIMENTO - OUTROS - MEIOS_RECEBIMENTO - POUPANCA - COBRANCAS_CONTA_AZUL - RECEBA_FACIL_CARTAO banco: type: string example: OUTROS enum: - BANCO_BRASIL - BRADESCO - CAIXA_ECONOMICA - HSBC - ITAU - INTER - ORIGINAL - SANTANDER - BANCOOB - BANESTES - BANPARA - BANRISUL - BCN - BANK_BOSTON - BANCO_BRASILIA - BANCO_NORDESTE - CITIBANK - CREDISAN - NOSSA_CAIXA - MERCANTIL - REAL - SAFRA - SICREDI - SUDAMERIS - UNIBANCO - SICOOB - AILOS - BS2 - NUBANK - UNICRED - NEON - C6 - CORA - ACESSO - STONE - AGIBANK - ASAAS - TOPAZIO - DAYCOVAL - BANCO_AMAZONIA - BANESE - BTG_PACTUAL - OMNI - GENIAL - CAPITAL - RIBEIRAO_PRETO - PAN - BMG - BNP_PARIBAS_BRASIL - CCR_SAO_MIGUEL_OESTE - CREDISIS - CRESOL - FITBANK - GERENCIANET - GLOBAL_SCM - JP_MORGAN - JUNO - MERCADO_PAGO - MODAL - MONEY_PLUS - NEXT - OTIMO - PAGSEGURO - PICPAY - PJBANK - POLOCRED - RENDIMENTO - UNIPRIME - UNIPRIME_NORTE_PARANA - VORTX_DTVM - BRL_TRUST - IUGU - OUTROS - NAO_BANCO Desconto: type: object required: - tipo - valor properties: tipo: type: string description: Tipo de desconto enum: - PORCENTAGEM - VALOR example: PORCENTAGEM valor: type: number format: double description: Valor do desconto example: 10 ParcelaResponse: 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: Descrição da parcela numero: type: integer example: 1 description: Número da parcela GerarCobrancaRequestAtributosDescontoAntecipado: type: object description: 'Deverá ser informado apenas um dos campos: valor ou percentual' properties: valor: type: number format: double example: 10 description: Quando informado, o campo "percentual" deve ser omitido percentual: type: number format: double example: 10 description: Quando informado, o campo "valor" deve ser omitido dias_antes_vencer: type: integer example: 10 description: Dias antes do vencimento para aplicar o desconto antecipado QuantidadesVenda: type: object description: Quantidades de vendas com status Aprovado, Cancelado, Esperando aprovação e Total 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: Quantidade de vendas esperando aprovação example: 2 ComposicaoValor: type: object required: - valor_bruto properties: multa: type: number example: 100.25 description: Valor da multa juros: type: number example: 1.5 description: Valor dos juros valor_bruto: type: number example: 275.99 description: Valor bruto da parcela valor_liquido: type: number example: 250.33 description: Valor líquido da parcela desconto: type: number example: 2.1 description: Valor do desconto taxa: type: number example: 4.4 description: Valor da taxa NegociadorContaAPagarOuReceber: type: object properties: id: type: string example: 35473eec-4e74-11ee-b500-9f61de8a8b8b nome: type: string example: Maria da Silva Termo: type: object required: - tipo_frequencia - tipo_expiracao - data_inicio - data_fim - numero properties: tipo_frequencia: type: string enum: - MENSAL - ANUAL example: MENSAL tipo_expiracao: type: string enum: - DATA - NUNCA example: DATA data_inicio: type: string format: date description: Data de início example: '2021-01-01' data_fim: type: string format: date description: Data de fim example: '2021-12-31' intervalo_frequencia: type: integer description: Intervalo de frequência deve ser sempre maior ou igual a 1 example: 1 dia_emissao_venda: type: integer description: Dia de emissão do contrato example: 1 numero: type: integer description: O número do contrato deve ser único example: 1 ComposicaoDeValor: type: object properties: frete: type: number format: double description: Valor do frete example: 10 desconto: $ref: '#/components/schemas/Desconto' TipoDeItens: description: Enum de tipo de itens type: string enum: - PRODUTO - SERVICO - PRODUTO_E_SERVICO x-enum-varnames: - ItemsTypeProduto - ItemsTypeServico - ItemsTypeProdutoEServico ParcelaAtualizacaoResponse: type: object properties: nota: type: string description: Nota da parcela example: Pgto 3/5 descricao: type: string description: Descrição da parcela example: Valor líquido referente ao serviço prestado vencimento: type: string format: date example: '2024-07-15' composicao_valor: $ref: '#/components/schemas/ComposicaoValor' versao: type: integer example: 1 description: Nova versão da parcela após salvar as alterações data_pagamento_esperado: type: string format: date example: '2024-07-15' metodo_pagamento: type: string example: CARTAO_CREDITO enum: - DINHEIRO - CARTAO_CREDITO - BOLETO_BANCARIO - CARTAO_CREDITO_VIA_LINK - CHEQUE - CARTAO_DEBITO - TRANSFERENCIA_BANCARIA - OUTRO - CARTEIRA_DIGITAL - CASHBACK - CREDITO_LOJA - CREDITO_VIRTUAL - DEPOSITO_BANCARIO - PIX_PAGAMENTO_INSTANTANEO - PROGRAMA_FIDELIDADE - SEM_PAGAMENTO - VALE_ALIMENTACAO - VALE_COMBUSTIVEL - VALE_PRESENTE - VALE_REFEICAO - PIX_COBRANCA - DEBITO_AUTOMATICO perda: $ref: '#/components/schemas/PerdaFinanceira' nsu: type: string example: '1029384756' pagamento_agendado: type: boolean example: false conta_financeira: $ref: '#/components/schemas/ParcelaContaFinanceira' CondicaoPagamento_2: type: object properties: quantidade_parcelas: type: integer example: 10 montante_fixo: type: boolean example: false Notificacao: type: object properties: id_referencia: type: string example: notificacao-123456 description: id de referência da notificação 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' ItensTotaisNegociacao: 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 securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: Token de autorização Bearer JWT