tms

2.0info: 0.0.4 frotas description: Serviço para Gestão de Frotas x-senior-domain: tms x-senior-domain-path: tms x-senior-service-path: frotas contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /tms/frotassecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /abastecimentoCreated: post: description: Evento de criação de um abastecimento x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – abastecimento properties: abastecimento: #/definitions/abastecimento responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /pecaExternaOrdemServicoCreated: post: description: Evento de criação de uma Peça Externa da OS x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pecaExternaOrdemServico properties: pecaExternaOrdemServico: #/definitions/pecaExternaOrdemServico responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /pecaExternaOrdemServicoUpdated: post: description: Evento de atualização de uma Peça Externa da OS x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – pecaExternaOrdemServico properties: pecaExternaOrdemServico: #/definitions/pecaExternaOrdemServico responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /servicoExternoOrdemServicoCreated: post: description: Evento de criação de um Serviço Externo da OS x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – servicoExternoOrdemServico properties: servicoExternoOrdemServico: #/definitions/servicoExternoOrdemServico responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /servicoExternoOrdemServicoUpdated: post: description: Evento de criação de um Serviço Externo da OS x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – servicoExternoOrdemServico properties: servicoExternoOrdemServico: #/definitions/servicoExternoOrdemServico responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /telemetriaCreated: post: description: Evento de criação de Telemetria x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – telemetria properties: telemetria: #/definitions/telemetria responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /telemetriaEventoCreated: post: description: Evento de criação de Telemetria Evento x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – telemetriaEvento properties: telemetriaEvento: #/definitions/telemetriaEvento responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /funcionarioCreated: post: description: Evento de criação de Funcionário x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – matricula properties: matricula: type: integer description: Matrícula do funcionário responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /apis/peca: get: description: The list request primitive for the peca facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/pecaFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/veiculosLiberadosMotorista: get: description: The list request primitive for the veiculosLiberadosMotorista facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/veiculosLiberadosMotoristaFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/ordemServico: get: description: The list request primitive for the ordemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/ordemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/funcionario: get: description: The list request primitive for the funcionario facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/funcionarioFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/planoServico: get: description: The list request primitive for the planoServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/planoServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/abastecimentoCartaoVeiculo: get: description: The list request primitive for the abastecimentoCartaoVeiculo facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/abastecimentoCartaoVeiculoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/pecaExternaOrdemServico: post: description: The create request primitive for the pecaExternaOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/pecaExternaOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/pecaExternaOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the pecaExternaOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/pecaExternaOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/pecaExternaOrdemServico/{id}: put: description: The update request primitive for the pecaExternaOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/pecaExternaOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/pecaExternaOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/situacaoOrdemServico: get: description: The list request primitive for the situacaoOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/situacaoOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/servicoExternoOrdemServico: post: description: The create request primitive for the servicoExternoOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/servicoExternoOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/servicoExternoOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the servicoExternoOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/servicoExternoOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/servicoExternoOrdemServico/{id}: put: description: The update request primitive for the servicoExternoOrdemServico facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/servicoExternoOrdemServicoFacadeInput responses: 200: description: Ok schema: #/definitions/servicoExternoOrdemServicoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/telemetria: post: description: The create request primitive for the telemetria facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/telemetriaFacadeInput responses: 200: description: Ok schema: #/definitions/telemetriaFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the telemetria facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/telemetriaFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/veiculo: get: description: The list request primitive for the veiculo facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/veiculoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/telemetriaEvento: post: description: The create request primitive for the telemetriaEvento facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/telemetriaEventoFacadeInput responses: 200: description: Ok schema: #/definitions/telemetriaEventoFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the telemetriaEvento facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/telemetriaEventoFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/abastecimento: post: description: The create request primitive for the abastecimento facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/abastecimentoFacadeInput responses: 200: description: Ok schema: #/definitions/abastecimentoFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the abastecimento facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/abastecimentoFacadeOutput default: description: Error response schema: #/definitions/genericErrordefinitions: enumSituacaoServico: type: string enum: – NAO_CONCLUIDO – CONCLUIDO – REVISADO – NAO_APLICADO enumTipoItem: type: string enum: – COMBUSTIVEL – OLEO_MOTOR – ARLA – OUTROS enumSituacaoCartao: type: string enum: – ATIVO – INATIVO – BLOQUEADO enumTipoCartao: type: string enum: – FIXO – RESERVA enumPrioridadeServico: type: string enum: – PLANEJADA – BAIXA – MEDIA – ALTA – CRITICA abastecimento: type: object required: – placa – dataAbastecimento – hodometro – cpfMotorista – cnpjFornecedor – cnpjOperadora – nomeOperadora – codigoItem – quantidadeItem – valorTotal properties: id: type: string description: format: uuid placa: type: string description: Placa do veículo dataAbastecimento: type: string description: Data e hora do abastecimento format: date-time hodometro: type: number description: Número do hodometro format: double cpfMotorista: type: string description: CPF do motorista cnpjFornecedor: type: string description: CNPJ fornecedor cnpjOperadora: type: string description: CNPJ da Operadora de Cartão nomeOperadora: type: string description: Nome da Operadora codigoItem: type: string description: Código identificador do Item quantidadeItem: type: number description: Quantidade do item format: double valorTotal: type: number description: Valor total format: double valorDesconto: type: number description: Valor do Desconto format: double numeroDocumento: type: string description: Número do documento fiscal serieDocumento: type: string description: Serie do documento fiscal numeroCartao: type: string description: Número do cartão de abastecimento createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time telemetriaEvento: type: object required: – placa – latitude – longitude – dataPosicao properties: id: type: string description: format: uuid placa: type: string description: Placa do veículo latitude: type: string description: Latitude longitude: type: string description: Longitude dataPosicao: type: string description: Data e hora da posição format: date-time hodometro: type: number description: Número do hodômetro format: double cpfMotorista: type: string description: CPF do motorista pais: type: string description: Nome do pais uf: type: string description: Sigla do estado cidade: type: string description: Nome da cidade bairro: type: string description: Nome do bairro cep: type: string description: Número do CEP rua: type: string description: Nome da rua velocidade: type: number description: Velocidade format: double rpm: type: number description: RPM format: double eventos: type: array items: #/definitions/evento description: Lista de eventos createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time evento: type: object required: – id properties: id: type: string description: format: uuid codigoEvento: type: string description: Código do cadastro do evento descricao: type: string description: Descrição do evento telemetriaEvento: #/definitions/telemetriaEvento createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time telemetria: type: object required: – placa – latitude – longitude – dataPosicao properties: id: type: string description: format: uuid placa: type: string description: Placa do veículo latitude: type: string description: Latitude longitude: type: string description: Longitude dataPosicao: type: string description: Data e hora da posição format: date-time hodometro: type: number description: Número do hodômetro format: double velocidade: type: number description: Velocidade format: double rpm: type: number description: RPM format: double cpfMotorista: type: string description: CPF do motorista pais: type: string description: Nome do pais uf: type: string description: Sigla do estado cidade: type: string description: Nome da cidade bairro: type: string description: Nome do bairro cep: type: string description: Número do CEP rua: type: string description: Nome da rua createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time servicoExternoOrdemServico: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – codigoPlanoServico properties: id: type: string description: format: uuid codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço sequencia: type: integer description: Sequência cnpjFornecedor: type: string description: CNPJ do fornecedor dataExecucao: type: string description: Data de execução format: date-time codigoPlanoServico: type: integer description: Código do Plano de Serviço codigoDefeito: type: integer description: Código do defeito valorUnitario: type: number description: Valor unitário format: double valorTotal: type: number description: Valor total format: double observacao: type: string description: Observação concluido: type: boolean description: Serviço concluído numeroNotaFiscal: type: integer description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal situacao: #/definitions/enumSituacaoServico dataGarantia: type: string description: Data da garantia format: date-time hodometro: type: number description: Hodômetro format: double valorDesconto: type: number description: Valor do desconto format: double dataExecucaoFinal: type: string description: Data da execução final format: date-time dataExecucaoInicial: type: string description: Data da execução inicial format: date-time createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time pecaExternaOrdemServico: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia properties: id: type: string description: format: uuid codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço sequencia: type: integer description: Sequência cnpjFornecedor: type: string description: CNPJ do fornecedor dataUtilizacao: type: string description: Data da utilização format: date-time codigoItem: type: integer description: Código do item quantidadeItem: type: number description: Quantidade do item format: double valorUnitario: type: number description: Valor unitário format: double valorTotal: type: number description: Valor total format: double observacao: type: string description: Observação numeroNotaFiscal: type: integer description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal dataGarantia: type: string description: Data da garantia format: date-time hodometro: type: number description: Hodômetro format: double valorDesconto: type: number description: Valor do desconto format: double createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time abastecimentoFacadeInput: type: object required: – placa – dataAbastecimento – hodometro – cpfMotorista – cnpjFornecedor – cnpjOperadora – nomeOperadora – codigoItem – quantidadeItem – valorTotal properties: placa: type: string description: Placa do veículo dataAbastecimento: type: string description: Data e hora do abastecimento format: date-time hodometro: type: number description: Número do hodometro format: double cpfMotorista: type: string description: CPF do motorista cnpjFornecedor: type: string description: CNPJ fornecedor cnpjOperadora: type: string description: CNPJ da Operadora de Cartão nomeOperadora: type: string description: Nome da Operadora codigoItem: type: string description: Código identificador do item quantidadeItem: type: number description: Quantidade do item format: double valorTotal: type: number description: Valor total format: double valorDesconto: type: number description: Valor do Desconto format: double numeroDocumento: type: string description: Número do documento fiscal serieDocumento: type: string description: Serie do documento fiscal numeroCartao: type: string description: Número do cartão de abastecimento abastecimentoFacadeOutput: type: object required: – placa – dataAbastecimento – hodometro – cpfMotorista – cnpjFornecedor – cnpjOperadora – nomeOperadora – codigoItem – tipoItem – quantidadeItem – valorTotal properties: placa: type: string description: Placa do veículo dataAbastecimento: type: string description: Data e hora do abastecimento format: date-time hodometro: type: number description: Número do hodometro format: double cpfMotorista: type: string description: CPF do motorista cnpjFornecedor: type: string description: CNPJ fornecedor cnpjOperadora: type: string description: CNPJ da Operadora de Cartão nomeOperadora: type: string description: Nome da Operadora codigoItem: type: string description: Código identificador do Item tipoItem: #/definitions/enumTipoItem quantidadeItem: type: number description: Quantidade do item format: double valorTotal: type: number description: Valor total format: double valorDesconto: type: number description: Valor do Desconto format: double numeroDocumento: type: string description: Número do documento fiscal serieDocumento: type: string description: Série do documento fiscal numeroCartao: type: string description: Número do cartão de abastecimento createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário última modificação lastModifiedDate: type: string description: Data última modificação format: date-time abastecimentoCartaoVeiculoFacadeOutput: type: object required: – codigoCartao – codigoVeiculo – numeroCartao – placa – situacaoCartao – tipoCartao – dataVinculacao – vinculacaoAtiva properties: codigoCartao: type: integer description: Código do cartão codigoVeiculo: type: integer description: Código do veículo numeroCartao: type: string description: Número do cartão placa: type: string description: Placa do veículo situacaoCartao: #/definitions/enumSituacaoCartao tipoCartao: #/definitions/enumTipoCartao dataVinculacao: type: string description: Data da vinculação format: date-time vinculacaoAtiva: type: boolean description: Situação da vinculação telemetriaEventoFacadeInput: type: object required: – placa – latitude – longitude – dataPosicao properties: placa: type: string description: Placa do veículo latitude: type: string description: Latitude longitude: type: string description: Longitude dataPosicao: type: string description: Data e hora da posição format: date-time hodometro: type: number description: Número do hodômetro format: double cpfMotorista: type: string description: CPF do motorista pais: type: string description: Nome do pais uf: type: string description: Sigla do estado cidade: type: string description: Nome da cidade bairro: type: string description: Nome do bairro cep: type: string description: Número do CEP rua: type: string description: Nome da rua velocidade: type: number description: Velocidade format: double rpm: type: number description: RPM format: double eventos: type: array items: #/definitions/recEvento description: Lista de eventos recEvento: type: object required: – codigo – descricao properties: codigo: type: string description: Código do evento descricao: type: string description: Descrição do evento telemetriaEventoFacadeOutput: type: object required: – placa – latitude – longitude – dataPosicao – hodometro – cpfMotorista – pais – uf – cidade – bairro – cep – rua – velocidade – rpm properties: placa: type: string description: Placa do veículo latitude: type: string description: Latitude longitude: type: string description: Longitude dataPosicao: type: string description: Data e hora da posição format: date-time hodometro: type: number description: Número do hodômetro format: double cpfMotorista: type: string description: CPF do motorista pais: type: string description: Nome do pais uf: type: string description: Sigla do estado cidade: type: string description: Nome da cidade bairro: type: string description: Nome do bairro cep: type: string description: Número do CEP rua: type: string description: Nome da rua velocidade: type: number description: Velocidade format: double rpm: type: number description: RPM format: double eventos: type: array items: #/definitions/recEvento description: Lista de eventos createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário última modificação lastModifiedDate: type: string description: Data última modificação format: date-time telemetriaFacadeInput: type: object required: – placa – latitude – longitude – dataPosicao properties: placa: type: string description: Placa do veículo latitude: type: string description: Latitude longitude: type: string description: Longitude dataPosicao: type: string description: Data e hora da posição format: date-time hodometro: type: number description: Número do hodômetro format: double velocidade: type: number description: Velocidade format: double rpm: type: number description: RPM format: double cpfMotorista: type: string description: CPF do motorista pais: type: string description: Nome do pais uf: type: string description: Sigla do estado cidade: type: string description: Nome da cidade bairro: type: string description: Nome do bairro cep: type: string description: Número do CEP rua: type: string description: Nome da rua telemetriaFacadeOutput: type: object required: – placa – latitude – longitude – dataPosicao properties: placa: type: string description: Placa do veículo latitude: type: string description: Latitude longitude: type: string description: Longitude dataPosicao: type: string description: Data e hora da posição format: date-time hodometro: type: number description: Número do hodômetro format: double velocidade: type: number description: Velocidade format: double rpm: type: number description: RPM format: double cpfMotorista: type: string description: CPF do motorista pais: type: string description: Nome do pais uf: type: string description: Sigla do estado cidade: type: string description: Nome da cidade bairro: type: string description: Nome do bairro cep: type: string description: Número do CEP rua: type: string description: Nome da rua veiculosLiberadosMotoristaFacadeOutput: type: object required: – matricula – cpfMotorista – placa – codigoVeiculo – codigoTipoVeiculo – codigoEmpresa – descricaoTipoVeiculo – apelidoTipoVeiculo properties: matricula: type: integer description: Matricula do motorista cpfMotorista: type: string description: CPF do motorista placa: type: string description: Placa do veículo codigoVeiculo: type: integer description: Código do veículo codigoTipoVeiculo: type: integer description: Código do Tipo de Veículo codigoEmpresa: type: integer description: Código da Empresa descricaoTipoVeiculo: type: string description: Descrição do Tipo de Veículo apelidoTipoVeiculo: type: string description: Apelido do Tipo de Veículo situacaoOrdemServicoFacadeOutput: type: object required: – codigo – descricao – apelido properties: codigo: type: integer description: Código da Situação descricao: type: string description: Descrição apelido: type: string description: Apelido servicoExternoOrdemServicoFacadeInput: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – codigoPlanoServico properties: id: type: string description: format: uuid codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço sequencia: type: integer description: Sequência cnpjFornecedor: type: string description: CNPJ do fornecedor dataExecucao: type: string description: Data de execução format: date-time codigoPlanoServico: type: integer description: Código do Plano de Serviço codigoDefeito: type: integer description: Código do defeito valorUnitario: type: number description: Valor unitário format: double valorTotal: type: number description: Valor total format: double observacao: type: string description: Observação concluido: type: boolean description: Serviço concluído numeroNotaFiscal: type: integer description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal situacao: #/definitions/enumSituacaoServico dataGarantia: type: string description: Data da garantia format: date-time hodometro: type: number description: Hodômetro format: double valorDesconto: type: number description: Valor do desconto format: double dataExecucaoFinal: type: string description: Data da execução final format: date-time dataExecucaoInicial: type: string description: Data da execução inicial format: date-time servicoExternoOrdemServicoFacadeOutput: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – cnpjFornecedor – dataExecucao – codigoPlanoServico – valorUnitario – valorTotal – observacao – concluido – numeroNotaFiscal – serieNotaFiscal – situacao – dataGarantia – hodometro – valorDesconto – dataExecucaoFinal – dataExecucaoInicial – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: id: type: string description: Id da entidade codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço sequencia: type: integer description: Sequência cnpjFornecedor: type: string description: CNPJ do fornecedor dataExecucao: type: string description: Data de execução format: date-time codigoPlanoServico: type: integer description: Código do Plano de Serviço codigoDefeito: type: integer description: Código do defeito valorUnitario: type: number description: Valor unitário format: double valorTotal: type: number description: Valor total format: double observacao: type: string description: Observação concluido: type: boolean description: Serviço concluído numeroNotaFiscal: type: integer description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal situacao: #/definitions/enumSituacaoServico dataGarantia: type: string description: Data da garantia format: date-time hodometro: type: number description: Hodômetro format: double valorDesconto: type: number description: Valor do desconto format: double dataExecucaoFinal: type: string description: Data da execução final format: date-time dataExecucaoInicial: type: string description: Data da execução inicial format: date-time createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário última modificação lastModifiedDate: type: string description: Data última modificação format: date-time pecaExternaOrdemServicoFacadeInput: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – codigoItem properties: id: type: string description: format: uuid codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço sequencia: type: integer description: Sequência cnpjFornecedor: type: string description: CNPJ do fornecedor dataUtilizacao: type: string description: Data da utilização format: date-time codigoItem: type: integer description: Código do item quantidadeItem: type: number description: Quantidade do item format: double valorUnitario: type: number description: Valor unitário format: double valorTotal: type: number description: Valor total format: double observacao: type: string description: Observação numeroNotaFiscal: type: integer description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal dataGarantia: type: string description: Data da garantia format: date-time hodometro: type: number description: Hodômetro format: double valorDesconto: type: number description: Valor do desconto format: double pecaExternaOrdemServicoFacadeOutput: type: object required: – codigoEmpresa – codigoOrdemServico – sequencia – cnpjFornecedor – dataUtilizacao – codigoItem – quantidadeItem – valorUnitario – valorTotal – observacao – numeroNotaFiscal – serieNotaFiscal – dataGarantia – hodometro – valorDesconto – createdBy – createdDate – lastModifiedBy – lastModifiedDate properties: id: type: string description: Id da entidade codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço sequencia: type: integer description: Sequência cnpjFornecedor: type: string description: CNPJ do fornecedor dataUtilizacao: type: string description: Data da utilização format: date-time codigoItem: type: integer description: Código do item quantidadeItem: type: number description: Quantidade do item format: double valorUnitario: type: number description: Valor unitário format: double valorTotal: type: number description: Valor total format: double observacao: type: string description: Observação numeroNotaFiscal: type: integer description: Número da nota fiscal serieNotaFiscal: type: string description: Série da nota fiscal dataGarantia: type: string description: Data da garantia format: date-time hodometro: type: number description: Hodômetro format: double valorDesconto: type: number description: Valor do desconto format: double createdBy: type: string description: Usuário de criação createdDate: type: string description: Data de criação format: date-time lastModifiedBy: type: string description: Usuário última modificação lastModifiedDate: type: string description: Data última modificação format: date-time planoServicoFacadeOutput: type: object required: – codigo – numero – descricao – apelido – numeroNivel – diasGarantia – diasReservico – horasPadraoServico – servicoBorracharia – prioridade properties: codigo: type: integer description: Código do Plano de Serviço numero: type: string description: Número do Plano de Serviço descricao: type: string description: Descrição do Plano de Serviço apelido: type: string description: Apelido numeroNivel: type: integer description: Número do nível do plano diasGarantia: type: integer description: Quantidade de dias de garantia diasReservico: type: integer description: Quantidade de dias para reserviço horasPadraoServico: type: number description: Quantidade de horas para a realização do serviço format: double servicoBorracharia: type: boolean description: Serviço de Borracharia prioridade: #/definitions/enumPrioridadeServico pecaFacadeOutput: type: object required: – codigo – numero – descricao – tipoItem – unidadeMedida – pesoLiquido – observacao – numeroItemFornecedor – numeroCor – inativo – peso – largura – altura – comprimento – kmGarantia – prazoGarantia properties: codigo: type: integer description: Código numero: type: string description: Número descricao: type: string description: Descrição tipoItem: #/definitions/recTipoItem unidadeMedida: #/definitions/recUnidadeMedida pesoLiquido: type: number description: Peso líquido format: double observacao: type: string description: Observação numeroItemFornecedor: type: string description: Número do item do fornecedor numeroCor: type: integer description: Número da cor inativo: type: boolean description: Peça inativa peso: type: number description: Peso format: double largura: type: number description: Largura format: double altura: type: number description: Altura format: double comprimento: type: number description: Comprimento format: double kmGarantia: type: integer description: Quilômetros de garantia prazoGarantia: type: integer description: Prazo de garantia recTipoItem: type: object required: – codigo – descricao properties: codigo: type: integer description: Código descricao: type: string description: Descrição recUnidadeMedida: type: object required: – codigo – descricao – valor properties: codigo: type: string description: Código descricao: type: string description: Descrição valor: type: number description: Valor format: double funcionarioFacadeOutput: type: object required: – codigo – nome – matricula – cpf – demitido – numeroCracha properties: codigo: type: integer description: Código do Funcionário nome: type: string description: Nome do funcionário matricula: type: string description: Matricula do funcionário cpf: type: string description: CPF do funcionário demitido: type: boolean description: Funcionário Demitido numeroCracha: type: string description: Número do Crachá ordemServicoFacadeOutput: type: object required: – codigoEmpresa – codigoOrdemServico – codigoVeiculo – dataEmissao – cnpjFornecedor – hodometro – valorOrcado – dataConclusaoPrevista – descricaoDefeitos – situacao – defeitos – impressa – dataBaixa properties: codigoEmpresa: type: integer description: Código da empresa codigoOrdemServico: type: integer description: Código da Ordem de Serviço codigoVeiculo: type: integer description: Código do veículo dataEmissao: type: string description: Data de emissão format: date-time cnpjFornecedor: type: string description: CNPJ do fornecedor hodometro: type: number description: Hodômetro format: double valorOrcado: type: number description: Valor orçado format: double dataConclusaoPrevista: type: string description: Data da conclusão prevista format: date-time descricaoDefeitos: type: string description: Descrição dos defeitos situacao: #/definitions/recSituacaoOrdemServico defeitos: type: array items: #/definitions/recDefeito description: Defeitos impressa: type: boolean description: Ordem de serviço impressa dataBaixa: type: string description: Data da baixa format: date-time recSituacaoOrdemServico: type: object required: – situacao – descricao – apelido properties: situacao: type: number description: Situação format: double descricao: type: string description: Descrição apelido: type: string description: Apelido recDefeito: type: object required: – sequencia – descricao – resolvido properties: sequencia: type: integer description: Sequência descricao: type: string description: Descrição resolvido: type: boolean description: Situação veiculoFacadeOutput: type: object required: – codigo – numero – placa – hodometro – ativo properties: codigo: type: integer description: Código do veículo numero: type: string description: Número de identificação placa: type: string description: Placa do veículo hodometro: type: number description: Número do hodômetro format: double ativo: type: boolean description: Veículo ativo genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE