{ "swagger": "2.0", "info": { "version": "v1", "title": "API de Integração SIGE Cloud", "description": "O SIGE Cloud é um ERP para micro e pequenas empresas cujo foco está na melhoria contínua de suas funcionalidades, sempre visando a simplicidade e produtividade aos seus clientes. Desta forma para que seus clientes tivessem uma maneira de integrar seus sistemas legados, foi desenvolvida uma API de Integração. " }, "host": "api.sigecloud.com.br", "schemes": [ "http", "https" ], "paths": { "/request/Boletos/Pesquisar": { "get": { "tags": [ "Boletos" ], "summary": "Busca pelos boletos emitidos no sistema ERP, ordenados pela data de vencimento (do mais recente para o mais antigo)", "operationId": "Boletos_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nossoNumero", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "numeroDoDocumento", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "codigoDoLancamento", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "nomeSacado", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "contaBancaria", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pago", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "remessaEnviada", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "dataInicial", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "tipoData", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Valor deve ser maior que zero. Representa a quantidade de registros por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados para compor a página atual", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/BoletoRetornoBusca" } } } } } }, "/request/Boletos/HTML": { "get": { "tags": [ "Boletos" ], "operationId": "Boletos_HTML", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "boletoID", "in": "query", "required": true, "type": "string" }, { "name": "download", "in": "query", "required": false, "type": "boolean" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/CEP/Get": { "get": { "tags": [ "Buscar Endereço pelo CEP" ], "summary": "Este método destina-se exclusivamente à consulta de CEP no sistema, retornando uma entidade CEP, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "CEP_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "cep", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CEP" } } } } }, "/request/Categoria/Get": { "get": { "tags": [ "Categoria de Produtos" ], "summary": "Este método destina-se à consulta de categorias de produtos no sistema, retornando um array de entidade Categoria, sendo que devem ser feitas requisições GET através do módulo do cliente para a API de Integração.", "operationId": "Categoria_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProdutoCategoria" } } } } } }, "/request/Configuracoes/Get": { "get": { "tags": [ "Configurações do ERP" ], "summary": "Este método destina-se exclusivamente à consulta das configurações do E-Commerce no sistema, retornando uma entidade Configuração, sendo que devem ser feitas requisições GET através do módulo do cliente para a API de Integração", "operationId": "Configuracoes_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Configuracoes" } } } } }, "/request/Contratos/DownloadContrato": { "get": { "tags": [ "Contratos" ], "summary": "Este método destina-se ao download de contratos cadastrados no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração", "operationId": "Contratos_DownloadContrato", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Codigo", "in": "query", "description": "Código do contrato a ser baixado", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Contratos/Rescindir": { "post": { "tags": [ "Contratos" ], "summary": "Este método destina-se a rescisao de contratos cadastrados no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Rescindir", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código do Contrato", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Contratos/Criar": { "post": { "tags": [ "Contratos" ], "summary": "Este método destina-se a criação de contratos no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Criar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contratoAPI", "in": "body", "description": "Dados do contrato", "required": true, "schema": { "$ref": "#/definitions/Contrato" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Contratos/Remover": { "post": { "tags": [ "Contratos" ], "summary": "Este método destina-se a exclusão de contratos cadastrados no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Remover", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código do Contrato", "required": true, "type": "number", "format": "double" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "delete": { "tags": [ "Contratos" ], "summary": "Este método destina-se a exclusão de contratos cadastrados no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Remover", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código do Contrato", "required": true, "type": "number", "format": "double" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Contratos/Atualizar": { "put": { "tags": [ "Contratos" ], "summary": "Este método destina-se a atualização de contratos cadastrados no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Atualizar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contratoAPI", "in": "body", "description": "Dados do Contrato", "required": true, "schema": { "$ref": "#/definitions/Contrato" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Contratos" ], "summary": "Este método destina-se a atualização de contratos cadastrados no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Atualizar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "contratoAPI", "in": "body", "description": "Dados do Contrato", "required": true, "schema": { "$ref": "#/definitions/Contrato" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Contratos/GetAll": { "get": { "tags": [ "Contratos" ], "summary": "Este método destina-se a busca de contratos cadastrados no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Contratos_GetAll", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageSize", "in": "query", "description": "Quantidade de registros para retorno", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Quantidade de registros a serem pulados", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Contratos/Pesquisar": { "get": { "tags": [ "Contratos" ], "summary": "Este método destina-se a busca de contratos cadastrados no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Contratos_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": false, "type": "number", "format": "double" }, { "name": "cliente", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "planoDeContas", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "formaDePagamento", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "empresa", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "contaBancaria", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "situacao", "in": "query", "description": "0 = Todos, 1 = Ativo, 2 = Carência/Suspensão, 3 = Eventual, 4 = Acordo Contratual, 5 = Em Processo Judicial, 6 = Rescindido", "required": false, "type": "string", "enum": [ "Todos", "Ativo", "CarenciaSuspensao", "Eventual", "AcordoContratual", "EmProcessoJudicial", "Rescindido" ] }, { "name": "periodoReajuste", "in": "query", "description": "0 = Próximo Reajuste, 1 = Último Reajuste", "required": false, "type": "string", "enum": [ "ProximoReajuste", "UltimoReajuste" ] }, { "name": "dataInicialReajuste", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinalReajuste", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "periodo", "in": "query", "description": "0 = Início Contrato, 1 = Término Contrato", "required": false, "type": "string", "enum": [ "InicioContrato", "TerminoContrato" ] }, { "name": "dataInicial", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "pageSize", "in": "query", "description": "Quantidade de registro a retornar", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Quantidade de registros a serem pulados", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Depositos/GetTodosDepositos": { "get": { "tags": [ "Depósitos" ], "summary": "Retorna todos os depósitos cadastrados no sistema", "operationId": "Depositos_GetTodosDepositos", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Deposito" } } } } } }, "/request/Empresas/GetTodasEmpresas": { "get": { "tags": [ "Empresas" ], "summary": "Retorna todas as empresas cadastradas no sistema", "operationId": "Empresas_GetTodasEmpresas", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Empresa" } } } } } }, "/request/Equipamentos/Pesquisar": { "get": { "tags": [ "Equipamentos" ], "summary": "Pesquise pelos equipamentos registrados no sistema ERP", "operationId": "Equipamentos_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nome", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "modelo", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "fabricante", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Valor deve ser maior que zero. Representa a quantidade de registros por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados para compor a página atual", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Equipamento" } } } } } }, "/request/Equipamentos/Criar": { "post": { "tags": [ "Equipamentos" ], "summary": "Endpoint para criação de novo equipamento", "operationId": "Equipamentos_Criar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [], "parameters": [ { "name": "equipamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Equipamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Equipamentos/Atualizar": { "put": { "tags": [ "Equipamentos" ], "summary": "Endpoint para atualização de equipamento existente", "operationId": "Equipamentos_Atualizar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [], "parameters": [ { "name": "id", "in": "query", "description": "Identificador único do equipamento no sistema ERP", "required": true, "type": "string" }, { "name": "equipamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Equipamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Equipamentos/Excluir": { "delete": { "tags": [ "Equipamentos" ], "operationId": "Equipamentos_Excluir", "consumes": [], "produces": [], "parameters": [ { "name": "id", "in": "query", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Estoque/BuscarQuantidades": { "get": { "tags": [ "Estoque" ], "summary": "Este método destina-se somente a consulta de movimentações de estoque no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Estoque_BuscarQuantidades", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "deposito", "in": "query", "description": "O depósito a ser consultado", "required": true, "type": "string" }, { "name": "visivelCatalogo", "in": "query", "description": "Filtra somente por produtos visiveis no catalogo", "required": false, "type": "boolean" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Expedicao/Buscar": { "get": { "tags": [ "Expedição" ], "summary": "Este método destina-se a busca de ordens de expedição cadastrados no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Expedicao_Buscar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados", "required": false, "type": "integer", "format": "int32" }, { "name": "transportadora", "in": "query", "description": "Transportadora da expedição", "required": false, "type": "string" }, { "name": "status", "in": "query", "description": "0-Aguardando, 1-Cancelada, 2-Em Separação, 3-Pronta Para Despacho, 4-Despachada", "required": false, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "dataInicial", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "filtrarPor", "in": "query", "description": "0-Data emissão, 1-Data despacho", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/RetornoBuscaExpedicao" } } } } } }, "/request/Fiscal/InformacoesVenda": { "get": { "tags": [ "Fiscal" ], "summary": "Este método destina-se a busca de informações fiscais vinculadas a vendas cadastradas no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Fiscal_InformacoesVenda", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Codigo", "in": "query", "description": "Código da Venda", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Fiscal/ConsultarNFE": { "get": { "tags": [ "Fiscal" ], "summary": "Este método destina-se a busca de informações fiscais vinculadas a uma NFe emitida no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Fiscal_ConsultarNFE", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "CodigoNFe", "in": "query", "description": "Número da NFe/NFCe", "required": true, "type": "integer", "format": "int32" }, { "name": "SerieNFe", "in": "query", "description": "Série da NFe/NFCe", "required": false, "type": "string" }, { "name": "CNPJEmpresaEmissora", "in": "query", "description": "CNPJ da Empresa Emissora", "required": false, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Fiscal/EmitirNFCE": { "post": { "tags": [ "Fiscal" ], "summary": "Este método destina-se a emitir NFCe a partir do código da venda", "operationId": "Fiscal_EmitirNFCE", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "CodigoVenda", "in": "query", "description": "Código da Venda", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Fiscal/EmitirNFE": { "post": { "tags": [ "Fiscal" ], "summary": "Este método destina-se a emitir NFe a partir do código da venda", "operationId": "Fiscal_EmitirNFE", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "CodigoVenda", "in": "query", "description": "", "required": true, "type": "integer", "format": "int64" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/FormasPagamento/GetTodasFormasPagamento": { "get": { "tags": [ "Formas de Pagamento" ], "summary": "Busca todas as formas de pagamento do sistema", "operationId": "FormasPagamento_GetTodasFormasPagamento", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/FormaPagamento" } } } } } }, "/request/FormasPagamento/Pesquisar": { "get": { "tags": [ "Formas de Pagamento" ], "summary": "Buscar as formas de pagamento registradas no ERP", "operationId": "FormasPagamento_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nome", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Valor deve ser maior que zero. Representa a quantidade de registros por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados para compor a página atual", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/FormaPagamento" } } } } } }, "/request/FormasPagamento/Criar": { "post": { "tags": [ "Formas de Pagamento" ], "summary": "Endpoint para criar novas formas de pagamento no sistema ERP", "operationId": "FormasPagamento_Criar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [], "parameters": [ { "name": "formaPagamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/FormaPagamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/FormasPagamento/Atualizar": { "put": { "tags": [ "Formas de Pagamento" ], "summary": "Endpoint para atualizar uma forma de pagamento existente no sistema ERP", "operationId": "FormasPagamento_Atualizar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [], "parameters": [ { "name": "id", "in": "query", "description": "ID da forma de pagamento no sistema", "required": true, "type": "string" }, { "name": "formaPagamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/FormaPagamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/FormasPagamento/Excluir": { "delete": { "tags": [ "Formas de Pagamento" ], "summary": "Endpoint para removar uma forma de pagamento no sistema ERP", "operationId": "FormasPagamento_Excluir", "consumes": [], "produces": [], "parameters": [ { "name": "id", "in": "query", "description": "ID da forma de pagamento no sistema", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/ProdutosFotos/GetImagemPrincipalByProduto": { "get": { "tags": [ "Imagens dos Produtos" ], "summary": "Este método destina-se exclusivamente à consulta da foto principal dos produtos no sistema, retornando um entidade ProdutoFoto, sendo que devem ser feitas requisições GET através do módulo do cliente para a API de Integração", "operationId": "ProdutosFotos_GetImagemPrincipalByProduto", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigoProduto", "in": "query", "description": "Código do produto no sistema", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProdutoFoto" } } } } }, "/request/ProdutosFotos/GetImagensByProduto": { "get": { "tags": [ "Imagens dos Produtos" ], "summary": "Este método destina-se exclusivamente à consulta das fotos dos produtos no sistema, retornando uma lista de entidade ProdutoFoto, sendo que devem ser feitas requisições GET através do módulo do cliente para a API de Integração.", "operationId": "ProdutosFotos_GetImagensByProduto", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigoProduto", "in": "query", "description": "Código do produto no sistema", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProdutoFoto" } } } } } }, "/request/ProdutosFotos/GetImagem": { "get": { "tags": [ "Imagens dos Produtos" ], "summary": "Este método destina-se exclusivamente à consulta das fotos dos produtos no sistema, retornando um array de bytes se a imagem é ou não uma miniatura, sendo que devem ser feitas requisições GET através do módulo do cliente para a API de Integração.", "operationId": "ProdutosFotos_GetImagem", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "imagemId", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "miniatura", "in": "query", "description": "", "required": true, "type": "boolean" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "format": "byte", "type": "string" } } } } }, "/request/ProdutosFotos/SaveImagem": { "post": { "tags": [ "Imagens dos Produtos" ], "summary": "Salva uma nova imagem no sistema", "operationId": "ProdutosFotos_SaveImagem", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "foto", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/NovaFotoProduto" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Lancamentos/Pesquisar": { "get": { "tags": [ "Lançamentos Financeiros" ], "summary": "Busca por lançamentos financeiros no sistema conforme os filtros", "operationId": "Lancamentos_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "documento", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "boleto", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "descricao", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "clienteFornecedor", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "planoDeContas", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "formaDePagamento", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "empresa", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "contaBancaria", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "grupo", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "somenteConciliados", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "tipo", "in": "query", "description": "", "required": false, "type": "string", "enum": [ "TODOS", "RECEITAS", "DESPESAS" ] }, { "name": "situacao", "in": "query", "description": "", "required": false, "type": "string", "enum": [ "TODAS", "QUITADOS", "NAOQUITADOS" ] }, { "name": "filtrarPor", "in": "query", "description": "", "required": false, "type": "string", "enum": [ "VENCIMENTO", "QUITACAO", "COMPETENCIA" ] }, { "name": "dataInicial", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "alteradoApos", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "pageSize", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/LancamentoRetornoBusca" } } } } } }, "/request/Lancamentos/GetAll": { "get": { "tags": [ "Lançamentos Financeiros" ], "summary": "Retorna todos os lançamentos financeiros de forma paginada", "operationId": "Lancamentos_GetAll", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageSize", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/LancamentoRetornoBusca" } } } } } }, "/request/Lancamentos/Get": { "get": { "tags": [ "Lançamentos Financeiros" ], "summary": "Busca um lançamento pelo seu código sequencial", "operationId": "Lancamentos_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LancamentoRetornoBusca" } } } } }, "/request/Lancamentos/Criar": { "post": { "tags": [ "Lançamentos Financeiros" ], "summary": "Método para criar um novo lançamento financeiro", "operationId": "Lancamentos_Criar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "lancamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Lancamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "format": "int32", "type": "integer" } } } } } }, "/request/Lancamentos/Atualizar": { "post": { "tags": [ "Lançamentos Financeiros" ], "summary": "Atualiza um lançamento financeiro já existente", "operationId": "Lancamentos_Atualizar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "lancamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Lancamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "format": "int32", "type": "integer" } } } } }, "/request/Lancamentos/Remover": { "get": { "tags": [ "Lançamentos Financeiros" ], "summary": "Remove um lançamento financeiro através do seu código sequencial", "operationId": "Lancamentos_Remover", "consumes": [], "produces": [], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } }, "delete": { "tags": [ "Lançamentos Financeiros" ], "summary": "Remove um lançamento financeiro através do seu código sequencial", "operationId": "Lancamentos_Remover", "consumes": [], "produces": [], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Lancamentos/AdicionarPagamentos": { "post": { "tags": [ "Lançamentos Financeiros" ], "summary": "Adiciona um pagamento para um lançamento existente no sistema. O código do lançamento é informado no corpo da requisição", "operationId": "Lancamentos_AdicionarPagamentos", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [], "parameters": [ { "name": "pagamentoLancamento", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PagamentoLancamento" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Lancamentos/RemoverTodosPagamentos": { "post": { "tags": [ "Lançamentos Financeiros" ], "summary": "Remover todos os pagamentos de um lançamento", "operationId": "Lancamentos_RemoverTodosPagamentos", "consumes": [], "produces": [], "parameters": [ { "name": "codigo", "in": "query", "description": "Código sequencial do lançamento", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Marca/Get": { "get": { "tags": [ "Marca" ], "summary": "Retorna todas as marca cadastradas no sistema", "operationId": "Marca_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ProdutoMarca" } } } } } }, "/request/ProdutosEstoque/Salvar": { "put": { "tags": [ "Movimentações de Estoque" ], "summary": "Salva uma nova movimentação de estoque", "operationId": "ProdutosEstoque_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "movimentacao", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EstoqueMovimentacao" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Movimentações de Estoque" ], "summary": "Salva uma nova movimentação de estoque", "operationId": "ProdutosEstoque_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "movimentacao", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EstoqueMovimentacao" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/OperacoesPDV/Salvar": { "put": { "tags": [ "Operações de Caixa - PDV" ], "summary": "Este método destina-se ao registro de uma operação no PDV no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OperacoesPDV_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "operacao", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OperacaoPDV" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Operações de Caixa - PDV" ], "summary": "Este método destina-se ao registro de uma operação no PDV no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OperacoesPDV_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "operacao", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/OperacaoPDV" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/OperacoesPDV/Pesquisar": { "get": { "tags": [ "Operações de Caixa - PDV" ], "operationId": "OperacoesPDV_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "caixa", "in": "query", "required": false, "type": "string" }, { "name": "realizador", "in": "query", "required": false, "type": "string" }, { "name": "tipoOperacaoPDV", "in": "query", "required": false, "type": "string", "enum": [ "ABERTURA", "FECHAMENTO", "SANGRIA", "REFORCO", "DEVOLUCAOMERCADORIA", "TROCAMERCADORIA", "MOSTRARSALDO" ] }, { "name": "dataInicial", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/OperacaoPDV" } } } } } }, "/request/Oportunidades/Cadastrar": { "post": { "tags": [ "Oportunidades" ], "summary": "Cadastra uma nova oportunidade no sistema", "operationId": "Oportunidades_Cadastrar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "oportunidadeAPI", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Oportunidade" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Oportunidades/Atualizar": { "post": { "tags": [ "Oportunidades" ], "summary": "Atualiza uma oportunidade existente no sistema", "operationId": "Oportunidades_Atualizar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "oportunidadeAPI", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Oportunidade" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Oportunidades/AdicionarInteracoes": { "post": { "tags": [ "Oportunidades" ], "summary": "Adiciona uma interação em uma oportunidade já cadastrada no sistema", "operationId": "Oportunidades_AdicionarInteracoes", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "AdicionarInteracoes", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Interacoes" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Oportunidades/Pesquisar": { "get": { "tags": [ "Oportunidades" ], "summary": "Pesquisa por oportunidades cadastradas no sistema conforme os filtros", "operationId": "Oportunidades_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "empresa", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "cliente", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "categoriaFunil", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "statusFunil", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "responsavel", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "contato", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "origemOportunidade", "in": "query", "description": "0-IndicacaoExterna, 1-IndicacaoInterna, 2-BocaABoca, 3- Web, 4-Campanha, 5-Parceiro, 6-Loja, 7-PontoDeVendasExterno, 8-Flayer, 9-Radio, 10-JornalImpresso, 11-Outros", "required": false, "type": "string", "enum": [ "IndicacaoExterna", "IndicacaoInterna", "BocaABoca", "Web", "Campanha", "Parceiro", "Loja", "PontoDeVendasExterno", "Flayer", "Radio", "JornalImpresso", "Outros" ] }, { "name": "nomeOrigem", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "situacaoNegociacao", "in": "query", "description": "0-Aberto; 1-Cancelada; 2-Concluida.", "required": false, "type": "string", "enum": [ "Aberto", "Cancelada", "Concluida" ] }, { "name": "dataFechamento", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataAbertura", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "dataPrevisaoFechamento", "in": "query", "description": "", "required": false, "type": "string", "format": "date-time" }, { "name": "pageSize", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/OrdensProducao/Pesquisar": { "get": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente a consulta de Ordens de Produção cadastradas no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código da Ordem", "required": false, "type": "integer", "format": "int32" }, { "name": "codigoPedido", "in": "query", "description": "Códgio do Pedido da Ordem", "required": false, "type": "integer", "format": "int32" }, { "name": "situacao", "in": "query", "description": "Situação da Ordem", "required": false, "type": "string", "enum": [ "Aguardando", "Iniciado", "AvaliadoQA", "Concluido", "Cancelado" ] }, { "name": "status", "in": "query", "description": "Status da Ordem", "required": false, "type": "string" }, { "name": "filtrarPor", "in": "query", "description": "Parametro para pesquisa das datas: data de cadastro (0), data de aprovação do orçamento (1), data aprovação do pedido (2), data de faturamento do pedido (3)", "required": false, "type": "string", "enum": [ "PrevisaoInicio", "PrevisaoTermino", "DataInicio", "DataAvaliacao", "DataTermino" ] }, { "name": "dataInicial", "in": "query", "description": "Data inicial para pesquisa", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "description": "Data final para pesquisa", "required": false, "type": "string", "format": "date-time" }, { "name": "pageSize", "in": "query", "description": "Número Máximo de resultados retornados por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Número de resultados a serem “pulados”", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrdemProducaoRetorno" } } } } } }, "/request/OrdensProducao/Excluir": { "post": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente à exclusão de Ordens de Produção no sistema, sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_Excluir", "consumes": [], "produces": [], "parameters": [ { "name": "codigo", "in": "query", "description": "Código da Ordem", "required": true, "type": "integer", "format": "int32" }, { "name": "empresa", "in": "query", "description": "Empresa da Ordem", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/OrdensProducao/Cadastrar": { "post": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente ao cadastro de Ordens de Produção no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_Cadastrar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "ordemProducaoAPI", "in": "body", "description": "Dados da Ordem de Produção", "required": true, "schema": { "$ref": "#/definitions/OrdemProducao" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/request/OrdensProducao/AvaliacaoConcluida": { "post": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente para concluir a avaliação da Ordem de Produção no sistema, sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_AvaliacaoConcluida", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "ordemProducaoAvaliacao", "in": "body", "description": "Dados da Avaliacao da Ordem de Produção", "required": true, "schema": { "$ref": "#/definitions/OrdemProducaoAvaliacao" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/request/OrdensProducao/Finalizar": { "post": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente para finalizar a Ordem de Produção no sistema, sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_Finalizar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código da Ordem de Produção", "required": true, "type": "integer", "format": "int32" }, { "name": "manterPrevisao", "in": "query", "description": "Se deve manter a previsão", "required": false, "type": "boolean" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/request/OrdensProducao/BuscarCheckListQualidade": { "get": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente para buscar checklist da Ordem de Produção no sistema, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_BuscarCheckListQualidade", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código da Ordem de Produção", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/CheckListInfo" } } } } } }, "/request/OrdensProducao/AdicionarHistorico": { "post": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente para adicionar o histórico da Ordem de Produção no sistema, sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_AdicionarHistorico", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "historico", "in": "body", "description": "Histórico da Ordem de Produção", "required": true, "schema": { "$ref": "#/definitions/HistoricoOrdemProducao" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } } } }, "/request/OrdensProducao/Impressoes": { "get": { "tags": [ "Ordens de Produção - PCP" ], "summary": "Este método destina-se exclusivamente para buscar impressoes da Ordem de Produção no sistema, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "OrdensProducao_Impressoes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código da Ordem de Produção", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object", "additionalProperties": { "type": "string" } } } } } }, "/request/Pedidos/Pesquisar": { "get": { "tags": [ "Pedidos, Orçamentos e Ordens de Serviço" ], "summary": "Este método destina-se exclusivamente a consulta de pedidos cadastrados no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Pedidos_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código de pedido", "required": false, "type": "integer", "format": "int64" }, { "name": "origem", "in": "query", "description": "Origem do pedido", "required": false, "type": "string" }, { "name": "status", "in": "query", "description": "Status do pedido", "required": false, "type": "string" }, { "name": "statuscliente", "in": "query", "description": "Status do cliente inserido na venda", "required": false, "type": "string" }, { "name": "categoria", "in": "query", "description": "A categoria da venda", "required": false, "type": "string" }, { "name": "cliente", "in": "query", "description": "Nome/Razão Social do cliente relacionado ao pedido", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Número Máximo de resultados retornados por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Número de resultados a serem “pulados”", "required": false, "type": "integer", "format": "int32" }, { "name": "cpf_cnpj", "in": "query", "description": "CPF/CNPJ do cliente relacionado ao pedido", "required": false, "type": "string" }, { "name": "alteradoApos", "in": "query", "description": "Vendas alteradas após determinada data", "required": false, "type": "string", "format": "date-time" }, { "name": "dataInicial", "in": "query", "description": "Data inicial para pesquisa", "required": false, "type": "string", "format": "date-time" }, { "name": "dataFinal", "in": "query", "description": "Data final para pesquisa", "required": false, "type": "string", "format": "date-time" }, { "name": "filtrarPor", "in": "query", "description": "Parametro para pesquisa das datas: data de cadastro (0), data de aprovação do orçamento (1), data aprovação do pedido (2), data de faturamento do pedido (3)", "required": false, "type": "string", "enum": [ "DataCadastro", "DataAprovacaoOrcamento", "DataAprovacaoPedido", "DataFaturamentoPedido" ] }, { "name": "empresa", "in": "query", "description": "A empresa realizadora da venda", "required": false, "type": "string" }, { "name": "numeroNFe", "in": "query", "description": "Numero da Nfe/NFCe gerada a partir da venda", "required": false, "type": "string" }, { "name": "vendedor", "in": "query", "description": "Vendedor da venda", "required": false, "type": "string" }, { "name": "transportadora", "in": "query", "description": "Transportadora da venda", "required": false, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Pedidos/Salvar": { "put": { "tags": [ "Pedidos, Orçamentos e Ordens de Serviço" ], "summary": "Este método destina-se ao cadastro e alteração de pedidos no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.\r\nCabe ressaltar que a alteração é realiza quando é enviada para a API de Integração uma requisição contendo um pedido/os com o código já existente em um pedido cadastrado no sistema, \r\nsendo que o pedido existente é sobrescrito pelo novo pedido enviado a API de Integração.", "operationId": "Pedidos_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pedido", "in": "body", "description": "Dados do Pedido", "required": true, "schema": { "$ref": "#/definitions/Pedido" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Pedidos, Orçamentos e Ordens de Serviço" ], "summary": "Este método destina-se ao cadastro e alteração de pedidos no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.\r\nCabe ressaltar que a alteração é realiza quando é enviada para a API de Integração uma requisição contendo um pedido/os com o código já existente em um pedido cadastrado no sistema, \r\nsendo que o pedido existente é sobrescrito pelo novo pedido enviado a API de Integração.", "operationId": "Pedidos_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pedido", "in": "body", "description": "Dados do Pedido", "required": true, "schema": { "$ref": "#/definitions/Pedido" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Pedidos/SalvarEFaturar": { "put": { "tags": [ "Pedidos, Orçamentos e Ordens de Serviço" ], "summary": "Este método destina-se ao cadastro e alteração de pedidos no sistema fazendo o faturamento do pedido, as requisições devem ser feitas por POST através do modulo do cliente para a API de Integração.", "operationId": "Pedidos_SalvarEFaturar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pedido", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Pedido" } }, { "name": "retornarPedido", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Pedidos, Orçamentos e Ordens de Serviço" ], "summary": "Este método destina-se ao cadastro e alteração de pedidos no sistema fazendo o faturamento do pedido, as requisições devem ser feitas por POST através do modulo do cliente para a API de Integração.", "operationId": "Pedidos_SalvarEFaturar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pedido", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Pedido" } }, { "name": "retornarPedido", "in": "query", "description": "", "required": false, "type": "boolean" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Pedidos/GetTodosPedidos": { "get": { "tags": [ "Pedidos, Orçamentos e Ordens de Serviço" ], "summary": "Este método destina-se exclusivamente a consulta de pedidos cadastrados no sistema sendo que deve ser feita uma requisição GET através do modulo do cliente para a API de Integração.", "operationId": "Pedidos_GetTodosPedidos", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "page", "in": "query", "description": "Número de páginas de resultado a serem \"puladas\"", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pedido" } } } } } }, "/request/Pessoas/Pesquisar": { "get": { "tags": [ "Pessoas" ], "summary": "Este método destina-se exclusivamente a consulta de pessoas cadastradas no sistema sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Pessoas_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nomefantasia", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "cpfcnpj", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "cidade", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "uf", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "cliente", "in": "query", "description": "Indica se a filtragem deve considerar apenas clientes", "required": false, "type": "boolean" }, { "name": "fornecedor", "in": "query", "description": "Indica se a filtragem deve considerar apenas fornecedores", "required": false, "type": "boolean" }, { "name": "alteradoapos", "in": "query", "description": "Busca as pessoas alteradas no sistema após a data informada", "required": false, "type": "string", "format": "date-time" }, { "name": "grupo", "in": "query", "description": "Busca as pessoas desse grupo de pessoas", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Número máximo de resultados retornados por pagina", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Número de resultados a serem “pulados”", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pessoa" } } } } } }, "/request/Pessoas/GetAll": { "get": { "tags": [ "Pessoas" ], "operationId": "Pessoas_GetAll", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Pessoa" } } } } } }, "/request/Pessoas/ConsultaInadimplencias": { "get": { "tags": [ "Pessoas" ], "summary": "Este método destina-se exclusivamente a consulta de inadimplencias de pessoas cadastradas no sistema, retornando uma lista de entidade Consulta inadimplencia, sendo que deve ser feita uma requisição GET através do modulo do cliente para a API de Integração, sendo obrigatório informar pelo menos um dos parâmetros.", "operationId": "Pessoas_ConsultaInadimplencias", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nomeFantasia", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "cpfCnpj", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Pessoas/Salvar": { "put": { "tags": [ "Pessoas" ], "summary": "Este método destina-se ao cadastro e alteração de clientes/fornecedores no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.\r\nCabe ressaltar que a alteração é realiza quando é enviada para a API de Integração uma requisição contendo uma pessoa com um CPF/CNPJ já existente em uma pessoa cadastrada no sistema, sendo que a pessoa existente é sobrescrita pela nova pessoa enviada a API de Integração.", "operationId": "Pessoas_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pessoa", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Pessoa" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Pessoas" ], "summary": "Este método destina-se ao cadastro e alteração de clientes/fornecedores no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.\r\nCabe ressaltar que a alteração é realiza quando é enviada para a API de Integração uma requisição contendo uma pessoa com um CPF/CNPJ já existente em uma pessoa cadastrada no sistema, sendo que a pessoa existente é sobrescrita pela nova pessoa enviada a API de Integração.", "operationId": "Pessoas_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pessoa", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/Pessoa" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/PlanosConta/Pesquisar": { "get": { "tags": [ "Planos de Contas" ], "summary": "Busca pelos boletos emitidos no sistema ERP, ordenados pela data de vencimento (do mais recente para o mais antigo)", "operationId": "PlanosConta_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nome", "in": "query", "required": false, "type": "string" }, { "name": "tipoLancamento", "in": "query", "required": false, "type": "string" }, { "name": "somentePrimeiroNivel", "in": "query", "required": false, "type": "boolean" }, { "name": "pageSize", "in": "query", "description": "Valor deve ser maior que zero. Representa a quantidade de registros por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados para compor a página atual", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/PlanoDeContaRetornoBusca" } } } } } }, "/request/Produtos/Pesquisar": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à pesquisa de produtos cadastrados no sistema, retornando uma lista de entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código do produto", "required": false, "type": "string" }, { "name": "numeroSerie", "in": "query", "description": "Número de série do produto", "required": false, "type": "string" }, { "name": "nome", "in": "query", "description": "Nome do produto", "required": false, "type": "string" }, { "name": "genero", "in": "query", "description": "Indica o gênero do produto", "required": false, "type": "string" }, { "name": "categoria", "in": "query", "description": "Indica a categoria do produto", "required": false, "type": "string" }, { "name": "marca", "in": "query", "description": "Indica a marca do produto", "required": false, "type": "string" }, { "name": "deposito", "in": "query", "description": "Deposito para trazer o saldo do produto", "required": false, "type": "string" }, { "name": "ean", "in": "query", "description": "Código de Barras", "required": false, "type": "string" }, { "name": "alteradoApos", "in": "query", "description": "Data de alteração do objeto no sistema", "required": false, "type": "string", "format": "date-time" }, { "name": "pageSize", "in": "query", "description": "Numero de resultados retornados por pagina. Valor máximo permitido 100", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Numero de paginas de resultado a serem “puladas”", "required": false, "type": "integer", "format": "int32" }, { "name": "modelo", "in": "query", "description": "Modelo do produto", "required": false, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Produto" } } } } } }, "/request/Produtos/GetAll": { "get": { "tags": [ "Produtos" ], "operationId": "Produtos_GetAll", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Produto" } } } } } }, "/request/Produtos/Get": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos no sistema, retornando uma entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_Get", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código do produto", "required": false, "type": "string" }, { "name": "ean", "in": "query", "description": "Código de Barras", "required": false, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Produto" } } } } }, "/request/Produtos/PesquisaEcommerce": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando uma lista de entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_PesquisaEcommerce", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pesquisa", "in": "query", "description": "Nome do produto a ser pesquisado", "required": true, "type": "string" }, { "name": "categoria", "in": "query", "description": "Categoria do produto no E-commerce", "required": true, "type": "string" }, { "name": "marca", "in": "query", "description": "Marca do produto no E-commerce", "required": true, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Número Maximo de resultados retornados por pagina", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Número de paginas de resultado a serem “puladas”", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Produto" } } } } } }, "/request/Produtos/PesquisaEcommerceCount": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando o cálculo de produtos, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração", "operationId": "Produtos_PesquisaEcommerceCount", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pesquisa", "in": "query", "description": "Nome do produto a ser pesquisado", "required": true, "type": "string" }, { "name": "categoria", "in": "query", "description": "Categoria do produto no E-commerce", "required": true, "type": "string" }, { "name": "marca", "in": "query", "description": "Marca do produto no E-commerce", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "format": "int64", "type": "integer" } } } } }, "/request/Produtos/TodosEcommerce": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando uma lista de entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_TodosEcommerce", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "pageSize", "in": "query", "description": "Número máximo de resultados retornados por pagina", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Número de paginas de resultado a serem “puladas”", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Produto" } } } } } }, "/request/Produtos/TodosEcommerceCount": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando o cálculo das listas de produtos, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_TodosEcommerceCount", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "format": "int64", "type": "integer" } } } } }, "/request/Produtos/GetByNomeWebEcommerce": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando uma entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_GetByNomeWebEcommerce", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nomeWeb", "in": "query", "description": "Nome web do produto", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Produto" } } } } }, "/request/Produtos/GetByCodigoEcommerce": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando uma entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_GetByCodigoEcommerce", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "Código do produto", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Produto" } } } } }, "/request/Produtos/GetSaldo": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos no sistema, retornando uma lista com os saldos do produto em estoque, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração", "operationId": "Produtos_GetSaldo", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "produtoCodigo", "in": "query", "description": "O código do produto", "required": true, "type": "string" }, { "name": "deposito", "in": "query", "description": "Nome/ID do depósito a ser consultado", "required": true, "type": "string" }, { "name": "alteradosAposData", "in": "query", "description": "Data da última movimentação do depósito no sistema", "required": false, "type": "string", "format": "date-time" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/SaldoDeposito" } } } } } }, "/request/Produtos/ProdutosRelacionadosEcommerce": { "get": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à consulta de produtos do E-commerce no sistema, retornando uma lista de entidade Produto, sendo que devem ser feitas requisições GET através do modulo do cliente para a API de Integração.", "operationId": "Produtos_ProdutosRelacionadosEcommerce", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "categoria", "in": "query", "description": "Categoria do produto no E-commerce", "required": true, "type": "string" }, { "name": "marca", "in": "query", "description": "Marca do produto no E-commerce", "required": true, "type": "string" }, { "name": "quantidade", "in": "query", "description": "Quantidade de produto no E-commerce", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Produto" } } } } } }, "/request/Produtos/Salvar": { "put": { "tags": [ "Produtos" ], "summary": "Este método destina-se ao cadastro e alteração de produtos no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Produtos_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "produto", "in": "body", "description": "Dados do Produto", "required": true, "schema": { "$ref": "#/definitions/Produto" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Produtos" ], "summary": "Este método destina-se ao cadastro e alteração de produtos no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração.", "operationId": "Produtos_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "produto", "in": "body", "description": "Dados do Produto", "required": true, "schema": { "$ref": "#/definitions/Produto" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Produtos/Excluir": { "delete": { "tags": [ "Produtos" ], "summary": "Este método destina-se exclusivamente à exclusão de produtos no sistema, sendo que devem ser feitas requisições DELETE através do modulo do cliente para a API de Integração.", "operationId": "Produtos_Excluir", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "codigo", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/SaldosBancarios/Pesquisar": { "get": { "tags": [ "Saldos Bancários" ], "summary": "Retorna o saldo por conta bancária registrado no sistema ERP", "operationId": "SaldosBancarios_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "empresaNomeFantasia", "in": "query", "description": "Filtre pelas contas bancárias de uma empresa específica", "required": false, "type": "string" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GSaldoBancos" } } } } }, "/request/TabelasPreco/Pesquisar": { "get": { "tags": [ "Tabelas de Preço" ], "summary": "Busca as tabelas de preço cadastradas no sistema", "operationId": "TabelasPreco_Pesquisar", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "nome", "in": "query", "description": "", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Valor deve ser maior que zero. Representa a quantidade de registros por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados para compor a página atual", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/TabelaPreco" } } } } } }, "/request/TabelasPreco/Produtos": { "get": { "tags": [ "Tabelas de Preço" ], "summary": "Busca os produtos e respectivos preços por tabela de preço", "operationId": "TabelasPreco_Produtos", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "tabelaId", "in": "query", "description": "ID da tabela no sistema", "required": true, "type": "string" }, { "name": "produto", "in": "query", "description": "Nome ou Código do Produto", "required": false, "type": "string" }, { "name": "categoria", "in": "query", "description": "Nome da Categoria", "required": false, "type": "string" }, { "name": "marca", "in": "query", "description": "Nome da Marca", "required": false, "type": "string" }, { "name": "pageSize", "in": "query", "description": "Valor deve ser maior que zero. Representa a quantidade de registros por página", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "O número de registros a serem pulados para compor a página atual", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/PrecoProdutoTabela" } } } } } }, "/request/TranferenciasBancarias/Pesquisar": { "post": { "tags": [ "Transferências Bancárias" ], "summary": "Este método destina-se à Pesquisa de Transferências Bancárias no sistema sendo que devem ser feitas requisições POST através do modulo do cliente para a API de Integração", "operationId": "TranferenciasBancarias_Pesquisar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "filtros", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TranferenciasBancariasFiltro" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/TransferenciaBancaria" } } } } } }, "/request/TranferenciasBancarias/Salvar": { "put": { "tags": [ "Transferências Bancárias" ], "summary": "Salva uma nova transferência bancária no sistema", "operationId": "TranferenciasBancarias_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transf", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransferenciaBancaria" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } }, "post": { "tags": [ "Transferências Bancárias" ], "summary": "Salva uma nova transferência bancária no sistema", "operationId": "TranferenciasBancarias_Salvar", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "transf", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/TransferenciaBancaria" } }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Usuarios/Foto": { "post": { "tags": [ "Usuarios" ], "summary": "Upload da foto do usuário", "operationId": "Usuarios_Foto", "consumes": [ "application/form-data" ], "produces": [], "parameters": [ { "name": "userName", "in": "query", "description": "E-mail de acesso do usuário", "required": true, "type": "string" }, { "name": "File", "in": "formData", "description": "Upload photo", "required": true, "type": "file" }, { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } } } }, "/request/Public/Ping": { "get": { "tags": [ "Verificar o status de servico da API" ], "summary": "Consulta Status da API", "operationId": "Public_Ping", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/request/Public/Version": { "get": { "tags": [ "Verificar o status de servico da API" ], "summary": "Consulta Version da API", "operationId": "Public_Version", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization-Token", "in": "header", "required": true, "type": "string" }, { "name": "User", "in": "header", "required": true, "type": "string" }, { "name": "App", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } } }, "definitions": { "BoletoRetornoBusca": { "type": "object", "properties": { "Id": { "type": "string" }, "BoletoCodigo": { "format": "int64", "type": "integer" }, "NumeroDocumento": { "type": "string" }, "ValorBoleto": { "format": "double", "type": "number" }, "Sacado": { "type": "string" }, "ContaBancaria": { "type": "string" }, "Carteira": { "type": "string" }, "Pago": { "type": "boolean" }, "Cancelado": { "type": "boolean" }, "Estornado": { "type": "boolean" }, "RemessaEnviada": { "type": "boolean" }, "RetornoRecebido": { "type": "boolean" }, "NossoNumero": { "type": "string" }, "LogradouroSacado": { "type": "string" }, "LogradouroNumeroSacado": { "type": "string" }, "ComplementoSacado": { "type": "string" }, "BairroSacado": { "type": "string" }, "CidadeSacado": { "type": "string" }, "CPF_CNPJSacado": { "type": "string" }, "UF": { "type": "string" }, "CEPSacado": { "type": "string" }, "EmailSacado": { "type": "string" }, "TelefoneSacado": { "type": "string" }, "Empresa": { "type": "string" }, "ComRegistro": { "type": "boolean" }, "Descricao": { "type": "string" }, "DataVencimento": { "format": "date-time", "type": "string" }, "DataEmissao": { "format": "date-time", "type": "string" }, "MultaAposVencimento": { "format": "double", "type": "number" }, "JurosDiaAposVencimento": { "format": "double", "type": "number" }, "DescontoAntecipacao": { "format": "double", "type": "number" }, "Instrucoes": { "type": "string" }, "BancoEmiteBoleto": { "type": "boolean" }, "NumerosLancamentos": { "type": "string" }, "Protestar": { "type": "boolean" }, "ProtestoDias": { "format": "int32", "type": "integer" }, "ModoContagemProtesto": { "enum": [ "DIASCORRIDOS", "DIASUTEIS" ], "type": "string" }, "Devolver": { "type": "boolean" }, "DevolucaoDias": { "format": "int32", "type": "integer" }, "ModoContagemDevolucao": { "enum": [ "DIASCORRIDOS", "DIASUTEIS" ], "type": "string" }, "DataEmailEnviado": { "format": "date-time", "type": "string" }, "DataEmailRecebido": { "format": "date-time", "type": "string" }, "DataRecebimentoEmail": { "type": "string" }, "EmailRecebido": { "type": "boolean" }, "ImprimeComprovanteRecebimento": { "type": "boolean" }, "TipoEndereco": { "type": "string" } } }, "CEP": { "type": "object", "properties": { "CEPNumero": { "type": "string" }, "Bairro": { "type": "string" }, "MunicipioCodigo": { "type": "string" }, "MunicipioNome": { "type": "string" }, "EstadoNome": { "type": "string" }, "EstadoUF": { "type": "string" }, "EstadoCodigoUF": { "type": "string" }, "Logradouro": { "type": "string" } } }, "ProdutoCategoria": { "type": "object", "properties": { "Hierarquia": { "type": "string" }, "Nome": { "type": "string" }, "Descricao": { "type": "string" } } }, "Configuracoes": { "type": "object", "properties": { "EcommerceEmpresaPadrao": { "type": "string" }, "EcommerceDepositoPadrao": { "type": "string" }, "EcommerceTabelaPrecoPadrao": { "type": "string" }, "EcommerceParcelasCartao": { "format": "int32", "type": "integer" }, "EcommerceIgnorarFreteValorAcimaDe": { "format": "double", "type": "number" }, "EcommerceValorMinimo": { "format": "double", "type": "number" } } }, "Contrato": { "type": "object", "properties": { "Codigo": { "format": "double", "type": "number" }, "FaturarContrato": { "type": "boolean" }, "Empresa": { "type": "string" }, "ClienteFornecedor": { "type": "string" }, "Tipo": { "type": "string" }, "PlanoDeConta": { "type": "string" }, "FormaDePagamento": { "type": "string" }, "CentroDeCustos": { "type": "string" }, "ContaBancaria": { "type": "string" }, "Situacao": { "enum": [ "Ativo", "CarenciaSuspensao", "Eventual", "AcordoContratual", "EmProcessoJudicial", "Rescindido" ], "type": "string" }, "DiaPagamentoVencimento": { "format": "int32", "type": "integer" }, "QuantidadeDuracao": { "format": "int32", "type": "integer" }, "PeriodoDuracao": { "enum": [ "Dias", "Semanas", "Meses" ], "type": "string" }, "ProximoReajuste": { "format": "date-time", "type": "string" }, "DataInicio": { "format": "date-time", "type": "string" }, "DiasCarencia": { "format": "int32", "type": "integer" }, "ValorTotal": { "format": "double", "type": "number" }, "NumeroParcelas": { "format": "int32", "type": "integer" }, "Intervalo": { "enum": [ "Meses", "Dias", "PeriodosParcelamento" ], "type": "string" }, "DiasPeriodoParcelamento": { "format": "int32", "type": "integer" }, "Entrada": { "format": "double", "type": "number" }, "DuplicatasManuais": { "type": "array", "items": { "$ref": "#/definitions/DuplicataManual" } }, "Vendedor": { "type": "string" }, "ComissaoVendedor": { "format": "float", "type": "number" }, "Observacoes": { "type": "string" } } }, "DuplicataManual": { "type": "object", "properties": { "Numero": { "format": "int32", "type": "integer" }, "DataVencimento": { "format": "date-time", "type": "string" }, "Valor": { "format": "double", "type": "number" } } }, "Deposito": { "type": "object", "properties": { "ID": { "type": "string" }, "Nome": { "type": "string" }, "EmpresaID": { "type": "string" }, "Empresa": { "type": "string" } } }, "Empresa": { "type": "object", "properties": { "ID": { "type": "string" }, "NomeFantasia": { "type": "string" }, "RazaoSocial": { "type": "string" }, "CNPJ": { "type": "string" } } }, "Equipamento": { "type": "object", "properties": { "Id": { "type": "string" }, "Codigo": { "type": "string" }, "Nome": { "type": "string" }, "Modelo": { "type": "string" }, "Fabricante": { "type": "string" }, "NumeroPatrimonio": { "type": "string" }, "NumeroControle": { "type": "string" }, "Cliente": { "type": "string" } } }, "RetornoBuscaExpedicao": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "CodigosVenda": { "type": "array", "items": { "type": "string" } }, "Empresa": { "type": "string" }, "Status": { "type": "string" }, "DataEmissao": { "format": "date-time", "type": "string" }, "DataDespacho": { "format": "date-time", "type": "string" }, "Transportadora": { "type": "string" }, "ResponsavelSeparacao": { "type": "string" }, "ResponsavelDespacho": { "type": "string" }, "Observacoes": { "type": "string" }, "UrlImpressaoOrdem": { "type": "string" }, "UrlImpressaoEtiquetas": { "type": "string" } } }, "FormaPagamento": { "type": "object", "properties": { "ID": { "type": "string" }, "Nome": { "type": "string" }, "IgnorarLimiteCredito": { "type": "boolean" }, "DesativarFormaPagamento": { "type": "boolean" }, "IgnorarTotalizadoresCaixa": { "type": "boolean" } } }, "ProdutoFoto": { "type": "object", "properties": { "Id": { "type": "string" }, "Principal": { "type": "boolean" } } }, "NovaFotoProduto": { "type": "object", "properties": { "ProdutoId": { "type": "string" }, "ProdutoCodigo": { "type": "string" }, "ImagemId": { "type": "string" }, "Imagem": { "type": "string" }, "Principal": { "type": "boolean" } } }, "LancamentoRetornoBusca": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "UltimaAlteracao": { "format": "date-time", "type": "string" }, "DataCompetencia": { "format": "date-time", "type": "string" }, "DataVencimento": { "format": "date-time", "type": "string" }, "DataVencimentoOriginal": { "format": "date-time", "type": "string" }, "DataQuitacao": { "format": "date-time", "type": "string" }, "Empresa": { "type": "string" }, "Cliente": { "type": "string" }, "NumeroDocumento": { "type": "string" }, "Descricao": { "type": "string" }, "Observacoes": { "type": "string" }, "Quitado": { "type": "boolean" }, "Conciliado": { "type": "boolean" }, "EhDespesa": { "type": "boolean" }, "PlanoDeConta": { "type": "string" }, "CentroDeCusto": { "type": "string" }, "CentrosDeCusto": { "type": "array", "items": { "$ref": "#/definitions/CostCenter" } }, "ContaBancaria": { "type": "string" }, "FormaPagamento": { "type": "string" }, "LancamentoGrupo": { "type": "string" }, "Valor": { "format": "double", "type": "number" }, "TotalRecebido": { "format": "double", "type": "number" }, "Pagamentos": { "type": "array", "items": { "$ref": "#/definitions/PagamentoLancamentos" } }, "NumeroBoleto": { "format": "int64", "type": "integer" }, "NumeroNFSe": { "format": "int64", "type": "integer" }, "CodigoVenda": { "format": "int64", "type": "integer" }, "CodigoContrato": { "format": "int64", "type": "integer" }, "Parcelas": { "type": "array", "items": { "$ref": "#/definitions/ParcelaLancamentos" } }, "JurosPagamentos": { "format": "double", "type": "number" }, "MultaPagamentos": { "format": "double", "type": "number" } } }, "CostCenter": { "type": "object", "properties": { "porcentage": { "format": "double", "type": "number" }, "Id": { "type": "string" }, "name": { "type": "string" } } }, "PagamentoLancamentos": { "type": "object", "properties": { "Data": { "format": "date-time", "type": "string" }, "FormaPagamento": { "type": "string" }, "NumeroDocumento": { "type": "string" }, "ContaBancaria": { "type": "string" }, "Conciliado": { "type": "boolean" }, "Valor": { "format": "double", "type": "number" } } }, "ParcelaLancamentos": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "DataVencimento": { "format": "date-time", "type": "string" }, "Documento": { "type": "string" }, "ValorParcela": { "format": "double", "type": "number" }, "Quitado": { "type": "boolean" }, "DataQuitacao": { "format": "date-time", "type": "string" }, "ValorPago": { "format": "double", "type": "number" } } }, "Lancamento": { "type": "object", "properties": { "DataVencimentoOriginal": { "format": "date-time", "type": "string" }, "Codigo": { "format": "int32", "type": "integer" }, "DataCompetencia": { "format": "date-time", "type": "string" }, "DataVencimento": { "format": "date-time", "type": "string" }, "Empresa": { "type": "string" }, "Cliente": { "type": "string" }, "NumeroDocumento": { "type": "string" }, "Descricao": { "type": "string" }, "Observacoes": { "type": "string" }, "Quitado": { "type": "boolean" }, "DataQuitacao": { "format": "date-time", "type": "string" }, "Conciliado": { "type": "boolean" }, "EhDespesa": { "type": "boolean" }, "PlanoDeConta": { "type": "string" }, "CentroDeCusto": { "type": "string" }, "CentrosDeCusto": { "type": "array", "items": { "$ref": "#/definitions/CostCenter" } }, "ContaBancaria": { "type": "string" }, "FormaPagamento": { "type": "string" }, "LancamentoGrupo": { "type": "string" }, "Valor": { "format": "double", "type": "number" }, "TotalRecebido": { "format": "double", "type": "number" }, "Pagamentos": { "type": "array", "items": { "$ref": "#/definitions/Pagamento" } }, "ModoParcelamento": { "enum": [ "NaoParcelar", "ParcelamentoAutomatico", "RecorrenciaAutomatica", "ParcelamentoManual" ], "type": "string" }, "Intervalo": { "enum": [ "Meses", "Dias", "PeriodosParcelamento" ], "type": "string" }, "DiasIntervalo": { "format": "int32", "type": "integer" }, "NumeroParcelas": { "format": "int32", "type": "integer" }, "Parcelas": { "type": "array", "items": { "$ref": "#/definitions/ParcelamentoManual" } } } }, "Pagamento": { "type": "object", "properties": { "Data": { "format": "date-time", "type": "string" }, "FormaPagamento": { "type": "string" }, "NumeroDocumento": { "type": "string" }, "ContaBancaria": { "type": "string" }, "Conciliado": { "type": "boolean" }, "Valor": { "format": "double", "type": "number" } } }, "ParcelamentoManual": { "type": "object", "properties": { "DataVencimento": { "format": "date-time", "type": "string" }, "Documento": { "type": "string" }, "ValorParcela": { "format": "double", "type": "number" }, "Quitado": { "type": "boolean" }, "DataQuitacao": { "format": "date-time", "type": "string" }, "TotalRecebido": { "format": "double", "type": "number" } } }, "PagamentoLancamento": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "Pagamentos": { "type": "array", "items": { "$ref": "#/definitions/Pagamento" } } } }, "ProdutoMarca": { "type": "object", "properties": { "Nome": { "type": "string" } } }, "EstoqueMovimentacao": { "type": "object", "properties": { "ProdutoCodigo": { "type": "string" }, "DepositoNome": { "type": "string" }, "Quantidade": { "format": "double", "type": "number" }, "EhEntrada": { "type": "boolean" } } }, "OperacaoPDV": { "type": "object", "properties": { "TipoOperacao": { "format": "int32", "type": "integer" }, "Caixa": { "type": "string" }, "CaixaID": { "type": "string" }, "Empresa": { "type": "string" }, "EmpresaID": { "type": "string" }, "Usuario": { "type": "string" }, "UsuarioID": { "type": "string" }, "Motivo": { "type": "string" }, "Valores": { "type": "array", "items": { "$ref": "#/definitions/SaldoCaixa" } }, "CodigoVenda": { "type": "string" }, "ProdutosVenda": { "type": "array", "items": { "$ref": "#/definitions/ProdutosVenda" } } } }, "SaldoCaixa": { "type": "object", "properties": { "FormaDePagamento": { "type": "string" }, "Valor": { "format": "double", "type": "number" } } }, "ProdutosVenda": { "type": "object", "properties": { "Nome": { "type": "string" }, "Codigo": { "type": "string" }, "Quantidade": { "format": "double", "type": "number" }, "NumerosSerie": { "type": "array", "items": { "type": "string" } } } }, "Oportunidade": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "Empresa": { "type": "string" }, "Cliente": { "type": "string" }, "CategoriaFunil": { "type": "string" }, "StatusFunil": { "type": "string" }, "Responsavel": { "type": "string" }, "Descricao": { "type": "string" }, "DataAbertura": { "format": "date-time", "type": "string" }, "PrevisaoFechamentoNegocio": { "format": "date-time", "type": "string" }, "ProbabilidadeFechamento": { "format": "float", "type": "number" }, "ValorNegocio": { "format": "double", "type": "number" }, "Contato": { "type": "string" }, "TelefoneContato": { "type": "string" }, "EmailContato": { "type": "string" }, "Origem": { "enum": [ "IndicacaoExterna", "IndicacaoInterna", "BocaABoca", "Web", "Campanha", "Parceiro", "Loja", "PontoDeVendasExterno", "Flayer", "Radio", "JornalImpresso", "Outros" ], "type": "string" }, "NomeOrigem": { "type": "string" }, "SituacaoNegociacao": { "enum": [ "Aberto", "Cancelada", "Concluida" ], "type": "string" }, "DataEncerramento": { "format": "date-time", "type": "string" }, "MotivoCancelamento": { "type": "string" }, "Campanha": { "type": "string" }, "Interacoes": { "type": "array", "items": { "$ref": "#/definitions/Interacao" } } } }, "Interacao": { "type": "object", "properties": { "DataCadastro": { "format": "date-time", "type": "string" }, "DataRealizacao": { "format": "date-time", "type": "string" }, "Realizador": { "enum": [ "Cliente", "NossaEmpresa" ], "type": "string" }, "Descricao": { "type": "string" }, "Concluida": { "type": "boolean" } } }, "Interacoes": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "InteracoesOportunidade": { "type": "array", "items": { "$ref": "#/definitions/Interacao" } } } }, "OrdemProducaoRetorno": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "CodigoPedido": { "format": "int64", "type": "integer" }, "Empresa": { "type": "string" }, "Deposito": { "type": "string" }, "Produtos": { "type": "array", "items": { "$ref": "#/definitions/ProdutoOPRetorno" } }, "Situacao": { "type": "string" }, "ResponsavelProducao": { "type": "string" }, "ResponsavelQualidade": { "type": "string" }, "ResponsavelFinalizacao": { "type": "string" }, "PrevisaoInicio": { "format": "date-time", "type": "string" }, "PrevisaoTermino": { "format": "date-time", "type": "string" }, "DataInicio": { "format": "date-time", "type": "string" }, "DataTermino": { "format": "date-time", "type": "string" }, "ValidadeLote": { "format": "date-time", "type": "string" }, "Observacoes": { "type": "string" }, "CheckList": { "type": "array", "items": { "$ref": "#/definitions/CheckListInfoRetorno" } }, "Historicos": { "type": "array", "items": { "$ref": "#/definitions/HistoricoRetorno" } } } }, "ProdutoOPRetorno": { "type": "object", "properties": { "Produto": { "type": "string" }, "Codigo": { "type": "string" }, "Quantidade": { "format": "double", "type": "number" }, "QuantidadeProduzida": { "format": "double", "type": "number" }, "QuantidadeDescartada": { "format": "double", "type": "number" }, "Unidade": { "type": "string" }, "Lote": { "type": "string" }, "AtributosGrade": { "type": "array", "items": { "$ref": "#/definitions/Atributo" } } } }, "CheckListInfoRetorno": { "type": "object", "properties": { "Descricao": { "type": "string" }, "NivelPrioridade": { "format": "int32", "type": "integer" }, "NivelComplexidade": { "format": "int32", "type": "integer" }, "Validado": { "type": "boolean" }, "Observacoes": { "type": "string" } } }, "HistoricoRetorno": { "type": "object", "properties": { "Data": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "Observacoes": { "type": "string" } } }, "Atributo": { "type": "object", "properties": { "Nome": { "type": "string" }, "Valor": { "type": "string" } } }, "OrdemProducao": { "type": "object", "properties": { "Iniciar": { "type": "boolean" }, "Codigo": { "format": "int32", "type": "integer" }, "CodigoPedido": { "format": "int32", "type": "integer" }, "Empresa": { "type": "string" }, "EmpresaID": { "type": "string" }, "Deposito": { "type": "string" }, "DepositoID": { "type": "string" }, "ResponsavelProducao": { "type": "string" }, "ResponsavelQualidade": { "type": "string" }, "ResponsavelFinalizacao": { "type": "string" }, "PrevisaoInicio": { "format": "date-time", "type": "string" }, "PrevisaoTermino": { "format": "date-time", "type": "string" }, "Observacoes": { "type": "string" }, "Produtos": { "type": "array", "items": { "$ref": "#/definitions/OrdemProducaoProduto" } }, "Validade": { "format": "date-time", "type": "string" }, "Historico": { "type": "array", "items": { "$ref": "#/definitions/Historico" } } } }, "OrdemProducaoProduto": { "type": "object", "properties": { "Codigo": { "format": "int64", "type": "integer" }, "SKU": { "type": "string" }, "Quantidade": { "format": "double", "type": "number" }, "Lote": { "type": "string" }, "AtributosGrade": { "type": "array", "items": { "$ref": "#/definitions/Atributo" } } } }, "Historico": { "type": "object", "properties": { "Data": { "format": "date-time", "type": "string" }, "Status": { "type": "string" }, "Observacoes": { "type": "string" } } }, "OrdemProducaoAvaliacao": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "Avaliacao": { "type": "string" }, "Observacoes": { "type": "string" }, "CheckList": { "type": "array", "items": { "$ref": "#/definitions/CheckList" } }, "ProdutosAvaliacao": { "type": "array", "items": { "$ref": "#/definitions/OrdemProducaoAvaliacaoProduto" } } } }, "CheckList": { "type": "object", "properties": { "Descricao": { "type": "string" }, "Validado": { "type": "boolean" }, "Observacoes": { "type": "string" } } }, "OrdemProducaoAvaliacaoProduto": { "type": "object", "properties": { "NomeProduto": { "type": "string" }, "QuantidadeProduzida": { "format": "double", "type": "number" }, "Descarte": { "format": "double", "type": "number" } } }, "CheckListInfo": { "type": "object", "properties": { "Ordem": { "format": "int32", "type": "integer" }, "Descricao": { "type": "string" }, "NivelPrioridade": { "format": "int32", "type": "integer" }, "NivelComplexidade": { "format": "int32", "type": "integer" }, "Validado": { "type": "boolean" }, "Observacoes": { "type": "string" } } }, "HistoricoOrdemProducao": { "type": "object", "properties": { "Codigo": { "format": "int32", "type": "integer" }, "Historico": { "type": "array", "items": { "$ref": "#/definitions/Historico" } } } }, "Pedido": { "type": "object", "properties": { "ID": { "type": "string" }, "AndroidVendaID": { "type": "string" }, "Codigo": { "format": "int64", "type": "integer" }, "OrigemVenda": { "type": "string" }, "DepositoID": { "type": "string" }, "Tabela": { "type": "string" }, "TabelaID": { "type": "string" }, "Deposito": { "type": "string" }, "StatusSistema": { "type": "string" }, "Status": { "type": "string" }, "Categoria": { "type": "string" }, "Validade": { "format": "date-time", "type": "string" }, "Empresa": { "type": "string" }, "EmpresaID": { "type": "string" }, "ClienteID": { "type": "string" }, "Cliente": { "type": "string" }, "PessoaID": { "type": "string" }, "ClienteCNPJ": { "type": "string" }, "ClienteEmail": { "type": "string" }, "Vendedor": { "type": "string" }, "VendedorID": { "type": "string" }, "PlanoDeConta": { "type": "string" }, "FormaPagamento": { "type": "string" }, "FormaPagamentoID": { "type": "string" }, "NumeroParcelas": { "format": "int32", "type": "integer" }, "FreteMeioEnvio": { "format": "int32", "type": "integer" }, "Transportadora": { "type": "string" }, "FreteFormaEnvio": { "type": "string" }, "DataEnvio": { "format": "date-time", "type": "string" }, "PrevisaoEntrega": { "format": "date-time", "type": "string" }, "DataPostagem": { "format": "date-time", "type": "string" }, "Enviado": { "type": "boolean" }, "ValorFrete": { "format": "double", "type": "number" }, "FreteContaEmitente": { "type": "boolean" }, "CodigoRastreio": { "type": "string" }, "EnderecoOpcional": { "type": "boolean" }, "ValorSeguro": { "format": "double", "type": "number" }, "Descricao": { "type": "string" }, "OutrasDespesas": { "format": "double", "type": "number" }, "TransacaoCartao": { "type": "string" }, "ValorFinal": { "format": "double", "type": "number" }, "Finalizado": { "type": "boolean" }, "Lancado": { "type": "boolean" }, "Municipio": { "type": "string" }, "CodigoMunicipio": { "type": "string" }, "Pais": { "type": "string" }, "CEP": { "type": "string" }, "UF": { "type": "string" }, "UFCodigo": { "type": "string" }, "Bairro": { "type": "string" }, "Logradouro": { "type": "string" }, "LogradouroNumero": { "type": "string" }, "LogradouroComplemento": { "type": "string" }, "GruposProdutos": { "type": "array", "items": { "$ref": "#/definitions/ProductGroup" } }, "Items": { "type": "array", "items": { "$ref": "#/definitions/PedidoProduto" } }, "Banco": { "type": "string" }, "Data": { "format": "date-time", "type": "string" }, "Pagamentos": { "type": "array", "items": { "$ref": "#/definitions/PagamentoPedido" } }, "LancarComissaoVendedor": { "type": "boolean" }, "ValorComissaoVendedor": { "format": "double", "type": "number" }, "NumeroNFe": { "type": "string" }, "DataFaturamento": { "format": "date-time", "type": "string" }, "ChaveAcessoNFe": { "type": "string" }, "DanfeURL": { "type": "string" }, "UrlSefaz": { "type": "string" }, "OrdemServico": { "$ref": "#/definitions/OS" }, "CodigoPedidoCliente": { "type": "string" }, "DataAprovacaoPedido": { "format": "date-time", "type": "string" } }, "example": { "Codigo": 123456, "OrigemVenda": "PDV", "Tabela": "Tabela Padrão", "Deposito": "Depósito de Exemplo", "StatusSistema": "Pedido", "Status": "Aprovado", "Categoria": "Varejo", "Validade": "2021-09-30T00:00:00", "Empresa": "Empresa de Exemplo", "Cliente": "Cliente de Teste", "ClienteCNPJ": "01234567000199", "ClienteEmail": "cliente@teste.com", "Vendedor": "Vendedor Teste", "PlanoDeConta": "1.01.01 Vendas", "FormaPagamento": "Boleto", "NumeroParcelas": 2, "FreteMeioEnvio": 1, "Transportadora": "Correios", "FreteFormaEnvio": "PAC", "DataEnvio": "2021-09-10T00:00:00", "PrevisaoEntrega": "2021-09-20T00:00:00", "DataPostagem": "2021-09-17T00:00:00", "Enviado": false, "ValorFrete": 10.0, "FreteContaEmitente": true, "CodigoRastreio": "BR123456789", "EnderecoOpcional": false, "ValorSeguro": 0.0, "Descricao": "Pedido de teste para documentação", "OutrasDespesas": 0.0, "ValorFinal": 100.0, "Finalizado": false, "Lancado": false, "Municipio": "Muncípio", "CodigoMunicipio": "4305108", "Pais": "Brasil", "CEP": "25625515", "UF": "RS", "UFCodigo": "43", "Bairro": "Centro", "Logradouro": "Rua de Exemplo", "LogradouroNumero": "123", "LogradouroComplemento": "Sala 01", "GruposProdutos": [ { "Id": 0, "Nome": "Grupo de Teste" } ], "Items": [ { "Codigo": "1234", "Unidade": "UN", "Descricao": "Produto de Teste", "Quantidade": 4.0, "ValorUnitario": 20.0, "ValorFrete": 2.0, "DescontoUnitario": 0.0, "ValorTotal": 80.0, "PesoKG": 0.0, "Comprimento": 0.0, "Altura": 0.0, "Largura": 0.0, "FreteGratis": false, "ValorUnitarioFrete": 0.0, "PrazoEntregaFrete": 0, "Seguro": 0.0, "ProductGroupId": 0 }, { "Codigo": "0097", "Unidade": "UN", "Descricao": "Produto de Teste 2", "Quantidade": 1.0, "ValorUnitario": 20.0, "ValorFrete": 0.0, "DescontoUnitario": 0.0, "ValorTotal": 20.0, "PesoKG": 0.0, "Comprimento": 0.0, "Altura": 0.0, "Largura": 0.0, "FreteGratis": false, "ValorUnitarioFrete": 0.0, "PrazoEntregaFrete": 0, "Seguro": 0.0, "ProductGroupId": 0 } ], "Data": "2021-09-10T00:00:00", "Pagamentos": [ { "FormaPagamento": "Boleto", "ValorPagamento": 100.0, "DataTransacao": "0001-01-01T00:00:00", "CondicaoPagamento": 0, "Parcelas": 2, "PeriodoParcelas": 0, "Adiantamento": 0.0 } ], "ValorComissaoVendedor": 5.0, "DataFaturamento": "2021-09-16T00:00:00", "CodigoPedidoCliente": "PED-CLI-001", "DataAprovacaoPedido": "2021-09-15T00:00:00" } }, "ProductGroup": { "type": "object", "properties": { "Id": { "format": "int32", "type": "integer" }, "Nome": { "type": "string" } } }, "PedidoProduto": { "type": "object", "properties": { "Codigo": { "type": "string" }, "Unidade": { "type": "string" }, "Descricao": { "type": "string" }, "Quantidade": { "format": "double", "type": "number" }, "ValorUnitario": { "format": "double", "type": "number" }, "ValorFrete": { "format": "double", "type": "number" }, "DescontoUnitario": { "format": "double", "type": "number" }, "ValorTotal": { "format": "double", "type": "number" }, "PesoKG": { "format": "double", "type": "number" }, "Comprimento": { "format": "double", "type": "number" }, "Altura": { "format": "double", "type": "number" }, "Largura": { "format": "double", "type": "number" }, "FreteGratis": { "type": "boolean" }, "ValorUnitarioFrete": { "format": "double", "type": "number" }, "PrazoEntregaFrete": { "format": "int32", "type": "integer" }, "ComissaoVendedor": { "format": "double", "type": "number" }, "Seguro": { "format": "double", "type": "number" }, "Composicoes": { "type": "array", "items": { "$ref": "#/definitions/PedidoProdutoComposicao" } }, "Atributos": { "type": "array", "items": { "$ref": "#/definitions/PedidoProdutoAtributo" } }, "ProductGroupId": { "format": "int32", "type": "integer" }, "Categoria": { "type": "string" }, "CategoriaID": { "type": "string" } } }, "PagamentoPedido": { "type": "object", "properties": { "FormaPagamento": { "type": "string" }, "DescricaoPagamento": { "type": "string" }, "ValorPagamento": { "format": "double", "type": "number" }, "BandeiraCartao": { "type": "string" }, "NumeroTerminal": { "type": "string" }, "DataTransacao": { "format": "date-time", "type": "string" }, "CredenciadoraCartao": { "type": "string" }, "CredenciadoraCNPJ": { "type": "string" }, "CV_NSU": { "type": "string" }, "TipoIntegracao": { "type": "string" }, "CondicaoPagamento": { "format": "int32", "type": "integer" }, "Parcelas": { "format": "int32", "type": "integer" }, "PeriodoParcelas": { "format": "int32", "type": "integer" }, "Adiantamento": { "format": "double", "type": "number" }, "Quitar": { "type": "boolean" } } }, "OS": { "type": "object", "properties": { "OrdemServicoConcluida": { "type": "boolean" }, "OrdemServicoCancelada": { "type": "boolean" }, "MotivoCancelamento": { "type": "string" }, "Problema": { "type": "string" }, "Laudo": { "type": "string" }, "DataAbertura": { "format": "date-time", "type": "string" }, "Tecnico": { "type": "string" }, "Contrato": { "type": "string" }, "DataVisita": { "format": "date-time", "type": "string" }, "DataInicioIntervencaoTecnica": { "format": "date-time", "type": "string" }, "DataFinalIntervencaoTecnica": { "format": "date-time", "type": "string" }, "Laudos": { "type": "array", "items": { "$ref": "#/definitions/Laudo" } }, "Equipamentos": { "type": "array", "items": { "$ref": "#/definitions/InformacoesEquipamento" } }, "Veiculos": { "type": "array", "items": { "$ref": "#/definitions/CadastroVeiculos" } } } }, "PedidoProdutoComposicao": { "type": "object", "properties": { "Produto": { "type": "string" }, "Deposito": { "type": "string" }, "Consumo": { "format": "double", "type": "number" }, "ConsumoTotal": { "format": "double", "type": "number" }, "NumerosSerie": { "type": "string" } } }, "PedidoProdutoAtributo": { "type": "object", "properties": { "AtributoId": { "type": "string" }, "Descricao": { "type": "string" }, "Abreviacao": { "type": "string" }, "Valor": { "type": "string" } } }, "Laudo": { "type": "object", "properties": { "Tecnico": { "type": "string" }, "DataRegistro": { "format": "date-time", "type": "string" }, "LaudoTecnicoGeral": { "type": "string" } } }, "InformacoesEquipamento": { "type": "object", "properties": { "Codigo": { "type": "string" }, "Nome": { "type": "string" }, "Modelo": { "type": "string" }, "Observacoes": { "type": "string" }, "Fabricante": { "type": "string" } } }, "CadastroVeiculos": { "type": "object", "properties": { "Modelo": { "type": "string" }, "Placa": { "type": "string" }, "NumeroSerie": { "type": "string" }, "Chassi": { "type": "string" } } }, "Pessoa": { "type": "object", "properties": { "ID": { "type": "string" }, "UltimaAlteracao": { "format": "date-time", "type": "string" }, "PessoaFisica": { "type": "boolean" }, "NomeFantasia": { "type": "string" }, "RazaoSocial": { "type": "string" }, "CNPJ_CPF": { "type": "string" }, "RG": { "type": "string" }, "IE": { "type": "string" }, "Logradouro": { "type": "string" }, "LogradouroNumero": { "type": "string" }, "Complemento": { "type": "string" }, "Bairro": { "type": "string" }, "Cidade": { "type": "string" }, "CodigoMunicipio": { "type": "string" }, "Pais": { "type": "string" }, "CodigoPais": { "type": "string" }, "CEP": { "type": "string" }, "UF": { "type": "string" }, "CodigoUF": { "type": "string" }, "Telefone": { "type": "string" }, "Celular": { "type": "string" }, "Email": { "type": "string" }, "Site": { "type": "string" }, "Cliente": { "type": "boolean" }, "Tecnico": { "type": "boolean" }, "Vendedor": { "type": "boolean" }, "Transportadora": { "type": "boolean" }, "Fonecedor": { "type": "boolean" }, "Representada": { "type": "boolean" }, "Colaborador": { "type": "boolean" }, "Fabricante": { "type": "boolean" }, "Credenciadora": { "type": "boolean" }, "EnteGovernamental": { "type": "boolean" }, "TipoEnteGovernamental": { "format": "int32", "type": "integer" }, "Ramo": { "type": "string" }, "VendedorPadrao": { "type": "string" }, "EmailLoginEcommerce": { "type": "string" }, "Bloqueado": { "type": "boolean" }, "NomePai": { "type": "string" }, "NomeMae": { "type": "string" }, "Naturalidade": { "type": "string" }, "ValorMinimoCompra": { "format": "double", "type": "number" }, "DataNascimento": { "format": "date-time", "type": "string" }, "EstaInadimplente": { "type": "boolean" }, "EnderecoCobranca": { "$ref": "#/definitions/Endereco" }, "EnderecoPadrao": { "$ref": "#/definitions/Endereco" }, "EnderecosEntrega": { "type": "array", "items": { "$ref": "#/definitions/EnderecoEntrega" } }, "Grupo": { "type": "string" } } }, "Endereco": { "type": "object", "properties": { "Exterior": { "type": "boolean" }, "CEP": { "type": "string" }, "Logradouro": { "type": "string" }, "Uf": { "type": "string" }, "CodigoUF": { "type": "string" }, "Cidade": { "type": "string" }, "Numero": { "type": "string" }, "Complemento": { "type": "string" }, "Bairro": { "type": "string" }, "CodigoCidade": { "type": "string" }, "Pais": { "type": "string" }, "CodigoPais": { "type": "string" } } }, "EnderecoEntrega": { "type": "object", "properties": { "EnderecoId": { "type": "string" }, "Exterior": { "type": "boolean" }, "Logradouro": { "type": "string" }, "LogradouroNumero": { "type": "string" }, "Complemento": { "type": "string" }, "Bairro": { "type": "string" }, "Cidade": { "type": "string" }, "CodigoMunicipio": { "type": "string" }, "Pais": { "type": "string" }, "CodigoPais": { "type": "string" }, "CEP": { "type": "string" }, "UF": { "type": "string" }, "CodigoUF": { "type": "string" }, "EnderecoPadrao": { "type": "boolean" }, "EntregaIE": { "type": "string" } } }, "PlanoDeContaRetornoBusca": { "required": [ "Nome" ], "type": "object", "properties": { "Id": { "type": "string" }, "DataAlteracao": { "format": "date-time", "type": "string" }, "CodigoNatureza": { "format": "int32", "type": "integer" }, "TipoDeConta": { "type": "string" }, "Nome": { "type": "string" }, "Despesa": { "type": "boolean" }, "Hierarquia": { "type": "string" }, "GrupoDRE": { "type": "string" }, "DesativarPlano": { "type": "boolean" }, "CentroDeCusto": { "type": "string" }, "GrupoLancamento": { "type": "string" } } }, "Produto": { "required": [ "Nome", "PrecoCusto" ], "type": "object", "properties": { "ID": { "type": "string" }, "UltimaAlteracao": { "format": "date-time", "type": "string" }, "Categoria": { "type": "string" }, "CategoriaID": { "type": "string" }, "Marca": { "type": "string" }, "Fornecedor": { "type": "string" }, "Codigo": { "type": "string" }, "Ean": { "type": "string" }, "Prateleira": { "type": "string" }, "Prateleiras": { "type": "array", "items": { "$ref": "#/definitions/Prateleira" } }, "NumeroSerie": { "type": "string" }, "Nome": { "type": "string" }, "Modelo": { "type": "string" }, "Genero": { "type": "string" }, "EstoqueUnidade": { "type": "string" }, "Especificacao": { "type": "string" }, "PesoKG": { "format": "double", "type": "number" }, "PrecoCusto": { "format": "double", "type": "number" }, "LucroDinheiro": { "format": "double", "type": "number" }, "LucroPercentual": { "format": "double", "type": "number" }, "PrecoVenda": { "format": "double", "type": "number" }, "PrecoMinimoVenda": { "format": "double", "type": "number" }, "EstoqueRisco": { "format": "double", "type": "number" }, "DepositoPadrao": { "format": "double", "type": "number" }, "EstoqueSaldo": { "format": "double", "type": "number" }, "NCM": { "type": "string" }, "GrupoTributario": { "type": "string" }, "GeneroFiscal": { "type": "string" }, "CFOPPadrao": { "type": "string" }, "UnidadeComercial": { "type": "string" }, "UnidadeTributavel": { "type": "string" }, "OrigemMercadoria": { "format": "int32", "type": "integer" }, "CEST": { "type": "string" }, "ProduzidoEscalaNaoRelevante": { "type": "boolean" }, "Fabricante": { "type": "string" }, "CodigoBeneficioFiscal": { "type": "string" }, "IPI_SituacaoTributaria": { "type": "string" }, "IPI": { "format": "double", "type": "number" }, "IPI_EnquadramentoLegal": { "type": "string" }, "IPI_ClasseEnquadramento": { "type": "string" }, "NCM_EX_IPI": { "type": "string" }, "InformacoesAdicionaisNFe": { "type": "string" }, "ProdutoPossuiUcomDiferenteDeUtrib": { "type": "boolean" }, "FatorDeConversaoUnidadeComercialParaTributavel": { "format": "double", "type": "number" }, "EAN_UnidadeTributavel_NFe": { "type": "string" }, "UnidadeTributavel_NFe": { "type": "string" }, "UnidadeComercial_NFe": { "type": "string" }, "PossuiRastreabilidadeSEFAZ": { "type": "boolean" }, "ProdutoControladoPorLote": { "type": "boolean" }, "ProdutoPossuiInfComb": { "type": "boolean" }, "CodigoANP": { "type": "string" }, "DescricaoANP": { "type": "string" }, "PercentualGLP": { "format": "double", "type": "number" }, "PercentualGLPNacional": { "format": "double", "type": "number" }, "PercentualGLPImportado": { "format": "double", "type": "number" }, "ValorPartidaGLP": { "format": "double", "type": "number" }, "EhArmadeFogo": { "type": "boolean" }, "ArmaTipo": { "format": "int32", "type": "integer" }, "ArmaDescricao": { "type": "string" }, "PossuiInformacoesSTRetidosAnteriormente": { "type": "boolean" }, "Aliquota_Suportada_ConsumidorFinal": { "format": "double", "type": "number" }, "FCPST_BaseCalculo": { "format": "double", "type": "number" }, "FCPST_Percentual": { "format": "double", "type": "number" }, "FCPST_Valor": { "format": "double", "type": "number" }, "Valor_ICMS_Substituto": { "format": "double", "type": "number" }, "Valor_ICMS_ST": { "format": "double", "type": "number" }, "VisivelSite": { "type": "boolean" }, "VisivelVendas": { "type": "boolean" }, "DestaqueSite": { "type": "boolean" }, "IgnorarEstoque": { "type": "boolean" }, "FreteGratis": { "type": "boolean" }, "FiltrosCategoria": { "type": "string" }, "PercentualDescontoBoleto": { "format": "double", "type": "number" }, "TamanhoNome": { "type": "string" }, "Comprimento": { "format": "double", "type": "number" }, "Altura": { "format": "double", "type": "number" }, "Largura": { "format": "double", "type": "number" }, "Diametro": { "format": "double", "type": "number" }, "TipoDoProduto": { "enum": [ "Simples", "Variavel", "Variacao" ], "type": "string" }, "VariacoesProduto": { "type": "array", "items": { "$ref": "#/definitions/VariacaoProduto" } }, "PrecosTabelas": { "type": "array", "items": { "$ref": "#/definitions/PrecoTabela" } }, "Categorias": { "type": "array", "items": { "type": "string" } }, "EhGrupoMED": { "type": "boolean" }, "GrupoMED_CodANVISA": { "type": "string" }, "GrupoMED_vPMC": { "format": "double", "type": "number" }, "GrupoMED_MotivoIsencaoANVISA": { "type": "string" } } }, "Prateleira": { "type": "object", "properties": { "DepositoID": { "type": "string" }, "CodigoPrateleira": { "type": "string" } } }, "VariacaoProduto": { "type": "object", "properties": { "Codigo": { "type": "string" }, "PrecoCusto": { "format": "double", "type": "number" }, "PrecoVenda": { "format": "double", "type": "number" }, "PrecosTabelas": { "type": "array", "items": { "$ref": "#/definitions/PrecoTabela" } }, "Caracteristicas": { "type": "array", "items": { "$ref": "#/definitions/Caracteristica" } } } }, "PrecoTabela": { "type": "object", "properties": { "Tabela": { "type": "string" }, "PrecoVenda": { "format": "double", "type": "number" } } }, "Caracteristica": { "type": "object", "properties": { "Nome": { "type": "string" }, "Valor": { "type": "string" } } }, "SaldoDeposito": { "type": "object", "properties": { "Deposito": { "type": "string" }, "Saldo": { "format": "double", "type": "number" }, "LastUpdate": { "format": "date-time", "type": "string" } } }, "GSaldoBancos": { "type": "object", "properties": { "BancosSaldos": { "type": "array", "items": { "$ref": "#/definitions/GSaldoBanco" } }, "DataSaldoAtual": { "format": "date-time", "type": "string" }, "SaldoAtual": { "format": "double", "type": "number" }, "DataSaldoAntigo": { "format": "date-time", "type": "string" }, "SaldoAntigo": { "format": "double", "type": "number" } } }, "GSaldoBanco": { "type": "object", "properties": { "Nome": { "type": "string" }, "Saldo": { "format": "double", "type": "number" } } }, "TabelaPreco": { "type": "object", "properties": { "Id": { "type": "string" }, "UltimaAlteracao": { "format": "date-time", "type": "string" }, "Nome": { "type": "string" }, "Genero": { "type": "string" }, "ExibirNoPDV": { "type": "boolean" }, "AtualizarPrecoVenda": { "type": "boolean" } } }, "PrecoProdutoTabela": { "type": "object", "properties": { "UltimaAlteracao": { "format": "date-time", "type": "string" }, "CodigoProduto": { "type": "string" }, "Produto": { "type": "string" }, "ComissaoVendedor": { "format": "double", "type": "number" }, "ComissaoRepresentada": { "format": "double", "type": "number" }, "MVA": { "format": "double", "type": "number" }, "ST": { "format": "double", "type": "number" }, "Despesas": { "format": "double", "type": "number" }, "PrecoCusto": { "format": "double", "type": "number" }, "PrecoVenda": { "format": "double", "type": "number" }, "OcultarProdutoVendas": { "type": "boolean" } } }, "TranferenciasBancariasFiltro": { "type": "object", "properties": { "TransferenciaId": { "type": "string" }, "BancoOrigem": { "type": "string" }, "BancoDestino": { "type": "string" }, "DataInicio": { "format": "date-time", "type": "string" }, "DataFim": { "format": "date-time", "type": "string" }, "PageSize": { "format": "int32", "type": "integer" }, "Skip": { "format": "int32", "type": "integer" } } }, "TransferenciaBancaria": { "type": "object", "properties": { "Id": { "type": "string" }, "Documento": { "type": "string" }, "BancoOrigem": { "type": "string" }, "BancoDestino": { "type": "string" }, "DataTransferencia": { "format": "date-time", "type": "string" }, "Valor": { "format": "double", "type": "number" }, "Observacoes": { "type": "string" } } } } }