• Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
  • Início
    • A Plataforma
    • Para customizar
      • Visão geral
      • Tutoriais
      • Github.com
      • Guia de contribuição
      • Tabela de compatibilidade
    • Para desenvolver
      • Visão geral
      • API – Guia de Estilo
      • UX – Guia de estilo
    • Para administrar
      • Documentação
  • APIs
  • Documentação
    • APIs Senior X
    • Tutoriais
  • Fórum
  • Community
  • Entrar
  • Cadastrar-se
home/APIs Privadas/tmsx_exp/CIOT (ciot)
Mais pesquisados:Customização, Tutorial, Documentação

CIOT (ciot)

10 views 0 09/11/2026 integrador

2.0info: 1.5.2 CIOT description: Serviço de CIOT (Código Identificador da Operação de Transporte) TMSX x-senior-domain: tmsx_exp x-senior-domain-path: tmsx_exp x-senior-service-path: ciot contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsx_expsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ciot/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unknownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unknownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperadoraCiot: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperadoraCiotFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiot: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiotTrecho: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiotVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiotMotorista: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiotParcela: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiotParametro: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportOperacaoCiotHistorico: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportPais: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportEstado: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportCidade: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportCidadeFaixaCep: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportEmpresa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportFilial: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportPessoa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportPessoaTransportadora: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportNomenclaturaComumMercosul: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportRamoAtividade: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportProprietarioVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportTipoDocumentoEmbarque: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportDocumentoEmbarque: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportDocumentoEmbarqueDadosTransporte: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportDocumentoTransporte: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportInformacaoBancariaPix: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportBanco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportInformacaoBancariaDeposito: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportDocumentosComplementares: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/exportClassificacaoVeiculo: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/migrateSchema: post: description: Realiza a migração do schema do banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object properties: migrationVersion: type: string description: Indica a versão do migration migrated: type: boolean description: Indica se já foi migrado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/forceFDW: post: description: Força a execução do FDW para um tenant específico. Restrito a usuários master (@Senior) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que terá o FDW forçado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/forceFDWTenant: post: description: Força a execução do FDW no tenant atual. Apenas requisições trusted tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/receberCiot: post: description: Recebe e persiste os dados de uma operação de CIOT tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dadosCiot properties: dadosCiot: type: object allOf: – #/definitions/recDadosCiot description: Dados do CIOT declaracaoAutomatica: type: boolean description: Indica se a declaração deve ser enviada automaticamente à operadora default: true responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/enviarCiot: post: description: Envia uma operação de CIOT para a Operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Operação responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/consultarCiot: post: description: Consulta o status/retorno do lote da operação de transporte na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/retificarCiot: post: description: Retifica (altera) uma operação CIOT já declarada na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dadosCiot – motivo properties: dadosCiot: type: object allOf: – #/definitions/recDadosCiot description: Dados do CIOT com as alterações a aplicar motivo: type: string maxLength: 1000 description: Justificativa para a retificação responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/consultarRetificacaoCiot: post: description: Consulta o status de processamento da retificação de uma operação CIOT na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Operação responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/reintegrarCiot: post: description: Reintegra uma operação CIOT com status REJEITADO, reenviando para a operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dadosCiot properties: dadosCiot: type: object allOf: – #/definitions/recDadosCiot description: Dados do CIOT motivo: type: string description: Justificativa para a reintegração declaracaoAutomatica: type: boolean description: Indica se a declaração/retificação deve ser enviada automaticamente à operadora default: true responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/cancelarCiot: post: description: Cancela uma operação CIOT na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – motivo properties: id: type: string description: Id da Operação motivo: type: string maxLength: 500 description: Justificativa para o cancelamento responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/consultarCancelamentoCiot: post: description: Consulta o status de processamento do cancelamento de uma operação CIOT na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Operação responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/encerrarCiot: post: description: Encerra uma operação CIOT na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Operação responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/consultarEncerramentoCiot: post: description: Consulta o status de processamento do encerramento de uma operação CIOT na operadora tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da Operação responses: 200: description: Ok schema: type: object required: – retornoCiot properties: retornoCiot: type: object allOf: – #/definitions/recRetornoCiot description: Retorno da operação do CIOT 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/testarConexaoOperadora: post: description: Testa a conexão com uma operadora de CIOT usando as credenciais informadas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – operadora – urlAutenticacao – clientId properties: operadoraCiotId: type: string description: Id da operadora cadastrada operadora: type: string allOf: – #/definitions/enumOperadoraCiot description: Operadora de CIOT urlAutenticacao: type: string description: URL de autenticação OAuth da operadora clientId: type: string description: Client ID OAuth clientSecret: type: string description: Client Secret OAuth (não criptografado). Obrigatório quando operadoraCiotId não for informado. responses: 200: description: Ok schema: type: object required: – sucesso properties: sucesso: type: boolean description: Indica se a conexão foi bem-sucedida mensagem: type: string description: Mensagem descritiva do resultado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperadoraCiot: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperadoraCiotFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiot: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiotTrecho: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiotVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiotMotorista: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiotParcela: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiotParametro: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importOperacaoCiotHistorico: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importPais: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importEstado: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importCidade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importCidadeFaixaCep: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importEmpresa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importFilial: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importPessoa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importPessoaTransportadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importNomenclaturaComumMercosul: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importRamoAtividade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importProprietarioVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importTipoDocumentoEmbarque: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importDocumentoEmbarque: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importDocumentoEmbarqueDadosTransporte: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importDocumentoTransporte: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importInformacaoBancariaPix: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importBanco: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importInformacaoBancariaDeposito: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importDocumentosComplementares: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/actions/importClassificacaoVeiculo: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/events/importOperadoraCiotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperadoraCiotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperadoraCiotFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperadoraCiotFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotTrechoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotTrechoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotMotoristaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotMotoristaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotParcelaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotParcelaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotParametroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotParametroEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importOperacaoCiotHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportOperacaoCiotHistoricoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importPaisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportPaisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importEstadoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportEstadoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importCidadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportCidadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importCidadeFaixaCepEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportCidadeFaixaCepEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importEmpresaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportEmpresaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportFilialEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importPessoaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportPessoaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importPessoaTransportadoraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportPessoaTransportadoraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importNomenclaturaComumMercosulEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportNomenclaturaComumMercosulEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importRamoAtividadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportRamoAtividadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importProprietarioVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportProprietarioVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importTipoDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportTipoDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importDocumentoEmbarqueDadosTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportDocumentoEmbarqueDadosTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importDocumentoTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportDocumentoTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importInformacaoBancariaPixEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportInformacaoBancariaPixEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importBancoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportBancoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importInformacaoBancariaDepositoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportInformacaoBancariaDepositoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importDocumentosComplementaresEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportDocumentosComplementaresEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/importClassificacaoVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/events/exportClassificacaoVeiculoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /ciot/entities/operadoraCiot: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operadoraCiot responses: 200: description: The created resource schema: #/definitions/operadoraCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operadoraCiot responses: 200: description: The created resource schema: #/definitions/operadoraCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/operadoraCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operadoraCiot/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOperadoraCiot responses: 200: description: Ok schema: #/definitions/editOperadoraCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/operadoraCiot responses: 200: description: Ok schema: #/definitions/operadoraCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/operadoraCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operadoraCiot/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/operadoraCiot responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operadoraCiotFilial: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operadoraCiotFilial responses: 200: description: The created resource schema: #/definitions/operadoraCiotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operadoraCiotFilial responses: 200: description: The created resource schema: #/definitions/operadoraCiotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/operadoraCiotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operadoraCiotFilial/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOperadoraCiotFilial responses: 200: description: Ok schema: #/definitions/editOperadoraCiotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/operadoraCiotFilial responses: 200: description: Ok schema: #/definitions/operadoraCiotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/operadoraCiotFilial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operadoraCiotFilial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/operadoraCiotFilial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operacaoCiot: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operacaoCiot responses: 200: description: The created resource schema: #/definitions/operacaoCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operacaoCiot responses: 200: description: The created resource schema: #/definitions/operacaoCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/operacaoCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operacaoCiot/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOperacaoCiot responses: 200: description: Ok schema: #/definitions/editOperacaoCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/operacaoCiot responses: 200: description: Ok schema: #/definitions/operacaoCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/operacaoCiot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operacaoCiot/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/operacaoCiot responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operacaoCiotHistorico: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operacaoCiotHistorico responses: 200: description: The created resource schema: #/definitions/operacaoCiotHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/operacaoCiotHistorico responses: 200: description: The created resource schema: #/definitions/operacaoCiotHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/operacaoCiotHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operacaoCiotHistorico/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editOperacaoCiotHistorico responses: 200: description: Ok schema: #/definitions/editOperacaoCiotHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/operacaoCiotHistorico responses: 200: description: Ok schema: #/definitions/operacaoCiotHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/operacaoCiotHistorico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/operacaoCiotHistorico/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/operacaoCiotHistorico responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/filial: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/pessoa: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/nomenclaturaComumMercosul: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/nomenclaturaComumMercosul 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/veiculo: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/veiculo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/documentoEmbarque: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/informacaoBancariaPix: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/informacaoBancariaPix 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /ciot/entities/informacaoBancariaDeposito: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/informacaoBancariaDeposito 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTipoPessoa: type: string enum: – PESSOA_JURIDICA – PESSOA_FISICA description: Tipo de Pessoa: * `PESSOA_JURIDICA` – Pessoa Jurídica * `PESSOA_FISICA` – Pessoa Física enumRamoAtividade: type: string enum: – INDUSTRIA – COMERCIO – DISTRIBUIDOR – TRANSPORTADOR_REVENDEDOR_RETALHISTA – EXTRACAO_MINERAL_OUTROS – INDUSTRIA_TRANSPORTE – PRODUTOR_RURAL – PRESTADOR_SERVICO – ATIVIDADE_FINANCEIRA – ATIVIDADE_IMOBILIARIA – COOPERATIVA – SOCIEDADE_SEGURADORES_PREVIDENCIA_COMPLEMENTAR – DISTRIBUIDOR_ENERGIA_ELETRICA – PRESTADOR_SERVICO_COMUNICACAO – OUTROS description: Tipo do ramo de atividade: * `INDUSTRIA` – Indústria * `COMERCIO` – Comércio * `DISTRIBUIDOR` – Distribuidor * `TRANSPORTADOR_REVENDEDOR_RETALHISTA` – Transportador-Revendedor-Retalhista (TRR) * `EXTRACAO_MINERAL_OUTROS` – Extração mineral/outros * `INDUSTRIA_TRANSPORTE` – Indústria/Transporte * `PRODUTOR_RURAL` – Produtor rural * `PRESTADOR_SERVICO` – Prestador de serviço * `ATIVIDADE_FINANCEIRA` – Atividade financeira * `ATIVIDADE_IMOBILIARIA` – Atividade imobiliária * `COOPERATIVA` – Cooperativa * `SOCIEDADE_SEGURADORES_PREVIDENCIA_COMPLEMENTAR` – Sociedades seguradoras de capitalização ou entidade aberta de previdência complementar * `DISTRIBUIDOR_ENERGIA_ELETRICA` – Distribuidor de energia elétrica * `PRESTADOR_SERVICO_COMUNICACAO` – Prestador de serviço de comunicação * `OUTROS` – Outros enumTipoVeiculo: type: string enum: – VEICULO – REBOQUE description: Tipo de veículo: * `VEICULO` – Veículo (tração) * `REBOQUE` – Reboque (implemento) enumTipoRodado: type: string enum: – TRUCK – TOCO – CAVALO_MECANICO – VAN – UTILITARIO – OUTRO description: Tipo de rodado: * `TRUCK` – Truck * `TOCO` – Toco * `CAVALO_MECANICO` – Cavalo mecânico * `VAN` – Van * `UTILITARIO` – Utilitário * `OUTRO` – Outro enumTipoCarroceria: type: string enum: – NAO_APLICAVEL – ABERTA – FECHADA_BAU – GRANELERA – PORTA_CONTAINER – SIDER description: Tipo de carroceria: * `NAO_APLICAVEL` – Não aplicável * `ABERTA` – Aberta * `FECHADA_BAU` – Fechada/Baú * `GRANELERA` – Granelera * `PORTA_CONTAINER` – Porta container * `SIDER` – Sider enumTipoProprietario: type: string enum: – TAC_AGREGADO – TAC_INDEPENDENTE – OUTROS description: Tipo de proprietário: * `TAC_AGREGADO` – TAC – Agregado * `TAC_INDEPENDENTE` – TAC Independente * `OUTROS` – Outros enumTipoTransportador: type: string enum: – ETC – TAC – CTC description: Tipo de transportador: * `ETC` – Empresa de Transporte Rodoviário de Cargas * `TAC` – Transportador Autônomo de Cargas * `CTC` – Cooperativa de Transporte Rodoviário de Cargas enumGrauParentesco: type: string enum: – MAE – PAI – FILHO – CONJUGE – AVO – BISAVO – SOBRINHO – TIO – NETO – SOGRO – GENRO_NORA – ENTEADO – IRMAO – FILHO_ADOTIVO – PENSIONISTA – COMPANHEIRO – TUTELA_GUARDA – MENOR_SOB_GUARDA – MADRASTA – PADRASTO – TUTOR – EX_CONJUGE – BISNETO – EX_PARCEIRO – CONCUBINA – CURATELA – SOCIOAFETIVO – OUTROS description: Grau de parentesco: * `MAE` – Mãe * `PAI` – Pai * `FILHO` – Filho * `CONJUGE` – Cônjuge * `AVO` – Avô/Avó * `BISAVO` – Bisavô * `SOBRINHO` – Sobrinho * `TIO` – Tio * `NETO` – Neto * `SOGRO` – Sogro * `GENRO_NORA` – Genro/Nora * `ENTEADO` – Enteado * `IRMAO` – Irmão * `FILHO_ADOTIVO` – Filho adotivo * `PENSIONISTA` – Pensionista * `COMPANHEIRO` – Companheiro * `TUTELA_GUARDA` – Tutela/Guarda * `MENOR_SOB_GUARDA` – Menor sob guarda * `MADRASTA` – Madrasta * `PADRASTO` – Padrasto * `TUTOR` – Tutor * `EX_CONJUGE` – Ex-cônjuge * `BISNETO` – Bisneto * `EX_PARCEIRO` – Ex-parceiro * `CONCUBINA` – Concubina * `CURATELA` – Curatela * `SOCIOAFETIVO` – Socioafetivo * `OUTROS` – Outros enumOperadoraCiot: type: string enum: – NDD description: Operadora de CIOT: * `NDD` – NDD enumTipoOperacao: type: string enum: – FROTA_PROPRIA – TERCEIROS – AMBOS description: Tipo de operação do CIOT: * `FROTA_PROPRIA` – Frota própria * `TERCEIROS` – Terceiros * `AMBOS` – Ambos enumPrioridadeOD: type: string enum: – CEP_IBGE – APENAS_IBGE – LATLONG_CEP_IBGE description: Prioridade de origem/destino: * `CEP_IBGE` – CEP e IBGE * `APENAS_IBGE` – Apenas IBGE * `LATLONG_CEP_IBGE` – LatLong, CEP e IBGE enumModeloDocumentoCarga: type: string enum: – NF – NFE – DECLARACAO – DUTOVIARIO – CFE_SAT – NFCE – OUTROS description: Enum Modelo documento de carga: * `NF` – Nota Fiscal * `NFE` – Nota Fiscal Eletrônica * `DECLARACAO` – Declaração * `DUTOVIARIO` – Dutoviário * `CFE_SAT` – Cupons Fiscais Eletrônicos SAT * `NFCE` – Nota Fiscal de Consumidor Eletrônica * `OUTROS` – Outros Documentos enumTipoPagador: type: string enum: – EMITENTE – DESTINATARIO – CONSIGNATARIO – TRANSPORTADOR description: Tipo do pagador: * `EMITENTE` – Emitente * `DESTINATARIO` – Destinatário * `CONSIGNATARIO` – Consignatário * `TRANSPORTADOR` – Transportador enumTipoChavePix: type: string enum: – CNPJ – CPF – EMAIL – TELEFONE – ALEATORIA description: Tipo de Chave PIX: * `CNPJ` – CNPJ * `CPF` – CPF * `EMAIL` – E-Mail * `TELEFONE` – Telefone * `ALEATORIA` – Aleatória enumTipoConta: type: string enum: – CONTA_CORRENTE – CONTA_POUPANCA – CONTA_INVESTIMENTO – CONTA_APLICACAO_FINANCEIRA – CONTA_EMPRESTIMO – COTA_CAPITAL – CONTA_RETENCAO – CONTA_LOJA – CONTA_SALARIO – OUTROS description: Tipo de conta: * `CONTA_CORRENTE` – Conta Corrente * `CONTA_POUPANCA` – Conta Poupança * `CONTA_INVESTIMENTO` – Conta Investimento * `CONTA_APLICACAO_FINANCEIRA` – Conta Aplicação Financeira * `CONTA_EMPRESTIMO` – Conta Empréstimo * `COTA_CAPITAL` – Cota Capital * `CONTA_RETENCAO` – Conta de Retenção * `CONTA_LOJA` – Conta da Loja * `CONTA_SALARIO` – Conta Salário * `OUTROS` – Outros enumCategoriaCnh: type: string enum: – A – B – C – D – E – AB – AC – AD – AE description: Categoria da CNH: * `A` – A * `B` – B * `C` – C * `D` – D * `E` – E * `AB` – AB * `AC` – AC * `AD` – AD * `AE` – AE enumStatusCiot: type: string enum: – EM_DIGITACAO – DECLARADO – REJEITADO – AGUARDANDO_OPERADORA – RETIFICADO – CANCELADO – ENCERRADO description: Status do ciclo de vida do CIOT: * `EM_DIGITACAO` – Em digitação * `DECLARADO` – Declarado na operadora/ANTT * `REJEITADO` – Rejeitado (habilita reenvio) * `AGUARDANDO_OPERADORA` – Aguardando retorno da operadora * `RETIFICADO` – Retificado * `CANCELADO` – Cancelado * `ENCERRADO` – Encerrado enumStatusOperadora: type: string enum: – DECLARACAO_PROCESSANDO – DECLARACAO_SEM_RETORNO_OPERADORA – DECLARACAO_CONTINGENCIA – DECLARACAO_REJEITADO – DECLARACAO_APROVADO – CANCELAMENTO_PROCESSANDO – CANCELAMENTO_SEM_RETORNO_OPERADORA – CANCELAMENTO_CONTINGENCIA – CANCELAMENTO_REJEITADO – CANCELAMENTO_APROVADO – ENCERRAMENTO_PROCESSANDO – ENCERRAMENTO_SEM_RETORNO_OPERADORA – ENCERRAMENTO_CONTINGENCIA – ENCERRAMENTO_REJEITADO – ENCERRAMENTO_APROVADO – RETIFICACAO_PROCESSANDO – RETIFICACAO_SEM_RETORNO_OPERADORA – RETIFICACAO_CONTINGENCIA – RETIFICACAO_REJEITADO – RETIFICACAO_APROVADO – CONSULTA_PROCESSANDO description: Status transitório da operação junto à operadora: * `DECLARACAO_PROCESSANDO` – Declaração em processamento pela operadora * `DECLARACAO_SEM_RETORNO_OPERADORA` – Declaração sem retorno da operadora (polling esgotado) * `DECLARACAO_CONTINGENCIA` – Declaração em contingência * `DECLARACAO_REJEITADO` – Declaração rejeitada pela operadora * `DECLARACAO_APROVADO` – Declaração aprovada pela operadora * `CANCELAMENTO_PROCESSANDO` – Cancelamento em processamento pela operadora * `CANCELAMENTO_SEM_RETORNO_OPERADORA` – Cancelamento sem retorno da operadora * `CANCELAMENTO_CONTINGENCIA` – Cancelamento em contingência * `CANCELAMENTO_REJEITADO` – Cancelamento rejeitado pela operadora * `CANCELAMENTO_APROVADO` – Cancelamento aprovado pela operadora * `ENCERRAMENTO_PROCESSANDO` – Encerramento em processamento pela operadora * `ENCERRAMENTO_SEM_RETORNO_OPERADORA` – Encerramento sem retorno da operadora * `ENCERRAMENTO_CONTINGENCIA` – Encerramento em contingência * `ENCERRAMENTO_REJEITADO` – Encerramento rejeitado pela operadora * `ENCERRAMENTO_APROVADO` – Encerramento aprovado pela operadora * `RETIFICACAO_PROCESSANDO` – Retificação em processamento pela operadora * `RETIFICACAO_SEM_RETORNO_OPERADORA` – Retificação sem retorno da operadora * `RETIFICACAO_CONTINGENCIA` – Retificação em contingência * `RETIFICACAO_REJEITADO` – Retificação rejeitada pela operadora * `RETIFICACAO_APROVADO` – Retificação aprovada pela operadora * `CONSULTA_PROCESSANDO` – Consulta de status pela operadora enumTipoViagem: type: string enum: – LOTACAO – FRACIONADA – TAC_AGREGADO description: Tipo de viagem ANTT: * `LOTACAO` – Lotação * `FRACIONADA` – Fracionada * `TAC_AGREGADO` – TAC agregado enumTipoCarga: type: string enum: – GRANEL_SOLIDO – GRANEL_LIQUIDO – FRIGORIFICADA_OU_AQUECIDA – CONTEINERIZADA – CARGA_GERAL – NEOGRANEL – PERIGOSA_GRANEL_SOLIDO – PERIGOSA_GRANEL_LIQUIDO – PERIGOSA_FRIGORIFICADA_OU_AQUECIDA – PERIGOSA_CONTEINERIZADA – PERIGOSA_CARGA_GERAL – CARGA_GRANEL_PRESSURIZADA description: Tipo de carga (códigos ANTT 1..12): * `GRANEL_SOLIDO` – Granel sólido (ANTT 1) * `GRANEL_LIQUIDO` – Granel líquido (ANTT 2) * `FRIGORIFICADA_OU_AQUECIDA` – Frigorificada ou aquecida (ANTT 3) * `CONTEINERIZADA` – Conteinerizada (ANTT 4) * `CARGA_GERAL` – Carga geral (ANTT 5) * `NEOGRANEL` – Neo granel (ANTT 6) * `PERIGOSA_GRANEL_SOLIDO` – Perigosa granel sólido (ANTT 7) * `PERIGOSA_GRANEL_LIQUIDO` – Perigosa granel líquido (ANTT 8) * `PERIGOSA_FRIGORIFICADA_OU_AQUECIDA` – Perigosa frigorificada ou aquecida (ANTT 9) * `PERIGOSA_CONTEINERIZADA` – Perigosa conteinerizada (ANTT 10) * `PERIGOSA_CARGA_GERAL` – Perigosa carga geral (ANTT 11) * `CARGA_GRANEL_PRESSURIZADA` – Carga granel pressurizada (ANTT 12) enumTipoParcela: type: string enum: – ADIANTAMENTO – SALDO – PEDAGIO – COMBUSTIVEL description: Tipo de parcela: * `ADIANTAMENTO` – Adiantamento * `SALDO` – Saldo * `PEDAGIO` – Pedágio * `COMBUSTIVEL` – Combustível enumIndicadorPagamento: type: string enum: – A_VISTA – A_PRAZO description: Indicador de pagamento: * `A_VISTA` – À vista * `A_PRAZO` – A prazo enumFormaPagamento: type: string enum: – INSTITUICAO_PAGAMENTO – CONTA_CORRENTE – CONTA_POUPANCA – CONTA_PAGAMENTO – OUTROS – PIX description: Forma de pagamento: * `INSTITUICAO_PAGAMENTO` – Instituição de pagamento (ANTT 1) * `CONTA_CORRENTE` – Conta corrente (ANTT 2) * `CONTA_POUPANCA` – Conta poupança (ANTT 3) * `CONTA_PAGAMENTO` – Conta de pagamento (ANTT 4) * `OUTROS` – Outros (ANTT 5) * `PIX` – PIX (ANTT 6) enumTipoProcesso: type: string enum: – DECLARACAO – RETIFICACAO – CANCELAMENTO – ENCERRAMENTO – CONSULTA description: Tipo de processo na operadora: * `DECLARACAO` – Declaração * `RETIFICACAO` – Retificação * `CANCELAMENTO` – Cancelamento * `ENCERRAMENTO` – Encerramento * `CONSULTA` – Consulta enumTipoAlteracaoCondutorNdd: type: string enum: – ADICAO – REMOCAO – MANTER description: Tipo de alteração do condutor a ser enviado para a NDD: * `ADICAO` – Adição de condutor (tipoAlteracao: 1 na NDD) * `REMOCAO` – Remoção de condutor (tipoAlteracao: 2 na NDD) * `MANTER` – Manter condutor — não inclui no payload NDD userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recDadosCiot: description: Dados do CIOT type: object required: – operacao properties: operacao: type: object allOf: – #/definitions/recOperacaoCiot description: Dados da operação carga: type: object allOf: – #/definitions/recCargaCiot description: Dados da carga viagem: type: object allOf: – #/definitions/recViagemCiot description: Dados da viagem documentosEmbarque: type: array items: type: object allOf: – #/definitions/recDocumentoEmbarqueCiot description: Documentos de embarque documentosTransporte: type: array items: type: object allOf: – #/definitions/recDocumentoTransporteCiot description: Documentos de transporte — CT-e veiculos: type: array items: type: object allOf: – #/definitions/recVeiculoCiot description: Veículos da operação motoristas: type: array items: type: object allOf: – #/definitions/recMotoristaCiot description: Motoristas da operação parcelas: type: array items: type: object allOf: – #/definitions/recParcelaCiot description: Parcelas de pagamento parametrosOperadora: type: array items: type: object allOf: – #/definitions/recParametroOperadoraCiot description: Parâmetros específicos da operadora recOperacaoCiot: description: Dados principais da operação CIOT type: object required: – emitente – operadora – numero – tipoOperacao – valorFrete properties: operacaoCiotId: type: string description: UUID da OperacaoCiot emitente: type: object allOf: – #/definitions/recFilialCiot description: Emitente (filial) operadora: type: object allOf: – #/definitions/recOperadoraCiot description: Operadora de CIOT numero: type: string description: Número de controle do ERP integrador serie: type: string description: Série tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo de operação tipoViagem: type: string allOf: – #/definitions/enumTipoViagem description: Tipo de viagem contratante: type: object allOf: – #/definitions/recPessoaCiot description: Contratante contratado: type: object allOf: – #/definitions/recPessoaCiot description: Contratado (Transportador) valorFrete: type: number format: double description: Valor bruto do frete dataDeclaracao: type: string format: date-time description: Data da declaração origemRegistro: type: string description: Origem do registro reenvio: type: boolean description: Reenvio recFilialCiot: description: Referência híbrida a uma filial (id ou chave natural) type: object properties: id: type: string description: UUID da filial numeroCgc: type: string description: Número da filial recOperadoraCiot: description: Referência híbrida a uma operadora de CIOT (id ou chave natural) type: object properties: id: type: string description: UUID da operadora operadora: type: string allOf: – #/definitions/enumOperadoraCiot description: Operadora enum (NDD, etc.) recPessoaCiot: description: Referência híbrida a uma pessoa (id ou chave natural) type: object properties: id: type: string description: UUID da pessoa cnpjCpf: type: string description: CNPJ/CPF da pessoa recCargaCiot: description: Dados de carga da operação type: object properties: ncm: type: object allOf: – #/definitions/recNcmCiot description: NCM da carga tipoCarga: type: string allOf: – #/definitions/enumTipoCarga description: Tipo de carga recNcmCiot: description: Referência híbrida a um NCM (id ou chave natural) type: object properties: id: type: string description: UUID do NCM codigo: type: string description: Código NCM (8 dígitos) recViagemCiot: description: Dados de viagem da operação type: object properties: retornoVazio: type: boolean description: Retorno vazio altoDesempenho: type: boolean description: Alto desempenho idaVolta: type: boolean description: Ida e volta composicaoVeicular: type: boolean description: Composição veicular dataInicio: type: string format: date-time description: Data de início da viagem dataTermino: type: string format: date-time description: Data de término da viagem trechos: type: array items: type: object allOf: – #/definitions/recTrechoCiot description: Trechos distanciaKm: type: integer format: int64 description: Distância total em km recTrechoCiot: description: Trecho (origem/destino) de uma viagem type: object required: – sequencia properties: operacaoCiotTrechoId: type: string description: UUID da OperacaoCiotTrecho sequencia: type: integer format: int64 description: Sequência do trecho origem: type: object allOf: – #/definitions/recEnderecoCiot description: Endereço de origem destino: type: object allOf: – #/definitions/recEnderecoCiot description: Endereço de destino recEnderecoCiot: description: Endereço de um trecho type: object properties: cep: type: string description: CEP latitude: type: string description: Latitude longitude: type: string description: Longitude numero: type: string description: Número complemento: type: string description: Complemento recDocumentoEmbarqueCiot: description: Referência a um documento de embarque (NF-e) type: object properties: id: type: string description: UUID do documento de embarque numero: type: string description: Número do documento serie: type: string description: Série do documento emitente: type: object allOf: – #/definitions/recPessoaCiot description: Emitente do documento modeloDocumentoCarga: type: string allOf: – #/definitions/enumModeloDocumentoCarga description: Modelo do documento recDocumentoTransporteCiot: description: Referência a um documento de transporte (CT-e) type: object properties: id: type: string description: UUID do CT-e recVeiculoCiot: description: Veículo da operação type: object properties: operacaoCiotVeiculoId: type: string description: UUID da OperacaoCiotVeiculo id: type: string description: UUID do veículo placa: type: string description: Placa do veículo rntrc: type: string description: RNTRC eixosSuspensos: type: integer format: int64 description: Eixos suspensos recMotoristaCiot: description: Motorista da operação type: object required: – motorista properties: operacaoCiotMotoristaId: type: string description: UUID do OperacaoCiotMotorista motorista: type: object allOf: – #/definitions/recPessoaCiot description: Referência à pessoa motorista recParcelaCiot: description: Parcela de pagamento type: object required: – tipoParcela – valor – creditado properties: operacaoCiotParcelaId: type: string description: UUID da OperacaoCiotParcela tipoParcela: type: string allOf: – #/definitions/enumTipoParcela description: Tipo da parcela valor: type: number format: double description: Valor creditado: type: object allOf: – #/definitions/recPessoaCiot description: Creditado (quem recebe) dataPrevistaLiberacao: type: string format: date-time description: Data prevista de liberação indicadorPagamento: type: string allOf: – #/definitions/enumIndicadorPagamento description: Indicador de pagamento formaPagamento: type: string allOf: – #/definitions/enumFormaPagamento description: Forma de pagamento informacaoBancariaPix: type: object allOf: – #/definitions/recInformacaoBancariaPixCiot description: Bloco bancário PIX (no máximo um bloco por parcela) informacaoBancariaDeposito: type: object allOf: – #/definitions/recInformacaoBancariaDepositoCiot description: Bloco bancário depósito (no máximo um bloco por parcela) recInformacaoBancariaPixCiot: description: Referência híbrida a uma informação bancária PIX (id ou chave natural) type: object properties: id: type: string description: UUID da chave PIX tipoChave: type: string allOf: – #/definitions/enumTipoChavePix description: Tipo da chave PIX valorChave: type: string description: Valor da chave PIX recInformacaoBancariaDepositoCiot: description: Referência híbrida a uma informação bancária depósito (id ou chave natural) type: object properties: id: type: string description: UUID da conta depósito banco: type: object allOf: – #/definitions/recBancoCiot description: Banco agencia: type: string description: Agência numeroConta: type: string description: Número da conta recBancoCiot: description: Referência híbrida a um banco (id ou chave natural) type: object properties: id: type: string description: UUID do banco codigo: type: string description: Código do banco (3 dígitos) recParametroOperadoraCiot: description: Parâmetro específico de operadora type: object required: – chave – valor properties: operacaoCiotParametroId: type: string description: UUID do OperacaoCiotParametro chave: type: string description: Chave do parâmetro valor: type: string description: Valor do parâmetro recRetornoCiot: description: Dados de retorno do CIOT type: object required: – operacaoId – sucesso – mensagem properties: operacaoId: type: string description: UUID da operação persistida sucesso: type: boolean description: Indica se a operação (receber, enviar, etc) foi realizada com sucesso mensagem: type: string description: Mensagem de retorno (sucesso ou erro da operadora) operadoraCiot: description: Operadora de CIOT – configuração de credenciais e tipo de operação type: object required: – operadora – descricao – tipoOperacao – seriePadrao – prioridadeOrigemDestino – pontoEmissor – urlBase – urlAutenticacao – clientId – clientSecret properties: id: type: string format: uuid description: Id da entidade operadora: type: string allOf: – #/definitions/enumOperadoraCiot description: Operadora descricao: type: string maxLength: 100 description: Descrição tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo de operação seriePadrao: type: string maxLength: 5 description: Série padrão prioridadeOrigemDestino: type: string allOf: – #/definitions/enumPrioridadeOD description: Prioridade de origem/destino pontoEmissor: type: string maxLength: 30 description: Ponto emissor urlBase: type: string maxLength: 500 description: URL base da API da operadora urlAutenticacao: type: string maxLength: 500 description: URL de autenticação OAuth clientId: type: string maxLength: 100 description: Client ID OAuth clientSecret: type: string maxLength: 500 description: Client Secret OAuth (criptografado, base64) ativo: type: boolean description: Ativo default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOperadoraCiot: type: object required: – id allOf: – #/definitions/operadoraCiot operadoraCiotFilial: description: Filial emitente vinculada a uma operadora de CIOT type: object required: – operadoraCiot – filial properties: id: type: string format: uuid description: Id da entidade operadoraCiot: type: object allOf: – #/definitions/operadoraCiot description: Operadora de CIOT filial: type: object allOf: – #/definitions/filial description: Filial emitente configuracaoPadrao: type: boolean description: Configuração padrão (herda da operadora) default: true pontoEmissor: type: string maxLength: 30 description: Ponto emissor (override) seriePadrao: type: string maxLength: 5 description: Série padrão (override) prioridadeOrigemDestino: type: string allOf: – #/definitions/enumPrioridadeOD description: Prioridade de origem/destino (override) clientId: type: string maxLength: 100 description: Client ID (override) clientSecret: type: string maxLength: 500 description: Client Secret (override, criptografado, base64) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOperadoraCiotFilial: type: object required: – id allOf: – #/definitions/operadoraCiotFilial operacaoCiot: description: Operação de CIOT recebida type: object required: – emitente – operadoraCiot – numero – tipoViagem – tipoOperacao – valorFrete – dataInicio – dataTermino – statusCiot properties: id: type: string format: uuid description: Id da entidade emitente: type: object allOf: – #/definitions/filial description: Emitente (filial) operadoraCiot: type: object allOf: – #/definitions/operadoraCiot description: Operadora numero: type: string maxLength: 20 description: Número de controle do ERP integrador serie: type: string maxLength: 5 description: Série tipoViagem: type: string allOf: – #/definitions/enumTipoViagem description: Tipo de viagem tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo de operação contratante: type: object allOf: – #/definitions/pessoa description: Contratante contratado: type: object allOf: – #/definitions/pessoa description: Contratado (Transportador) origemRegistro: type: string maxLength: 20 description: Origem do registro (API/TELA) valorFrete: type: number format: double description: Valor bruto do frete dataDeclaracao: type: string format: date-time description: Data da declaração ncm: type: object allOf: – #/definitions/nomenclaturaComumMercosul description: NCM da carga tipoCarga: type: string allOf: – #/definitions/enumTipoCarga description: Tipo de carga retornoVazio: type: boolean description: Retorno vazio default: false altoDesempenho: type: boolean description: Alto desempenho default: false idaVolta: type: boolean description: Ida e volta default: false composicaoVeicular: type: boolean description: Composição veicular default: false dataInicio: type: string format: date-time description: Data de início da viagem dataTermino: type: string format: date-time description: Data de término da viagem distanciaKm: type: integer format: int64 description: Distância total em km statusCiot: type: string allOf: – #/definitions/enumStatusCiot description: Status do ciclo de vida do CIOT (eixo definitivo) statusOperadora: type: string allOf: – #/definitions/enumStatusOperadora description: Status transitório da última ação junto à operadora ciotAntt: type: string maxLength: 20 description: CIOT ANTT ciotCodigoVerificador: type: string maxLength: 4 description: Código verificador do CIOT protocoloOperadora: type: string maxLength: 50 description: Protocolo mais recente da operadora motoristas: type: array items: type: object allOf: – #/definitions/operacaoCiotMotorista description: Motoristas documentosEmbarque: type: array items: type: object allOf: – #/definitions/documentoEmbarque description: Documentos de embarque documentosTransporte: type: array items: type: object allOf: – #/definitions/documentoTransporte description: Documentos de transporte trechos: type: array items: type: object allOf: – #/definitions/operacaoCiotTrecho description: Trechos da operação veiculos: type: array items: type: object allOf: – #/definitions/operacaoCiotVeiculo description: Veículos da operação parcelas: type: array items: type: object allOf: – #/definitions/operacaoCiotParcela description: Parcelas da operação parametros: type: array items: type: object allOf: – #/definitions/operacaoCiotParametro description: Parâmetros da operação historicos: type: array items: type: object allOf: – #/definitions/operacaoCiotHistorico description: Histórico da operação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOperacaoCiot: type: object required: – id allOf: – #/definitions/operacaoCiot operacaoCiotTrecho: description: Trecho (origem/destino) da operação type: object required: – operacao – sequencia properties: id: type: string format: uuid description: Id da entidade operacao: type: object allOf: – #/definitions/operacaoCiot description: Operação sequencia: type: integer format: int64 description: Sequência do trecho origemCidadeFaixaCep: type: object allOf: – #/definitions/cidadeFaixaCep description: Faixa de CEP de origem (deriva a cidade) origemCep: type: string maxLength: 20 description: CEP exato de origem (preservado como recebido) origemLatitude: type: string maxLength: 15 description: Latitude de origem origemLongitude: type: string maxLength: 15 description: Longitude de origem origemNumero: type: string maxLength: 10 description: Número de origem origemComplemento: type: string maxLength: 100 description: Complemento de origem destinoCidadeFaixaCep: type: object allOf: – #/definitions/cidadeFaixaCep description: Faixa de CEP de destino (deriva a cidade) destinoCep: type: string maxLength: 20 description: CEP exato de destino (preservado como recebido) destinoLatitude: type: string maxLength: 15 description: Latitude de destino destinoLongitude: type: string maxLength: 15 description: Longitude de destino destinoNumero: type: string maxLength: 10 description: Número de destino destinoComplemento: type: string maxLength: 100 description: Complemento de destino createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: operacaoCiotVeiculo: description: Veículo vinculado à operação type: object required: – operacao – veiculo properties: id: type: string format: uuid description: Id da entidade operacao: type: object allOf: – #/definitions/operacaoCiot description: Operação veiculo: type: object allOf: – #/definitions/veiculo description: Veículo rntrc: type: string maxLength: 14 description: RNTRC eixosSuspensos: type: integer format: int64 description: Eixos suspensos default: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: operacaoCiotMotorista: description: Motorista vinculado a uma operação type: object required: – operacao – motorista properties: id: type: string format: uuid description: Id da entidade operacao: type: object allOf: – #/definitions/operacaoCiot description: Operação CIOT motorista: type: object allOf: – #/definitions/pessoa description: Motorista (pessoa) tipoAlteracaoNdd: type: string allOf: – #/definitions/enumTipoAlteracaoCondutorNdd description: Tipo de alteração a ser enviado para a NDD no próximo envio createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: operacaoCiotParcela: description: Parcela da operação type: object required: – operacao – tipoParcela – valor – creditado properties: id: type: string format: uuid description: Id da entidade operacao: type: object allOf: – #/definitions/operacaoCiot description: Operação tipoParcela: type: string allOf: – #/definitions/enumTipoParcela description: Tipo da parcela valor: type: number format: double description: Valor creditado: type: object allOf: – #/definitions/pessoa description: Creditado (pessoa que recebe) dataPrevistaLiberacao: type: string format: date-time description: Data prevista de liberação indicadorPagamento: type: string allOf: – #/definitions/enumIndicadorPagamento description: Indicador de pagamento formaPagamento: type: string allOf: – #/definitions/enumFormaPagamento description: Forma de pagamento informacaoBancariaPix: type: object allOf: – #/definitions/informacaoBancariaPix description: Bloco bancário PIX informacaoBancariaDeposito: type: object allOf: – #/definitions/informacaoBancariaDeposito description: Bloco bancário depósito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: operacaoCiotParametro: description: Parâmetro específico de operadora type: object required: – operacao – chave – valor properties: id: type: string format: uuid description: Id da entidade operacao: type: object allOf: – #/definitions/operacaoCiot description: Operação chave: type: string maxLength: 100 description: Chave valor: type: string maxLength: 500 description: Valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: operacaoCiotHistorico: description: Histórico de interações com a operadora/ANTT type: object required: – operacao – tipoProcesso properties: id: type: string format: uuid description: Id da entidade operacao: type: object allOf: – #/definitions/operacaoCiot description: Operação tipoProcesso: type: string allOf: – #/definitions/enumTipoProcesso description: Tipo de processo protocolo: type: string maxLength: 50 description: Protocolo dataEnvio: type: string format: date-time description: Data de envio dataRetorno: type: string format: date-time description: Data de retorno statusCiot: type: string allOf: – #/definitions/enumStatusCiot description: Status do ciclo de vida do CIOT no momento desta interação statusOperadora: type: string allOf: – #/definitions/enumStatusOperadora description: Status transitório da operação junto à operadora no momento desta interação ciotAntt: type: string maxLength: 20 description: CIOT ANTT ciotCodigoVerificador: type: string maxLength: 4 description: Código verificador do CIOT protocoloAntt: type: string maxLength: 20 description: Protocolo ANTT codigoExterno: type: string description: Código externo gerado pela Operadora mensagemRetorno: type: string description: Mensagem de retorno da Operadora createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editOperacaoCiotHistorico: type: object required: – id allOf: – #/definitions/operacaoCiotHistorico pais: description: Entidade de Pais type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código nome: type: string description: Nome codigoIso: type: string description: Código ISO excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: estado: description: Entidade de Estado type: object required: – pais properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/pais description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cidade: description: Entidade de Cidade type: object required: – estado properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/estado description: Estado codigoIbge: type: integer format: int64 description: Código IBGE excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cidadeFaixaCep: description: Entidade da Faixa de Código Postal type: object properties: id: type: string format: uuid description: Id da entidade cepInicial: type: string maxLength: 20 description: CEP Inicial cepFinal: type: string maxLength: 20 description: CEP Final cidade: type: object allOf: – #/definitions/cidade description: Cidade extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: empresa: description: Entidade de Empresa type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código empresa nome: type: string description: Nome empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Entidade de Filial type: object required: – empresa properties: id: type: string format: uuid description: Id da entidade empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: integer format: int64 description: Código filial numeroCgc: type: string description: CPF/CNPJ sigla: type: string description: Sigla nome: type: string description: Nome excluido: type: boolean description: Indica se o registro foi excluído default: false filialComoPessoa: type: object allOf: – #/definitions/pessoa description: Filial como pessoa extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoa: description: Entidade de Pessoa type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código pessoa nome: type: string description: Nome pessoa nomeFantasia: type: string description: Nome fantasia cnpjCpf: type: string description: CNPJ/CPF numRg: type: string maxLength: 15 description: Número do RG dataNascimento: type: string format: date-time description: Data de nascimento tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa pessoaTransportadora: type: object allOf: – #/definitions/pessoaTransportadora description: Transportadora cepCodigo: type: string description: CEP endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: object allOf: – #/definitions/cidade description: Cidade estado: type: object allOf: – #/definitions/estado description: Estado pais: type: object allOf: – #/definitions/pais description: País telefone: type: string maxLength: 20 description: Telefone da pessoa telefone2: type: string maxLength: 20 description: Telefone 2 da pessoa nomeFiliacao1: type: string maxLength: 40 description: Nome filiação 1 grauParentesco1: type: string allOf: – #/definitions/enumGrauParentesco description: Grau de parentesco 1 nomeFiliacao2: type: string maxLength: 40 description: Nome filiação 2 grauParentesco2: type: string allOf: – #/definitions/enumGrauParentesco description: Grau de parentesco 2 ramoAtividade: type: object allOf: – #/definitions/ramoAtividade description: Ramo de Atividade tipoRamoAtividade: type: string allOf: – #/definitions/enumRamoAtividade description: Tipo de ramo de atividade informacaoBancariaPix: type: array items: type: object allOf: – #/definitions/informacaoBancariaPix description: Informação Bancária PIX informacaoBancariaDeposito: type: array items: type: object allOf: – #/definitions/informacaoBancariaDeposito description: Informação Bancária Depósito documentosComplementares: type: object allOf: – #/definitions/documentosComplementares description: Documentos complementares da pessoa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaTransportadora: description: Entidade de Pessoa Transportadora type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa rntrc: type: string maxLength: 14 description: RNTRC excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: nomenclaturaComumMercosul: description: Cadastro para definição do Nomenclatura Comum do Mercosul (NCM) type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 8 description: Nomenclatura Comum do Mercosul (NCM) descricao: type: string maxLength: 250 description: Descrição excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ramoAtividade: description: Ramo de Atividade type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 5 description: Código descricao: type: string maxLength: 100 description: Descrição abreviatura: type: string maxLength: 10 description: Abreviatura condutor: type: boolean description: Condutor default: false excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: proprietarioVeiculo: description: Proprietário de Veículo type: object properties: id: type: string format: uuid description: Id da entidade tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo da pessoa cnpjCpf: type: string maxLength: 14 description: CNPJ/CPF nome: type: string maxLength: 60 description: Nome rntrc: type: string maxLength: 14 description: RNTRC tipoProprietario: type: string allOf: – #/definitions/enumTipoProprietario description: Tipo do proprietário ativo: type: boolean description: Situação do proprietário default: true excluido: type: boolean description: Indica se o registro foi excluído default: false tipoTransportador: type: string allOf: – #/definitions/enumTipoTransportador description: Tipo do transportador extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: veiculo: description: Veículo type: object properties: id: type: string format: uuid description: Id da entidade pessoaTransportadora: type: object allOf: – #/definitions/pessoaTransportadora description: Pessoa Transportadora placa: type: string maxLength: 10 description: Placa do veículo tipoVeiculo: type: string allOf: – #/definitions/enumTipoVeiculo description: Tipo do veículo tipoRodado: type: string allOf: – #/definitions/enumTipoRodado description: Tipo de rodado tipoCarroceria: type: string allOf: – #/definitions/enumTipoCarroceria description: Tipo de carroceria proprietarioVeiculo: type: object allOf: – #/definitions/proprietarioVeiculo description: Proprietário do veículo classificacao: type: object allOf: – #/definitions/classificacaoVeiculo description: Classificação de Veículos ativo: type: boolean description: Situação do veículo default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoDocumentoEmbarque: description: Tipo Documento Embarque type: object required: – codigo – abreviacao – descricao – modeloDocumentoCarga properties: id: type: string format: uuid description: Identificador único codigo: type: string maxLength: 15 description: Código abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string maxLength: 255 description: Descrição modeloDocumentoCarga: type: string allOf: – #/definitions/enumModeloDocumentoCarga description: Modelo documento carga createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoEmbarque: description: Documentos de embarque type: object required: – numero – serie – emitente – tipo – documentoEmbarqueDadosTransporte – valorDocumento properties: id: type: string format: uuid description: Id da entidade numero: type: string description: Numero serie: type: string maxLength: 3 description: Série emitente: type: object allOf: – #/definitions/pessoa description: Emitente tipo: type: object allOf: – #/definitions/tipoDocumentoEmbarque description: Tipo do documento destinatario: type: object allOf: – #/definitions/pessoa description: Destinatário origemCep: type: string maxLength: 20 description: Cep origem origemLogradouro: type: string description: Logradouro endereço origem origemNumero: type: string maxLength: 255 description: Numero endereço origem origemComplemento: type: string description: Complemento endereço origem origemBairro: type: string description: Bairro complemento origem origemCidade: type: string description: Cidade complemento origem origemEstado: type: string description: Estado complemento origem documentoEmbarqueDadosTransporte: type: object allOf: – #/definitions/documentoEmbarqueDadosTransporte description: Dados do transporte origemPais: type: string description: Pais complemento origem destinoCep: type: string maxLength: 20 description: Cel destino destinoLogradouro: type: string description: Logradouro endereço destino destinoNumero: type: string maxLength: 255 description: Numero endereço destino destinoComplemento: type: string description: Complemento endereço destino destinoBairro: type: string description: Bairro endereço destino destinoCidade: type: string description: Cidade endereço destino destinoEstado: type: string description: Estado endereço destino destinoPais: type: string description: Pais endereço destino dataEmissao: type: string format: date-time description: Data de emissão chave: type: string description: Chave valorDocumento: type: number format: double description: Valor documento operacoesCiot: type: array items: type: object allOf: – #/definitions/operacaoCiot description: Operações CIOT que referenciam este documento de embarque createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoEmbarqueDadosTransporte: description: Documentos de embarque – Dados do transporte type: object required: – pagador – tipoPagador properties: id: type: string format: uuid description: Id da entidade documentoEmbarque: type: object allOf: – #/definitions/documentoEmbarque description: Documento de embarque pagador: type: object allOf: – #/definitions/pessoa description: Pagador tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo de pagador pesoFisico: type: number format: double description: Peso físico createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoTransporte: description: Documentos de transporte type: object properties: id: type: string format: uuid description: Id da entidade operacoesCiot: type: array items: type: object allOf: – #/definitions/operacaoCiot description: Operações CIOT que referenciam este documento de transporte createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: informacaoBancariaPix: description: Cadastros – Pessoa – Chave PIX type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa tipoChave: type: string allOf: – #/definitions/enumTipoChavePix description: Tipo de Chave valorChave: type: string description: Valor da Chave chavePadrao: type: boolean description: Chave Padrão ativo: type: boolean description: Situação do Pix default: true nomeFavorecido: type: string description: Nome do favorecido documentoFavorecido: type: string description: Numero do documento do favorecido (CPF/CNPJ) excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: banco: description: Banco // erpx-fnd-pessoa – E030BAN type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 3 description: Código do banco nome: type: string maxLength: 100 description: Nome do banco excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: informacaoBancariaDeposito: description: Especialização – Dados Bancários – Depósitos Bancários type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa banco: type: object allOf: – #/definitions/banco description: Código do banco da conta corrente agencia: type: string maxLength: 5 description: Código da agência do banco da conta corrente digitoVerificadorAgencia: type: integer format: int64 description: Digito verificador agência minimum: 0 maximum: 9 numeroContaCorrente: type: string maxLength: 12 description: Número da conta corrente digitoVerificadorConta: type: integer format: int64 description: Digito verificador da conta minimum: 0 maximum: 9 tipoConta: type: string allOf: – #/definitions/enumTipoConta description: Tipo de conta contaPadrao: type: boolean description: Conta padrão numeroDocumento: type: string maxLength: 14 description: Numero do documento do favorecido (CPF/CNPJ) nomeFavorecido: type: string maxLength: 255 description: Nome do favorecido ativo: type: boolean description: Indica a situação atual do registro default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentosComplementares: description: Documentos complementares da pessoa type: object properties: id: type: string format: uuid description: Identificador único pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa cnhNumero: type: string maxLength: 20 description: Número da CNH cnhCategoria: type: string allOf: – #/definitions/enumCategoriaCnh description: Categoria da CNH cnhEstadoEmissao: type: object allOf: – #/definitions/estado description: Estado de emissão da CNH cnhDataEmissao: type: string format: date description: Data de emissão da CNH cnhDataValidade: type: string format: date description: Data de validade da CNH cnhDataPrimeira: type: string format: date description: Data da primeira CNH extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: classificacaoVeiculo: description: Classificação de Veículos type: object required: – codigo – descricao – qtdEixos properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 10 description: Código de identificação da Classificação descricao: type: string maxLength: 100 description: Descrição da classificação qtdEixos: type: integer format: int64 description: Quantidade de eixos da placa (Veículo individual) minimum: 0 maximum: 9 ativo: type: boolean description: Indica se a Classificação está ativa default: true excluido: type: boolean description: Indicador de registro excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage

Este artigo foi útil para você?

Sim  Não
Leave A Comment Cancelar resposta

Você precisa fazer o login para publicar um comentário.

© 2022 Senior. Todos os direitos reservados.
Mais pesquisados:Customização, Tutorial, Documentação