Mais pesquisados:Customização, Tutorial, Documentação

documentos

799 views 0 11/12/2020 Atualizado em 26/08/2024 integrador

2.0info: 3.27.0 documentos description: Serviço para retorno dos documentos relacionados aos processos do TMS x-senior-domain: tms x-senior-domain-path: tms x-senior-service-path: documentos 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/tmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /documentos/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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData 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/enumUpDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/recCheckData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaPermissoesUsuario: post: description: Busca propriedades dos papéis para login externo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: ocultarDataPrevisaoEntrega: type: string allOf: – #/definitions/enumTypeSN description: Ocultar data de previsão de entrega movimentaOcorrenciaConhecimentoEntregue: type: string allOf: – #/definitions/enumTypeSN description: Permite ocorrência de entrega em conhecimento entregue permiteTipoIcmsCotacaoFrete: type: string allOf: – #/definitions/enumTypeSN description: Permite informar o tipo de ICMS validaRegiaoColeta: type: string allOf: – #/definitions/enumValidaRegiaoColeta description: Validação de região de coleta/entrega exigeContatoColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o contato da coleta exigeVolumeColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar a quantidade de volumes na coleta exigePesoColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o peso na coleta exigeDestinatarioColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o destinatário na coleta exigeNotaFiscalColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar a nota fiscal na coleta permiteConsultarColetasDestinatario: type: string allOf: – #/definitions/enumTypeSN description: Permite consultar coletas que for Destinatário da Ordem de Coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca propriedades dos papéis para login externo tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object properties: ocultarDataPrevisaoEntrega: type: string allOf: – #/definitions/enumTypeSN description: Ocultar data de previsão de entrega movimentaOcorrenciaConhecimentoEntregue: type: string allOf: – #/definitions/enumTypeSN description: Permite ocorrência de entrega em conhecimento entregue permiteTipoIcmsCotacaoFrete: type: string allOf: – #/definitions/enumTypeSN description: Permite informar o tipo de ICMS validaRegiaoColeta: type: string allOf: – #/definitions/enumValidaRegiaoColeta description: Validação de região de coleta/entrega exigeContatoColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o contato da coleta exigeVolumeColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar a quantidade de volumes na coleta exigePesoColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o peso na coleta exigeDestinatarioColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o destinatário na coleta exigeNotaFiscalColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar a nota fiscal na coleta permiteConsultarColetasDestinatario: type: string allOf: – #/definitions/enumTypeSN description: Permite consultar coletas que for Destinatário da Ordem de Coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaUrlUploadArquivo: post: description: Obtém Url para enviar o arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dados properties: dados: type: object allOf: – #/definitions/recEnvArquivoBlobService description: Informação para gerar a URL de upload responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: object allOf: – #/definitions/recRetArquivoBlobService description: Retorno das informações para upload do arquivo no blobservice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaUrlDownloadArquivo: post: description: Obtém Url para baixar o arquivo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentos properties: documentos: type: array items: type: object allOf: – #/definitions/recDocumentoDownload minimum: 1 description: Informações dos documentos para download agruparPDF: type: boolean description: Agrupar arquivos do tipo PDF default: false responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: array items: type: object allOf: – #/definitions/recRetArquivoBlobService minimum: 1 description: Retorno das informações para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaClientePermissoesUsuario: post: description: Busca clientes permitidos pelos papéis do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – clientes properties: clientes: type: array items: type: object allOf: – #/definitions/recCliente minimum: 1 description: Lista de clientes permitidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca clientes permitidos pelos papéis do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – clientes properties: clientes: type: array items: type: object allOf: – #/definitions/recCliente minimum: 1 description: Lista de clientes permitidos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaFilialPermissoesUsuario: post: description: Busca filiais permitidas pelos papéis do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Lista de filiais permitidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca filiais permitidas pelos papéis do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – filiais properties: filiais: type: array items: type: object allOf: – #/definitions/recFilial minimum: 1 description: Lista de filiais permitidas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaCotacoesUsuario: post: description: Busca cotacoes realizadas pelo usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: situacao: type: array items: type: string allOf: – #/definitions/enumSituacaoCotacaoFrete description: Situação da cotação vencimento: type: string allOf: – #/definitions/enumSituacaoVencimento description: Condição de vencimento identificador: type: integer format: int64 description: Identificador simulação codigoCotacao: type: integer format: int64 description: Número da cotação dataEmissaoInicial: type: string format: date-time description: Data da cotação/Simulação inicial dataEmissaoFinal: type: string format: date-time description: Data da cotação/Simulação final remetente: type: string description: Inscricao Fiscal Remetente destinatario: type: string description: Inscricao Fiscal Destintário consignatario: type: string description: Inscricao Fiscal Consignatário dataVencimentoInicial: type: string format: date-time description: Data do vencimento da cotação/Simulação inicial dataVencimentoFinal: type: string format: date-time description: Data do vencimento da cotação/Simulação final dataAprovacaoInicial: type: string format: date-time description: Data do Aprovacao da cotação/Simulação inicial dataAprovacaoFinal: type: string format: date-time description: Data do Aprovacao da cotação/Simulação final pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – cotacoesFrete – totalRegistros properties: cotacoesFrete: type: array items: type: object allOf: – #/definitions/recCotacaoFrete minimum: 1 description: Cotação de frete persistida totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaDestinosColeta: post: description: Busca destinatários da coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da coleta responses: 200: description: Ok schema: type: object required: – destinos properties: destinos: type: array items: type: object allOf: – #/definitions/recColetaDestinoUnico minimum: 1 description: Destinos da coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca destinatários da coleta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da coleta in: query required: true type: string responses: 200: description: Ok schema: type: object required: – destinos properties: destinos: type: array items: type: object allOf: – #/definitions/recColetaDestinoUnico minimum: 1 description: Destinos da coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaColetasUsuario: post: description: Busca coletas realizadas pelo usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: situacao: type: array items: type: string allOf: – #/definitions/enumSituacaoColeta description: Situação da cotação codigoColeta: type: integer format: int64 description: Número da coleta notaFiscal: type: integer format: int64 description: Número da nota fiscal dataAgendamentoInicial: type: string format: date-time description: Data de Agendamento inicial dataAgendamentoFinal: type: string format: date-time description: Data de Agendamento final cliente: type: string description: Inscricao Fiscal Remetente destinatario: type: string description: Inscricao Fiscal Destinatário pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – coletas – totalRegistros properties: coletas: type: array items: type: object allOf: – #/definitions/recColeta minimum: 1 description: Cotação de frete persistida totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaConhecimentos: post: description: Obtém lista de conhecimentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: faturaNumero: type: string description: Número da fatura conhecimentoNumero: type: string description: Número do conhecimento conhecimentoDataIni: type: string format: date-time description: Data início da emissão do conhecimento conhecimentoDataFim: type: string format: date-time description: Data fim da emissão do conhecimento conhecimentoCnpj: type: string description: CNPJ relacionado ao conhecimento notafiscalNumero: type: string description: Número da nota fiscal conhecimentoSituacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação do conhecimento rotinaPortal: type: string allOf: – #/definitions/enumRotinaPortal description: Rotina do portal que é feita solicitação pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – conhecimento – totalRegistros properties: conhecimento: type: array items: type: object allOf: – #/definitions/recConhecimento minimum: 1 description: Informações do conhecimento totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaFaturas: post: description: Obtém lista de faturas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: faturaNumero: type: string description: Número da fatura conhecimentoNumero: type: string description: Número do conhecimento faturaDataIni: type: string format: date-time description: Data início da emissão da fatura faturaDataFim: type: string format: date-time description: Data fim da emissão da fatura conhecimentoCnpj: type: string description: CNPJ relacionado ao conhecimento notafiscalNumero: type: string description: Número da nota fiscal faturaSituacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação da fatura pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados faturaDataVencimentoIni: type: string format: date-time description: Data início do vencimento da fatura faturaDataVencimentoFim: type: string format: date-time description: Data fim da do vencimento da fatura visualizada: type: boolean description: Fatura já visualizada? downloadRealizado: type: boolean description: Download já foi realizado? responses: 200: description: Ok schema: type: object required: – fatura – totalRegistros properties: fatura: type: array items: type: object allOf: – #/definitions/recFatura minimum: 1 description: Informações da fatura totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaNotasFiscais: post: description: Obtém notas fiscais tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: notafiscalNumero: type: string description: Número da nota fiscal conhecimentoNumero: type: string description: Número do conhecimento notafiscalDataIni: type: string format: date-time description: Data início da emissão da nota fiscal notafiscalDataFim: type: string format: date-time description: Data fim da emissão da nota fiscal conhecimentoCnpj: type: string description: CNPJ relacionado ao conhecimento notafiscalCnpj: type: string description: CNPJ relacionado a nota fiscal notafiscalSerie: type: string description: Série da nota fiscal pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – notasFiscais – totalRegistros properties: notasFiscais: type: array items: type: object allOf: – #/definitions/recNotaFiscal minimum: 1 description: Informações da nota fiscal totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaConhecimentosArquivos: post: description: Obtém os arquivos do conhecimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conhecimentoID properties: conhecimentoID: type: string description: Identificação do conhecimento responses: 200: description: Ok schema: type: object required: – ok – msgErro – retorno properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum retorno: type: object allOf: – #/definitions/recRetArquivoBlobService description: Retorno das informações para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém os arquivos do conhecimento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: conhecimentoID description: Identificação do conhecimento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – msgErro – retorno properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum retorno: type: object allOf: – #/definitions/recRetArquivoBlobService description: Retorno das informações para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaConfiguracoesLogisticaPapel: post: description: Obtém as configurações de logística do papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – papelID properties: papelID: type: string description: ID Papel responses: 200: description: Ok schema: type: object required: – ok – msgErro – papelLogistica properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum papelLogistica: type: object allOf: – #/definitions/recPapelLogistica description: Dados do papel logística 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém as configurações de logística do papel tags: – Queries x-senior-visibility: PRIVATE parameters: – name: papelID description: ID Papel in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – msgErro – papelLogistica properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum papelLogistica: type: object allOf: – #/definitions/recPapelLogistica description: Dados do papel logística 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaPrazoEntrega: post: description: Obtém o prazo de entrega tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: ufOrigem: type: string description: UF origem cidadeOrigem: type: string description: Cidade origem ufDestino: type: string description: UF destino cidadeDestino: type: string description: Cidade destino cepOrigem: type: string description: CEP origem cepDestino: type: string description: CEP destino responses: 200: description: Ok schema: type: object required: – ok – msgErro – percursos properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum percursos: type: array items: type: object allOf: – #/definitions/recPercurso minimum: 1 description: Lista dos percursos de entrega 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o prazo de entrega tags: – Queries x-senior-visibility: PRIVATE parameters: – name: ufOrigem description: UF origem in: query type: string – name: cidadeOrigem description: Cidade origem in: query type: string – name: ufDestino description: UF destino in: query type: string – name: cidadeDestino description: Cidade destino in: query type: string – name: cepOrigem description: CEP origem in: query type: string – name: cepDestino description: CEP destino in: query type: string responses: 200: description: Ok schema: type: object required: – ok – msgErro – percursos properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum percursos: type: array items: type: object allOf: – #/definitions/recPercurso minimum: 1 description: Lista dos percursos de entrega 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaUF: post: description: Obtém lista de UF tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – msgErro – ufs properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum ufs: type: array items: type: string minimum: 1 description: Lista das UFs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém lista de UF tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – ok – msgErro – ufs properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum ufs: type: array items: type: string minimum: 1 description: Lista das UFs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaCidade: post: description: Obtém lista de cidades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uf properties: uf: type: string description: UF responses: 200: description: Ok schema: type: object required: – ok – msgErro – cidades properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum cidades: type: array items: type: string minimum: 1 description: Lista das cidades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém lista de cidades tags: – Queries x-senior-visibility: PRIVATE parameters: – name: uf description: UF in: query required: true type: string responses: 200: description: Ok schema: type: object required: – ok – msgErro – cidades properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum cidades: type: array items: type: string minimum: 1 description: Lista das cidades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaRelatorioDocumentos: post: description: Obtém relatório de documentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: relatorioDocumentoIn: type: object allOf: – #/definitions/recRelatorioDocumentoIn description: Filtro para consultar os documentos pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – ok – msgErro – totalRegistros – documentos properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum totalRegistros: type: integer format: int64 description: Total de registros encontrados documentos: type: array items: type: object allOf: – #/definitions/relSituacaoTransporte minimum: 1 description: Retorno das informações dos documentos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaComprovantesEntregaConhecimentos: post: description: Busca pelos comprovantes de entrega dos conhecimentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filtros properties: filtros: type: object allOf: – #/definitions/recFiltroBuscaComprovantesEntrega description: Filtros da consulta pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar a requisição dos dados responses: 200: description: Ok schema: type: object required: – totalRegistros – comprovantes properties: totalRegistros: type: integer format: int64 description: Total de registros encontrados comprovantes: type: array items: type: object allOf: – #/definitions/recComprovanteEntregaDto minimum: 1 description: Lista com os comprovantes encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaURLCSVRelatorioDocumentos: post: description: Obtém Url para baixar o CSV do relatório de documentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – relatorioDocumentoIn properties: relatorioDocumentoIn: type: object allOf: – #/definitions/recRelatorioDocumentoIn description: Filtro para consultar os documentos responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: object allOf: – #/definitions/recRetArquivoBlobService description: Retorno das informações para upload do arquivo no blobservice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/queries/buscaURLCSVRelatorioDocumentosNotificacao: post: description: Obtém Url para baixar o CSV do relatório de documentos via notificação da Senior X tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – relatorioDocumentoIn properties: relatorioDocumentoIn: type: object allOf: – #/definitions/recRelatorioDocumentoIn description: Filtro para consultar os documentos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/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 /documentos/queries/exportProcessamento: 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 /documentos/queries/exportTipoDocumento: 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 /documentos/queries/exportTipoCliente: 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 /documentos/queries/exportTipoDocumentoFiscal: 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 /documentos/queries/exportArquivo: 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 /documentos/queries/exportOcorrencia: 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 /documentos/queries/exportPlanoConta: 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 /documentos/queries/exportCentroCusto: 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 /documentos/queries/exportCondicaoVencimento: 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 /documentos/queries/exportRegiao: 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 /documentos/queries/exportCep: 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 /documentos/queries/exportPercurso: 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 /documentos/queries/exportPercursoComercial: 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 /documentos/queries/exportConfiguracoesGerais: 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 /documentos/queries/exportTipoTransporte: 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 /documentos/queries/exportTipoVeiculo: 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 /documentos/queries/exportEspecieCarga: 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 /documentos/queries/exportNaturezaCarga: 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 /documentos/queries/exportNaturezaOperacao: 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 /documentos/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 /documentos/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 /documentos/queries/exportCliente: 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 /documentos/queries/exportClientePercurso: 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 /documentos/queries/exportFatura: 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 /documentos/queries/exportPortadorFatura: 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 /documentos/queries/exportFaturaArquivo: 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 /documentos/queries/exportConhecimento: 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 /documentos/queries/exportConhecimentoArquivo: 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 /documentos/queries/exportFaturaConhecimento: 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 /documentos/queries/exportOcorrenciaConhecimento: 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 /documentos/queries/exportOcorrenciaConhecimentoArquivo: 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 /documentos/queries/exportNotaFiscal: 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 /documentos/queries/exportNotaFiscalArquivo: 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 /documentos/queries/exportNotaFiscalConhecimento: 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 /documentos/queries/exportNotaFiscalServico: 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 /documentos/queries/exportNotaFiscalServicoArquivo: 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 /documentos/queries/exportRelSituacaoTransporte: 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 /documentos/queries/exportClienteInfoTecnica: 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 /documentos/queries/exportColeta: 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 /documentos/queries/exportCotacaoFrete: 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 /documentos/queries/exportCotacaoFreteVolume: 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 /documentos/queries/exportColetaDestino: 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 /documentos/queries/exportEmbarcador: 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 /documentos/queries/exportEmbarcadorContato: 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 /documentos/queries/exportColetaNotaFiscal: 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 /documentos/queries/exportProcessamentoIntegracao: 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 /documentos/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 /documentos/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado 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 deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/confirmaUploadArquivo: post: description: Operação de confirmação do envio do arquivo para a URL gerada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idBlobServiceFile – versao properties: idBlobServiceFile: type: string description: Identificador do arquivo no blobservice versao: type: string description: Versão do arquivo criado responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/confirmaUploadConhecimentoArquivo: post: description: Operação de confirmação do envio de arquivos do Conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idBlobServiceFile – versao properties: idBlobServiceFile: type: string description: Identificador do arquivo no blobservice versao: type: string description: Versão do arquivo criado responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/confirmaUploadComprovanteEntregaArquivo: post: description: Operação de confirmação do envio do Comprovante de Entrega tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idBlobServiceFile – versao properties: idBlobServiceFile: type: string description: Identificador do arquivo no blobservice versao: type: string description: Versão do arquivo criado responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/confirmaUploadFaturaArquivo: post: description: Operação de confirmação do envio do arquivo da Fatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idBlobServiceFile – versao properties: idBlobServiceFile: type: string description: Identificador do arquivo no blobservice versao: type: string description: Versão do arquivo criado responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaUsuarioLogistica: post: description: Salvar usuário logística tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – usuarioLogistica properties: usuarioLogistica: type: object allOf: – #/definitions/recUsuarioLogistica description: Dados do usuário logística responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaConfiguracoesLogisticaPapel: post: description: Salvar as configurações de logística no papel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – papelLogistica properties: papelLogistica: type: object allOf: – #/definitions/recPapelLogistica description: Dados do papel logística responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaFaturaCompleto: post: description: Salvar as informações da fatura tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – faturaCompleto properties: faturaCompleto: type: object allOf: – #/definitions/recFaturaCompleto description: Fatura a ser persistida responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaConhecimentoCompleto: post: description: Salvar as informações do conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – conhecimentoCompleto properties: conhecimentoCompleto: type: object allOf: – #/definitions/recConhecimentoCompleto description: Conhecimento a ser persistido responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaListaOcorrenciaConhecimento: post: description: Salvar as informações da ocorrência do conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ocorrenciasConhecimento properties: ocorrenciasConhecimento: type: array items: type: object allOf: – #/definitions/recOcorrenciaConhecimentoCompleto minimum: 1 description: Ocorrência do Conhecimento a ser persistido responses: 200: description: Ok schema: type: object required: – retornoIntegracao properties: retornoIntegracao: type: array items: type: object allOf: – #/definitions/recRetornoIntegracao minimum: 1 description: Lista de erros, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/movimentaOcorrenciasConhecimentos: post: description: Movimenta as informações de ocorrência dos conhecimentos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movimentacoes properties: movimentacoes: type: array items: type: object allOf: – #/definitions/recOcorrenciaConhecimentoPorId minimum: 1 description: id conhecimento responses: 200: description: Ok schema: type: object required: – retornoIntegracao properties: retornoIntegracao: type: array items: type: object allOf: – #/definitions/recRetornoIntegracao minimum: 1 description: Lista de erros, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/verificaProcessamento: post: description: Verifica status do processamento de algum serviço solicitado anteriormente pelo usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: processo: type: string allOf: – #/definitions/enumServicosProcessamento description: Processo responses: 200: description: Ok schema: type: object required: – statusProcessamento – entradaProcessamento – retornoProcessamento properties: statusProcessamento: type: string allOf: – #/definitions/enumStatusProcessamento description: Status entradaProcessamento: type: string format: byte description: dados de entrada retornoProcessamento: type: string format: byte description: dados do retorno 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaListaNotaFiscalConhecimento: post: description: Salvar as informações da vinculação entre a nota fiscal e o conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notasFiscaisConhecimento properties: notasFiscaisConhecimento: type: array items: type: object allOf: – #/definitions/recNotaFiscalConhecimentoCompleto minimum: 1 description: Nota fiscal do conhecimento a ser persistida responses: 200: description: Ok schema: type: object required: – retornoIntegracao properties: retornoIntegracao: type: array items: type: object allOf: – #/definitions/recRetornoIntegracao minimum: 1 description: Lista de erros, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaListaFaturaConhecimento: post: description: Salvar as informações da vinculação entre a fatura e o conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – faturasConhecimento properties: faturasConhecimento: type: array items: type: object allOf: – #/definitions/recFaturaConhecimentoCompleto minimum: 1 description: Fatura do conhecimento a ser persistida responses: 200: description: Ok schema: type: object required: – retornoIntegracao properties: retornoIntegracao: type: array items: type: object allOf: – #/definitions/recRetornoIntegracao minimum: 1 description: Lista de erros, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaOcorrenciaConhecimentoCompleto: post: description: Salvar as informações da ocorrência do conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ocorrenciaConhecimentoCompleto properties: ocorrenciaConhecimentoCompleto: type: object allOf: – #/definitions/recOcorrenciaConhecimentoCompleto description: Ocorrência do Conhecimento a ser persistido responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaFaturaConhecimento: post: description: Salvar as informações da vinculação entre a fatura e o conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – faturaConhecimentoCompleto properties: faturaConhecimentoCompleto: type: object allOf: – #/definitions/recFaturaConhecimentoCompleto description: Fatura do conhecimento a ser persistida responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaNotaFiscalCompleto: post: description: Salvar as informações da nota fiscal tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notaFiscalCompleto properties: notaFiscalCompleto: type: object allOf: – #/definitions/recNotaFiscalCompleto description: Nota fiscal a ser persistida responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaNotaFiscalServicoCompleto: post: description: Salvar as informações da nota fiscal de serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notaFiscalServicoCompleto properties: notaFiscalServicoCompleto: type: object allOf: – #/definitions/recNotaFiscalServicoCompleto description: Nota fiscal de serviço a ser persistida responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaNotaFiscalConhecimento: post: description: Salvar as informações da vinculação entre a nota fiscal e o conhecimento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – notaFiscalConhecimentoCompleto properties: notaFiscalConhecimentoCompleto: type: object allOf: – #/definitions/recNotaFiscalConhecimentoCompleto description: Nota fiscal do conhecimento a ser persistida responses: 200: description: Ok schema: type: object required: – ok – msgErro properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/salvaComprovanteEntregaConhecimento: post: description: Salvar os comprovantes de entrega do conhecimento que não possuam vinculo com ocorrências tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – referenciaComprovantes properties: referenciaComprovantes: type: array items: type: object allOf: – #/definitions/recSalvaComprovanteEntregaConhecimento minimum: 1 description: Comprovantes a serem registrados responses: 200: description: Ok schema: type: object required: – comprovantesRegistrados – retornoIntegracao properties: comprovantesRegistrados: type: array items: type: object allOf: – #/definitions/recComprovanteEntregaConhecimentoSalvo minimum: 1 description: Informações dos comprovates registrados retornoIntegracao: type: array items: type: object allOf: – #/definitions/recRetornoIntegracao minimum: 1 description: Lista de erros, caso ocorra algum 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/movimentaOcorrenciaLoteNotificacao: post: description: Movimenta as informações de ocorrência dos conhecimentos e via notificação da Senior X informa quando é concluído tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – movimentacoes properties: movimentacoes: type: array items: type: object allOf: – #/definitions/recOcorrenciaConhecimentoPorId minimum: 1 description: Movimentações responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/geraColeta: post: description: Envia a coleta para o TMS e retorna o código da coleta tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpjCliente – numeroCepColeta – endereco – dataAgendamento – tipoFrete – quantidadePeso – quantidadeVolumes properties: cnpjCliente: type: string description: Embarcador CNPJ numeroCepColeta: type: string description: CEP de Coleta endereco: type: string description: Endereço de coleta bairro: type: string description: Bairro de coleta pontoReferencia: type: string description: Ponto de referência dataAgendamento: type: string format: date-time description: Data de agendamento para retirada da coleta horaLimite: type: string format: date-time description: Hora limite para retirada da coleta nomeContato: type: string description: Contato codigoNaturezaOperacao: type: integer format: int64 description: Código natureza codigoEspecieCarga: type: integer format: int64 description: Código especie carga tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo transporte ID quantidadePeso: type: number format: double description: Peso da carga quantidadeVolumes: type: number format: double description: Volume coletaDestino: type: array items: type: object allOf: – #/definitions/recColetaDestinoUnico description: Lista de destinos da coleta coletaNotaFiscal: type: array items: type: object allOf: – #/definitions/recColetaNotaFiscal description: Lista de notas fiscais da coleta observacao: type: string description: Obeservação responses: 200: description: Ok schema: type: object required: – codigo properties: codigo: type: integer format: int64 description: Cotação de frete persistida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/simulaCotacaoFrete: post: description: Realiza a simulação da cotação de frete tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – cnpjRemetente – numeroCepColeta – numeroCepEntrega – tipoFrete properties: identificador: type: integer format: int64 description: Identificador da simulação de frete codigoFilialEmitente: type: integer format: int64 description: Código filial emitente cnpjRemetente: type: string description: CNPJ remetente cnpjDestinatario: type: string description: CNPJ destinatário cnpjConsignatario: type: string description: CNPJ consignatário numeroCepColeta: type: string description: Coleta numeroCepEntrega: type: string description: Entrega codigoNaturezaCarga: type: integer format: int64 description: Código natureza da carga codigoNaturezaOperacao: type: integer format: int64 description: Código natureza de operação codigoTipoTransporte: type: integer format: int64 description: Código tipo transporte codigoTipoVeiculo: type: integer format: int64 description: Código tipo veículo icmsIncluso: type: string allOf: – #/definitions/enumICMSIncluso description: ICMS Incluso tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de Frete quantidadePeso: type: string description: Peso minimum: 0 quantidadePesoCubado: type: string description: Peso cubado minimum: 0 quantidadeVolumes: type: string description: Quantidade total de volume(s), caso não informado assume o total informado no objeto cotacaoFreteVolumes, senão assume o valor 1 minimum: 0 quantidadePares: type: integer format: int64 description: Pares quantidadeMetrosCubicos: type: string description: Metros cúbico minimum: 0 valorMercadoria: type: string description: Valor da mercadoria minimum: 0 cotacaoFreteVolumes: type: array items: type: object allOf: – #/definitions/recCotacaoFreteVolume description: Lista de volumes da cotação de frete responses: 200: description: Ok schema: type: object required: – cotacaoFrete properties: cotacaoFrete: type: object allOf: – #/definitions/recCotacaoFrete description: Cotação de frete persistida 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/aprovaCotacaoFrete: post: description: Aprovação da cotação de frete tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idCotacaoFrete properties: idCotacaoFrete: type: string description: ID da cotação de frete email: type: string description: Email para envio da cotação de frete responses: 200: description: Ok schema: type: object required: – situacao properties: codigoCotacao: type: integer format: int64 description: Código cotação codigoColeta: type: integer format: int64 description: Código coleta erroProcesso: type: string description: Erro do processo situacao: type: string allOf: – #/definitions/enumSituacaoCotacaoFrete description: Situação dataValidade: type: string format: date-time description: Data de Validade da cotação de frete 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/actions/externalBuscaFatura: post: description: Obtém lista de faturas de forma anônima tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoFatura: type: string description: Código da fatura pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – listaFatura – ok – totalRegistros properties: listaFatura: type: array items: type: object allOf: – #/definitions/recFatura minimum: 1 description: Lista de faturas filtradas msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false totalRegistros: type: integer format: int64 description: Total de registros encontrados default: description: Error response schema: #/definitions/genericError /documentos/actions/externalBuscaFaturaConhecimento: post: description: Obtém lista de conhecimentos da fatura de forma anônima tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idFatura: type: string description: Identificação da fatura pageRequest: type: object allOf: – #/definitions/recPageRequest description: Informações para realizar o request dos dados responses: 200: description: Ok schema: type: object required: – listaFaturaConhecimento – ok – totalRegistros properties: listaFaturaConhecimento: type: array items: type: object allOf: – #/definitions/recFaturaConhecimento minimum: 1 description: Lista de conhecimentos filtrados msgErro: type: string description: Caso ocorra erro, é inserido a descrição completa do erro ok: type: boolean description: Caso ocorra erro retorna false totalRegistros: type: integer format: int64 description: Total de registros encontrados default: description: Error response schema: #/definitions/genericError /documentos/actions/externalBuscaUrlDownloadArquivo: post: description: Obtém Url para baixar os arquivos de forma anônima tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentos properties: documentos: type: array items: type: object allOf: – #/definitions/recDocumentoDownload minimum: 1 description: Informações dos documentos para download agruparPDF: type: boolean description: Agrupar arquivos do tipo PDF default: false responses: 200: description: Ok schema: type: object required: – retorno properties: retorno: type: array items: type: object allOf: – #/definitions/recRetArquivoBlobService minimum: 1 description: Retorno das informações para download do arquivo default: description: Error response schema: #/definitions/genericError /documentos/actions/externalBuscaPrazoEntrega: post: description: Obtém prazo de entrega de forma anônima tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: ufOrigem: type: string description: UF origem cidadeOrigem: type: string description: Cidade origem ufDestino: type: string description: UF destino cidadeDestino: type: string description: Cidade destino cepOrigem: type: string description: CEP origem cepDestino: type: string description: CEP destino responses: 200: description: Ok schema: type: object required: – ok – msgErro – percursos properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum percursos: type: array items: type: object allOf: – #/definitions/recPercurso minimum: 1 description: Lista dos percursos de entrega default: description: Error response schema: #/definitions/genericError /documentos/actions/externalBuscaUF: post: description: Obtém lista de UF de forma anônima tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – ok – msgErro – ufs properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum ufs: type: array items: type: string minimum: 1 description: Lista das UFs default: description: Error response schema: #/definitions/genericError /documentos/actions/externalBuscaCidade: post: description: Obtém lista de cidades de forma anônima tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – uf properties: uf: type: string description: UF responses: 200: description: Ok schema: type: object required: – ok – msgErro – cidades properties: ok: type: boolean description: True para retorno sem erros msgErro: type: string description: Mensagem de erro, caso ocorra algum cidades: type: array items: type: string minimum: 1 description: Lista das cidades default: description: Error response schema: #/definitions/genericError /documentos/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 /documentos/actions/importProcessamento: 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 /documentos/actions/importTipoDocumento: 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 /documentos/actions/importTipoCliente: 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 /documentos/actions/importTipoDocumentoFiscal: 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 /documentos/actions/importArquivo: 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 /documentos/actions/importOcorrencia: 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 /documentos/actions/importPlanoConta: 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 /documentos/actions/importCentroCusto: 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 /documentos/actions/importCondicaoVencimento: 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 /documentos/actions/importRegiao: 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 /documentos/actions/importCep: 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 /documentos/actions/importPercurso: 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 /documentos/actions/importPercursoComercial: 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 /documentos/actions/importConfiguracoesGerais: 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 /documentos/actions/importTipoTransporte: 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 /documentos/actions/importTipoVeiculo: 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 /documentos/actions/importEspecieCarga: 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 /documentos/actions/importNaturezaCarga: 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 /documentos/actions/importNaturezaOperacao: 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 /documentos/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 /documentos/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 /documentos/actions/importCliente: 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 /documentos/actions/importClientePercurso: 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 /documentos/actions/importFatura: 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 /documentos/actions/importPortadorFatura: 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 /documentos/actions/importFaturaArquivo: 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 /documentos/actions/importConhecimento: 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 /documentos/actions/importConhecimentoArquivo: 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 /documentos/actions/importFaturaConhecimento: 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 /documentos/actions/importOcorrenciaConhecimento: 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 /documentos/actions/importOcorrenciaConhecimentoArquivo: 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 /documentos/actions/importNotaFiscal: 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 /documentos/actions/importNotaFiscalArquivo: 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 /documentos/actions/importNotaFiscalConhecimento: 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 /documentos/actions/importNotaFiscalServico: 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 /documentos/actions/importNotaFiscalServicoArquivo: 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 /documentos/actions/importRelSituacaoTransporte: 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 /documentos/actions/importClienteInfoTecnica: 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 /documentos/actions/importColeta: 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 /documentos/actions/importCotacaoFrete: 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 /documentos/actions/importCotacaoFreteVolume: 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 /documentos/actions/importColetaDestino: 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 /documentos/actions/importEmbarcador: 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 /documentos/actions/importEmbarcadorContato: 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 /documentos/actions/importColetaNotaFiscal: 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 /documentos/actions/importProcessamentoIntegracao: 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 /documentos/signals/buscaURLPDFAgrupadoNotificacao: post: description: Obtém Url para baixar o PDF agrupado do download de conhecimentos via notificação da Senior X tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – documentos properties: documentos: type: array items: type: object allOf: – #/definitions/recDocumentoDownload minimum: 1 description: Informações dos documentos para download responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaCep: post: description: Salvar as informações do CEP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – ceps properties: ceps: type: array items: type: object allOf: – #/definitions/recCep minimum: 1 description: Lista de cep a serem persistidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaPercurso: post: description: Salvar as informações do percurso tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – percursos properties: percursos: type: array items: type: object allOf: – #/definitions/recPercurso minimum: 1 description: Lista de percurso a serem persistidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaPercursoComercial: post: description: Salvar as informações do percurso comercial tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – percursosComercial properties: percursosComercial: type: array items: type: object allOf: – #/definitions/recPercursoComercial minimum: 1 description: Lista de percurso comercial a serem persistidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaConhecimento: post: description: Salvar as informações do conhecimento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – conhecimentos properties: conhecimentos: type: array items: type: object allOf: – #/definitions/recConhecimento minimum: 1 description: Lista de conhecimentos a serem persistidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaConhecimentoArquivo: post: description: Salvar arquivos do conhecimento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – conhecimentoArquivos properties: conhecimentoArquivos: type: array items: type: object allOf: – #/definitions/recConhecimentoCompleto minimum: 1 description: Lista de arquivos dos conhecimentos a serem persistidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaFatura: post: description: Salvar as informações do fatura tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – faturas properties: faturas: type: array items: type: object allOf: – #/definitions/recFatura minimum: 1 description: Lista de faturas a serem persistidas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaFaturaArquivo: post: description: Salvar arquivos da fatura tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – faturaArquivos properties: faturaArquivos: type: array items: type: object allOf: – #/definitions/recFaturaCompleto minimum: 1 description: Lista de arquivos das faturas a serem persistidos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/salvaListaNotaFiscal: post: description: Salvar as informações da nota fiscal tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – notasFiscais properties: notasFiscais: type: array items: type: object allOf: – #/definitions/recNotaFiscal minimum: 1 description: Lista de notas fiscais a serem persistidas responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/loggingRbtRegistros: post: description: Logging do robô on-premise de integração de registros tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – messages properties: messages: type: array items: type: object allOf: – #/definitions/recRbtMessage minimum: 1 description: Lista de mensagens responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/loggingRbtArquivos: post: description: Logging do robô on-premise de integração de arquivos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – messages properties: messages: type: array items: type: object allOf: – #/definitions/recRbtMessage minimum: 1 description: Lista de mensagens responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/signals/atualizaPapeisFiltrosFilias: post: description: Atualiza os filtros de filial de cnpj para código de todos os papéis do tenant tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /documentos/events/importProcessamentoEvent: 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 /documentos/events/exportProcessamentoEvent: 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 /documentos/events/importTipoDocumentoEvent: 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 /documentos/events/exportTipoDocumentoEvent: 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 /documentos/events/importTipoClienteEvent: 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 /documentos/events/exportTipoClienteEvent: 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 /documentos/events/importTipoDocumentoFiscalEvent: 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 /documentos/events/exportTipoDocumentoFiscalEvent: 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 /documentos/events/importArquivoEvent: 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 /documentos/events/exportArquivoEvent: 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 /documentos/events/importOcorrenciaEvent: 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 /documentos/events/exportOcorrenciaEvent: 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 /documentos/events/importPlanoContaEvent: 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 /documentos/events/exportPlanoContaEvent: 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 /documentos/events/importCentroCustoEvent: 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 /documentos/events/exportCentroCustoEvent: 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 /documentos/events/importCondicaoVencimentoEvent: 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 /documentos/events/exportCondicaoVencimentoEvent: 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 /documentos/events/importRegiaoEvent: 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 /documentos/events/exportRegiaoEvent: 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 /documentos/events/importCepEvent: 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 /documentos/events/exportCepEvent: 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 /documentos/events/importPercursoEvent: 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 /documentos/events/exportPercursoEvent: 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 /documentos/events/importPercursoComercialEvent: 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 /documentos/events/exportPercursoComercialEvent: 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 /documentos/events/importConfiguracoesGeraisEvent: 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 /documentos/events/exportConfiguracoesGeraisEvent: 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 /documentos/events/importTipoTransporteEvent: 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 /documentos/events/exportTipoTransporteEvent: 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 /documentos/events/importTipoVeiculoEvent: 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 /documentos/events/exportTipoVeiculoEvent: 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 /documentos/events/importEspecieCargaEvent: 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 /documentos/events/exportEspecieCargaEvent: 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 /documentos/events/importNaturezaCargaEvent: 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 /documentos/events/exportNaturezaCargaEvent: 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 /documentos/events/importNaturezaOperacaoEvent: 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 /documentos/events/exportNaturezaOperacaoEvent: 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 /documentos/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 /documentos/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 /documentos/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 /documentos/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 /documentos/events/importClienteEvent: 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 /documentos/events/exportClienteEvent: 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 /documentos/events/importClientePercursoEvent: 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 /documentos/events/exportClientePercursoEvent: 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 /documentos/events/importFaturaEvent: 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 /documentos/events/exportFaturaEvent: 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 /documentos/events/importPortadorFaturaEvent: 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 /documentos/events/exportPortadorFaturaEvent: 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 /documentos/events/importFaturaArquivoEvent: 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 /documentos/events/exportFaturaArquivoEvent: 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 /documentos/events/importConhecimentoEvent: 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 /documentos/events/exportConhecimentoEvent: 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 /documentos/events/importConhecimentoArquivoEvent: 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 /documentos/events/exportConhecimentoArquivoEvent: 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 /documentos/events/importFaturaConhecimentoEvent: 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 /documentos/events/exportFaturaConhecimentoEvent: 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 /documentos/events/importOcorrenciaConhecimentoEvent: 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 /documentos/events/exportOcorrenciaConhecimentoEvent: 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 /documentos/events/importOcorrenciaConhecimentoArquivoEvent: 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 /documentos/events/exportOcorrenciaConhecimentoArquivoEvent: 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 /documentos/events/importNotaFiscalEvent: 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 /documentos/events/exportNotaFiscalEvent: 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 /documentos/events/importNotaFiscalArquivoEvent: 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 /documentos/events/exportNotaFiscalArquivoEvent: 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 /documentos/events/importNotaFiscalConhecimentoEvent: 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 /documentos/events/exportNotaFiscalConhecimentoEvent: 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 /documentos/events/importNotaFiscalServicoEvent: 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 /documentos/events/exportNotaFiscalServicoEvent: 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 /documentos/events/importNotaFiscalServicoArquivoEvent: 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 /documentos/events/exportNotaFiscalServicoArquivoEvent: 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 /documentos/events/importRelSituacaoTransporteEvent: 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 /documentos/events/exportRelSituacaoTransporteEvent: 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 /documentos/events/importClienteInfoTecnicaEvent: 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 /documentos/events/exportClienteInfoTecnicaEvent: 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 /documentos/events/importColetaEvent: 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 /documentos/events/exportColetaEvent: 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 /documentos/events/importCotacaoFreteEvent: 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 /documentos/events/exportCotacaoFreteEvent: 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 /documentos/events/importCotacaoFreteVolumeEvent: 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 /documentos/events/exportCotacaoFreteVolumeEvent: 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 /documentos/events/importColetaDestinoEvent: 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 /documentos/events/exportColetaDestinoEvent: 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 /documentos/events/importEmbarcadorEvent: 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 /documentos/events/exportEmbarcadorEvent: 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 /documentos/events/importEmbarcadorContatoEvent: 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 /documentos/events/exportEmbarcadorContatoEvent: 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 /documentos/events/importColetaNotaFiscalEvent: 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 /documentos/events/exportColetaNotaFiscalEvent: 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 /documentos/events/importProcessamentoIntegracaoEvent: 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 /documentos/events/exportProcessamentoIntegracaoEvent: 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 /documentos/entities/processamento: 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/processamento responses: 200: description: The created resource schema: #/definitions/processamento 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/processamento responses: 200: description: The created resource schema: #/definitions/processamento 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 responses: 200: description: Ok schema: type: array items: #/definitions/processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/processamento/{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/processamento responses: 200: description: Ok schema: #/definitions/processamento 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/processamento responses: 200: description: Ok schema: #/definitions/processamento 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/processamento 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 /documentos/entities/processamento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/processamento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoDocumento: 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/tipoDocumento responses: 200: description: The created resource schema: #/definitions/tipoDocumento 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/tipoDocumento responses: 200: description: The created resource schema: #/definitions/tipoDocumento 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 responses: 200: description: Ok schema: type: array items: #/definitions/tipoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoDocumento/{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/tipoDocumento responses: 200: description: Ok schema: #/definitions/tipoDocumento 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/tipoDocumento responses: 200: description: Ok schema: #/definitions/tipoDocumento 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/tipoDocumento 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 /documentos/entities/tipoDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoCliente: 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/tipoCliente responses: 200: description: The created resource schema: #/definitions/tipoCliente 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/tipoCliente responses: 200: description: The created resource schema: #/definitions/tipoCliente 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 responses: 200: description: Ok schema: type: array items: #/definitions/tipoCliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoCliente/{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/tipoCliente responses: 200: description: Ok schema: #/definitions/tipoCliente 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/tipoCliente responses: 200: description: Ok schema: #/definitions/tipoCliente 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/tipoCliente 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 /documentos/entities/tipoCliente/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoCliente responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoDocumentoFiscal: 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/tipoDocumentoFiscal responses: 200: description: The created resource schema: #/definitions/tipoDocumentoFiscal 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/tipoDocumentoFiscal responses: 200: description: The created resource schema: #/definitions/tipoDocumentoFiscal 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 responses: 200: description: Ok schema: type: array items: #/definitions/tipoDocumentoFiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoDocumentoFiscal/{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/tipoDocumentoFiscal responses: 200: description: Ok schema: #/definitions/tipoDocumentoFiscal 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/tipoDocumentoFiscal responses: 200: description: Ok schema: #/definitions/tipoDocumentoFiscal 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/tipoDocumentoFiscal 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 /documentos/entities/tipoDocumentoFiscal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoDocumentoFiscal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/arquivo: 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/arquivo responses: 200: description: The created resource schema: #/definitions/arquivo 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/arquivo responses: 200: description: The created resource schema: #/definitions/arquivo 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 responses: 200: description: Ok schema: type: array items: #/definitions/arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/arquivo/{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/arquivo responses: 200: description: Ok schema: #/definitions/arquivo 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/arquivo responses: 200: description: Ok schema: #/definitions/arquivo 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/arquivo 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 /documentos/entities/arquivo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/arquivo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/ocorrencia: 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/ocorrencia responses: 200: description: The created resource schema: #/definitions/ocorrencia 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/ocorrencia responses: 200: description: The created resource schema: #/definitions/ocorrencia 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 responses: 200: description: Ok schema: type: array items: #/definitions/ocorrencia 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/ocorrencia/{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/ocorrencia responses: 200: description: Ok schema: #/definitions/ocorrencia 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/ocorrencia responses: 200: description: Ok schema: #/definitions/ocorrencia 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/ocorrencia 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 /documentos/entities/ocorrencia/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ocorrencia responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/planoConta: 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/planoConta responses: 200: description: The created resource schema: #/definitions/planoConta 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/planoConta responses: 200: description: The created resource schema: #/definitions/planoConta 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 responses: 200: description: Ok schema: type: array items: #/definitions/planoConta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/planoConta/{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/planoConta responses: 200: description: Ok schema: #/definitions/planoConta 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/planoConta responses: 200: description: Ok schema: #/definitions/planoConta 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/planoConta 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 /documentos/entities/planoConta/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/planoConta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/centroCusto: 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/centroCusto responses: 200: description: The created resource schema: #/definitions/centroCusto 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/centroCusto responses: 200: description: The created resource schema: #/definitions/centroCusto 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 responses: 200: description: Ok schema: type: array items: #/definitions/centroCusto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/centroCusto/{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/centroCusto responses: 200: description: Ok schema: #/definitions/centroCusto 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/centroCusto responses: 200: description: Ok schema: #/definitions/centroCusto 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/centroCusto 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 /documentos/entities/centroCusto/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/centroCusto responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/condicaoVencimento: 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/condicaoVencimento responses: 200: description: The created resource schema: #/definitions/condicaoVencimento 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/condicaoVencimento responses: 200: description: The created resource schema: #/definitions/condicaoVencimento 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 responses: 200: description: Ok schema: type: array items: #/definitions/condicaoVencimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/condicaoVencimento/{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/condicaoVencimento responses: 200: description: Ok schema: #/definitions/condicaoVencimento 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/condicaoVencimento responses: 200: description: Ok schema: #/definitions/condicaoVencimento 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/condicaoVencimento 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 /documentos/entities/condicaoVencimento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/condicaoVencimento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/regiao: 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/regiao responses: 200: description: The created resource schema: #/definitions/regiao 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/regiao responses: 200: description: The created resource schema: #/definitions/regiao 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 responses: 200: description: Ok schema: type: array items: #/definitions/regiao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/regiao/{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/regiao responses: 200: description: Ok schema: #/definitions/regiao 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/regiao responses: 200: description: Ok schema: #/definitions/regiao 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/regiao 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 /documentos/entities/regiao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/regiao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cep: 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/cep responses: 200: description: The created resource schema: #/definitions/cep 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/cep responses: 200: description: The created resource schema: #/definitions/cep 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 responses: 200: description: Ok schema: type: array items: #/definitions/cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cep/{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/cep responses: 200: description: Ok schema: #/definitions/cep 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/cep responses: 200: description: Ok schema: #/definitions/cep 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/cep 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 /documentos/entities/cep/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cep responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/percurso: 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/percurso responses: 200: description: The created resource schema: #/definitions/percurso 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/percurso responses: 200: description: The created resource schema: #/definitions/percurso 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 responses: 200: description: Ok schema: type: array items: #/definitions/percurso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/percurso/{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/percurso responses: 200: description: Ok schema: #/definitions/percurso 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/percurso responses: 200: description: Ok schema: #/definitions/percurso 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/percurso 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 /documentos/entities/percurso/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/percurso responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/percursoComercial: 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/percursoComercial responses: 200: description: The created resource schema: #/definitions/percursoComercial 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/percursoComercial responses: 200: description: The created resource schema: #/definitions/percursoComercial 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 responses: 200: description: Ok schema: type: array items: #/definitions/percursoComercial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/percursoComercial/{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/percursoComercial responses: 200: description: Ok schema: #/definitions/percursoComercial 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/percursoComercial responses: 200: description: Ok schema: #/definitions/percursoComercial 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/percursoComercial 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 /documentos/entities/percursoComercial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/percursoComercial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/configuracoesGerais: 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/configuracoesGerais responses: 200: description: The created resource schema: #/definitions/configuracoesGerais 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/configuracoesGerais responses: 200: description: The created resource schema: #/definitions/configuracoesGerais 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 responses: 200: description: Ok schema: type: array items: #/definitions/configuracoesGerais 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/configuracoesGerais/{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/configuracoesGerais responses: 200: description: Ok schema: #/definitions/configuracoesGerais 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/configuracoesGerais responses: 200: description: Ok schema: #/definitions/configuracoesGerais 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/configuracoesGerais 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 /documentos/entities/configuracoesGerais/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuracoesGerais responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoTransporte: 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/tipoTransporte responses: 200: description: The created resource schema: #/definitions/tipoTransporte 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/tipoTransporte responses: 200: description: The created resource schema: #/definitions/tipoTransporte 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 responses: 200: description: Ok schema: type: array items: #/definitions/tipoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoTransporte/{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/tipoTransporte responses: 200: description: Ok schema: #/definitions/tipoTransporte 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/tipoTransporte responses: 200: description: Ok schema: #/definitions/tipoTransporte 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/tipoTransporte 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 /documentos/entities/tipoTransporte/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoTransporte responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoVeiculo: 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/tipoVeiculo responses: 200: description: The created resource schema: #/definitions/tipoVeiculo 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/tipoVeiculo responses: 200: description: The created resource schema: #/definitions/tipoVeiculo 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 responses: 200: description: Ok schema: type: array items: #/definitions/tipoVeiculo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/tipoVeiculo/{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/tipoVeiculo responses: 200: description: Ok schema: #/definitions/tipoVeiculo 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/tipoVeiculo responses: 200: description: Ok schema: #/definitions/tipoVeiculo 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/tipoVeiculo 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 /documentos/entities/tipoVeiculo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tipoVeiculo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/especieCarga: 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/especieCarga responses: 200: description: The created resource schema: #/definitions/especieCarga 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/especieCarga responses: 200: description: The created resource schema: #/definitions/especieCarga 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 responses: 200: description: Ok schema: type: array items: #/definitions/especieCarga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/especieCarga/{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/especieCarga responses: 200: description: Ok schema: #/definitions/especieCarga 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/especieCarga responses: 200: description: Ok schema: #/definitions/especieCarga 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/especieCarga 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 /documentos/entities/especieCarga/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/especieCarga responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/naturezaCarga: 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/naturezaCarga responses: 200: description: The created resource schema: #/definitions/naturezaCarga 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/naturezaCarga responses: 200: description: The created resource schema: #/definitions/naturezaCarga 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 responses: 200: description: Ok schema: type: array items: #/definitions/naturezaCarga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/naturezaCarga/{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/naturezaCarga responses: 200: description: Ok schema: #/definitions/naturezaCarga 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/naturezaCarga responses: 200: description: Ok schema: #/definitions/naturezaCarga 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/naturezaCarga 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 /documentos/entities/naturezaCarga/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/naturezaCarga responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/naturezaOperacao: 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/naturezaOperacao responses: 200: description: The created resource schema: #/definitions/naturezaOperacao 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/naturezaOperacao responses: 200: description: The created resource schema: #/definitions/naturezaOperacao 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 responses: 200: description: Ok schema: type: array items: #/definitions/naturezaOperacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/naturezaOperacao/{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/naturezaOperacao responses: 200: description: Ok schema: #/definitions/naturezaOperacao 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/naturezaOperacao responses: 200: description: Ok schema: #/definitions/naturezaOperacao 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/naturezaOperacao 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 /documentos/entities/naturezaOperacao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/naturezaOperacao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/empresa: 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/empresa responses: 200: description: The created resource schema: #/definitions/empresa 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/empresa responses: 200: description: The created resource schema: #/definitions/empresa 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 responses: 200: description: Ok schema: type: array items: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/empresa/{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/empresa responses: 200: description: Ok schema: #/definitions/empresa 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/empresa responses: 200: description: Ok schema: #/definitions/empresa 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/empresa 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 /documentos/entities/empresa/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/empresa responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/filial: 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/filial responses: 200: description: The created resource schema: #/definitions/filial 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/filial responses: 200: description: The created resource schema: #/definitions/filial 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 responses: 200: description: Ok schema: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/filial/{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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial responses: 200: description: Ok schema: #/definitions/filial 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/filial 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 /documentos/entities/filial/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/filial responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cliente: 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/cliente responses: 200: description: The created resource schema: #/definitions/cliente 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/cliente responses: 200: description: The created resource schema: #/definitions/cliente 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 responses: 200: description: Ok schema: type: array items: #/definitions/cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cliente/{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/cliente responses: 200: description: Ok schema: #/definitions/cliente 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/cliente responses: 200: description: Ok schema: #/definitions/cliente 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/cliente 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 /documentos/entities/cliente/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cliente responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/clientePercurso: 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/clientePercurso responses: 200: description: The created resource schema: #/definitions/clientePercurso 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/clientePercurso responses: 200: description: The created resource schema: #/definitions/clientePercurso 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 responses: 200: description: Ok schema: type: array items: #/definitions/clientePercurso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/clientePercurso/{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/clientePercurso responses: 200: description: Ok schema: #/definitions/clientePercurso 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/clientePercurso responses: 200: description: Ok schema: #/definitions/clientePercurso 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/clientePercurso 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 /documentos/entities/clientePercurso/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clientePercurso responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/fatura: 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/fatura responses: 200: description: The created resource schema: #/definitions/fatura 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/fatura responses: 200: description: The created resource schema: #/definitions/fatura 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 responses: 200: description: Ok schema: type: array items: #/definitions/fatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/fatura/{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/fatura responses: 200: description: Ok schema: #/definitions/fatura 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/fatura responses: 200: description: Ok schema: #/definitions/fatura 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/fatura 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 /documentos/entities/fatura/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fatura responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/portadorFatura: 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/portadorFatura responses: 200: description: The created resource schema: #/definitions/portadorFatura 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/portadorFatura responses: 200: description: The created resource schema: #/definitions/portadorFatura 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 responses: 200: description: Ok schema: type: array items: #/definitions/portadorFatura 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/portadorFatura/{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/portadorFatura responses: 200: description: Ok schema: #/definitions/portadorFatura 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/portadorFatura responses: 200: description: Ok schema: #/definitions/portadorFatura 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/portadorFatura 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 /documentos/entities/portadorFatura/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/portadorFatura responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/faturaArquivo: 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/faturaArquivo responses: 200: description: The created resource schema: #/definitions/faturaArquivo 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/faturaArquivo responses: 200: description: The created resource schema: #/definitions/faturaArquivo 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 responses: 200: description: Ok schema: type: array items: #/definitions/faturaArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/faturaArquivo/{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/faturaArquivo responses: 200: description: Ok schema: #/definitions/faturaArquivo 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/faturaArquivo responses: 200: description: Ok schema: #/definitions/faturaArquivo 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/faturaArquivo 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 /documentos/entities/faturaArquivo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faturaArquivo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/conhecimento: 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/conhecimento responses: 200: description: The created resource schema: #/definitions/conhecimento 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/conhecimento responses: 200: description: The created resource schema: #/definitions/conhecimento 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 responses: 200: description: Ok schema: type: array items: #/definitions/conhecimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/conhecimento/{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/conhecimento responses: 200: description: Ok schema: #/definitions/conhecimento 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/conhecimento responses: 200: description: Ok schema: #/definitions/conhecimento 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/conhecimento 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 /documentos/entities/conhecimento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/conhecimento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/conhecimentoArquivo: 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/conhecimentoArquivo responses: 200: description: The created resource schema: #/definitions/conhecimentoArquivo 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/conhecimentoArquivo responses: 200: description: The created resource schema: #/definitions/conhecimentoArquivo 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 responses: 200: description: Ok schema: type: array items: #/definitions/conhecimentoArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/conhecimentoArquivo/{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/conhecimentoArquivo responses: 200: description: Ok schema: #/definitions/conhecimentoArquivo 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/conhecimentoArquivo responses: 200: description: Ok schema: #/definitions/conhecimentoArquivo 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/conhecimentoArquivo 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 /documentos/entities/conhecimentoArquivo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/conhecimentoArquivo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/faturaConhecimento: 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/faturaConhecimento responses: 200: description: The created resource schema: #/definitions/faturaConhecimento 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/faturaConhecimento responses: 200: description: The created resource schema: #/definitions/faturaConhecimento 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 responses: 200: description: Ok schema: type: array items: #/definitions/faturaConhecimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/faturaConhecimento/{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/faturaConhecimento responses: 200: description: Ok schema: #/definitions/faturaConhecimento 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/faturaConhecimento responses: 200: description: Ok schema: #/definitions/faturaConhecimento 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/faturaConhecimento 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 /documentos/entities/faturaConhecimento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/faturaConhecimento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/ocorrenciaConhecimento: 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/ocorrenciaConhecimento responses: 200: description: The created resource schema: #/definitions/ocorrenciaConhecimento 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/ocorrenciaConhecimento responses: 200: description: The created resource schema: #/definitions/ocorrenciaConhecimento 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 responses: 200: description: Ok schema: type: array items: #/definitions/ocorrenciaConhecimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/ocorrenciaConhecimento/{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/ocorrenciaConhecimento responses: 200: description: Ok schema: #/definitions/ocorrenciaConhecimento 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/ocorrenciaConhecimento responses: 200: description: Ok schema: #/definitions/ocorrenciaConhecimento 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/ocorrenciaConhecimento 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 /documentos/entities/ocorrenciaConhecimento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ocorrenciaConhecimento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/ocorrenciaConhecimentoArquivo: 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/ocorrenciaConhecimentoArquivo responses: 200: description: The created resource schema: #/definitions/ocorrenciaConhecimentoArquivo 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/ocorrenciaConhecimentoArquivo responses: 200: description: The created resource schema: #/definitions/ocorrenciaConhecimentoArquivo 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 responses: 200: description: Ok schema: type: array items: #/definitions/ocorrenciaConhecimentoArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/ocorrenciaConhecimentoArquivo/{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/ocorrenciaConhecimentoArquivo responses: 200: description: Ok schema: #/definitions/ocorrenciaConhecimentoArquivo 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/ocorrenciaConhecimentoArquivo responses: 200: description: Ok schema: #/definitions/ocorrenciaConhecimentoArquivo 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/ocorrenciaConhecimentoArquivo 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 /documentos/entities/ocorrenciaConhecimentoArquivo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ocorrenciaConhecimentoArquivo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscal: 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/notaFiscal responses: 200: description: The created resource schema: #/definitions/notaFiscal 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/notaFiscal responses: 200: description: The created resource schema: #/definitions/notaFiscal 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 responses: 200: description: Ok schema: type: array items: #/definitions/notaFiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscal/{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/notaFiscal responses: 200: description: Ok schema: #/definitions/notaFiscal 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/notaFiscal responses: 200: description: Ok schema: #/definitions/notaFiscal 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/notaFiscal 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 /documentos/entities/notaFiscal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notaFiscal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalArquivo: 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/notaFiscalArquivo responses: 200: description: The created resource schema: #/definitions/notaFiscalArquivo 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/notaFiscalArquivo responses: 200: description: The created resource schema: #/definitions/notaFiscalArquivo 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 responses: 200: description: Ok schema: type: array items: #/definitions/notaFiscalArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalArquivo/{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/notaFiscalArquivo responses: 200: description: Ok schema: #/definitions/notaFiscalArquivo 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/notaFiscalArquivo responses: 200: description: Ok schema: #/definitions/notaFiscalArquivo 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/notaFiscalArquivo 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 /documentos/entities/notaFiscalArquivo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notaFiscalArquivo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalConhecimento: 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/notaFiscalConhecimento responses: 200: description: The created resource schema: #/definitions/notaFiscalConhecimento 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/notaFiscalConhecimento responses: 200: description: The created resource schema: #/definitions/notaFiscalConhecimento 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 responses: 200: description: Ok schema: type: array items: #/definitions/notaFiscalConhecimento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalConhecimento/{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/notaFiscalConhecimento responses: 200: description: Ok schema: #/definitions/notaFiscalConhecimento 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/notaFiscalConhecimento responses: 200: description: Ok schema: #/definitions/notaFiscalConhecimento 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/notaFiscalConhecimento 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 /documentos/entities/notaFiscalConhecimento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notaFiscalConhecimento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalServico: 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/notaFiscalServico responses: 200: description: The created resource schema: #/definitions/notaFiscalServico 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/notaFiscalServico responses: 200: description: The created resource schema: #/definitions/notaFiscalServico 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 responses: 200: description: Ok schema: type: array items: #/definitions/notaFiscalServico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalServico/{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/notaFiscalServico responses: 200: description: Ok schema: #/definitions/notaFiscalServico 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/notaFiscalServico responses: 200: description: Ok schema: #/definitions/notaFiscalServico 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/notaFiscalServico 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 /documentos/entities/notaFiscalServico/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notaFiscalServico responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalServicoArquivo: 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/notaFiscalServicoArquivo responses: 200: description: The created resource schema: #/definitions/notaFiscalServicoArquivo 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/notaFiscalServicoArquivo responses: 200: description: The created resource schema: #/definitions/notaFiscalServicoArquivo 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 responses: 200: description: Ok schema: type: array items: #/definitions/notaFiscalServicoArquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/notaFiscalServicoArquivo/{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/notaFiscalServicoArquivo responses: 200: description: Ok schema: #/definitions/notaFiscalServicoArquivo 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/notaFiscalServicoArquivo responses: 200: description: Ok schema: #/definitions/notaFiscalServicoArquivo 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/notaFiscalServicoArquivo 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 /documentos/entities/notaFiscalServicoArquivo/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/notaFiscalServicoArquivo responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/relSituacaoTransporte: 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 responses: 200: description: Ok schema: type: array items: #/definitions/relSituacaoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/clienteInfoTecnica: 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/clienteInfoTecnica responses: 200: description: The created resource schema: #/definitions/clienteInfoTecnica 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/clienteInfoTecnica responses: 200: description: The created resource schema: #/definitions/clienteInfoTecnica 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 responses: 200: description: Ok schema: type: array items: #/definitions/clienteInfoTecnica 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/clienteInfoTecnica/{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/clienteInfoTecnica responses: 200: description: Ok schema: #/definitions/clienteInfoTecnica 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/clienteInfoTecnica responses: 200: description: Ok schema: #/definitions/clienteInfoTecnica 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/clienteInfoTecnica 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 /documentos/entities/clienteInfoTecnica/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clienteInfoTecnica responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/coleta: 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/coleta responses: 200: description: The created resource schema: #/definitions/coleta 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/coleta responses: 200: description: The created resource schema: #/definitions/coleta 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 responses: 200: description: Ok schema: type: array items: #/definitions/coleta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/coleta/{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/coleta responses: 200: description: Ok schema: #/definitions/coleta 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/coleta responses: 200: description: Ok schema: #/definitions/coleta 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/coleta 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 /documentos/entities/coleta/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/coleta responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cotacaoFrete: 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/cotacaoFrete responses: 200: description: The created resource schema: #/definitions/cotacaoFrete 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/cotacaoFrete responses: 200: description: The created resource schema: #/definitions/cotacaoFrete 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 responses: 200: description: Ok schema: type: array items: #/definitions/cotacaoFrete 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cotacaoFrete/{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/cotacaoFrete responses: 200: description: Ok schema: #/definitions/cotacaoFrete 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/cotacaoFrete responses: 200: description: Ok schema: #/definitions/cotacaoFrete 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/cotacaoFrete 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 /documentos/entities/cotacaoFrete/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cotacaoFrete responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cotacaoFreteVolume: 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/cotacaoFreteVolume responses: 200: description: The created resource schema: #/definitions/cotacaoFreteVolume 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/cotacaoFreteVolume responses: 200: description: The created resource schema: #/definitions/cotacaoFreteVolume 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 responses: 200: description: Ok schema: type: array items: #/definitions/cotacaoFreteVolume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/cotacaoFreteVolume/{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/cotacaoFreteVolume responses: 200: description: Ok schema: #/definitions/cotacaoFreteVolume 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/cotacaoFreteVolume responses: 200: description: Ok schema: #/definitions/cotacaoFreteVolume 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/cotacaoFreteVolume 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 /documentos/entities/cotacaoFreteVolume/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cotacaoFreteVolume responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/coletaDestino: 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/coletaDestino responses: 200: description: The created resource schema: #/definitions/coletaDestino 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/coletaDestino responses: 200: description: The created resource schema: #/definitions/coletaDestino 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 responses: 200: description: Ok schema: type: array items: #/definitions/coletaDestino 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/coletaDestino/{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/coletaDestino responses: 200: description: Ok schema: #/definitions/coletaDestino 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/coletaDestino responses: 200: description: Ok schema: #/definitions/coletaDestino 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/coletaDestino 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 /documentos/entities/coletaDestino/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/coletaDestino responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/embarcador: 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/embarcador responses: 200: description: The created resource schema: #/definitions/embarcador 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/embarcador responses: 200: description: The created resource schema: #/definitions/embarcador 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 responses: 200: description: Ok schema: type: array items: #/definitions/embarcador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/embarcador/{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/embarcador responses: 200: description: Ok schema: #/definitions/embarcador 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/embarcador responses: 200: description: Ok schema: #/definitions/embarcador 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/embarcador 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 /documentos/entities/embarcador/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/embarcador responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/embarcadorContato: 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/embarcadorContato responses: 200: description: The created resource schema: #/definitions/embarcadorContato 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/embarcadorContato responses: 200: description: The created resource schema: #/definitions/embarcadorContato 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 responses: 200: description: Ok schema: type: array items: #/definitions/embarcadorContato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/embarcadorContato/{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/embarcadorContato responses: 200: description: Ok schema: #/definitions/embarcadorContato 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/embarcadorContato responses: 200: description: Ok schema: #/definitions/embarcadorContato 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/embarcadorContato 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 /documentos/entities/embarcadorContato/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/embarcadorContato responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/coletaNotaFiscal: 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/coletaNotaFiscal responses: 200: description: The created resource schema: #/definitions/coletaNotaFiscal 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/coletaNotaFiscal responses: 200: description: The created resource schema: #/definitions/coletaNotaFiscal 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 responses: 200: description: Ok schema: type: array items: #/definitions/coletaNotaFiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/coletaNotaFiscal/{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/coletaNotaFiscal responses: 200: description: Ok schema: #/definitions/coletaNotaFiscal 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/coletaNotaFiscal responses: 200: description: Ok schema: #/definitions/coletaNotaFiscal 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/coletaNotaFiscal 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 /documentos/entities/coletaNotaFiscal/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/coletaNotaFiscal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documentos/entities/processamentoIntegracao: 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 responses: 200: description: Ok schema: type: array items: #/definitions/processamentoIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumLevel: description: Nível do Log type: string enum: – INFO – ERROR enumServicosProcessamento: description: Serviços em processamento type: string enum: – MOVIMENTA_OCORRENCIA – BUSCA_RELATORIO_DOCUMENTOS – DOWNLOAD_CSV_DOCUMENTOS enumStatusProcessamento: description: Serviços em processamento type: string enum: – EM_PROCESSAMENTO – ERRO – FINALIZADO enumIntegracaoProcesso: description: Processo de integração type: string enum: – NOTA_FISCAL_CONHECIMENTO – FATURA_CONHECIMENTO – OCORRENCIA_CONHECIMENTO enumUpDown: description: Up or down type: string enum: – UP – DOWN enumTipoInscricao: description: Tipo de Inscrição type: string enum: – CPF – CNPJ enumOrigem: description: Origem de onde o Cliente veio type: string enum: – INTEGRACAO – CADASTRADO enumTipoDownload: description: Tipo de download type: string enum: – CteXML – DACTE – CteComprovanteEntrega – FaturaPDF enumSituacaoMercadoria: description: Situação mercadoria type: string enum: – NAO_ENTREGUE – ENTREGUE – ENTREGUE_RESSALVAS – DEVOLVIDA enumTipoArquivo: description: Tipos de arquivos disponíveis, conforme extensões type: string enum: – XML – PDF – PNG – JPG – JPEG – TXT – DOC – DOCX – XLS – XLT – XLSX – CSV – ZIP – ComprovantePDF enumTipoFilial: description: Tipo de filial type: string enum: – MATRIZ – FILIAL enumTipoDocumentoFiscal: description: Tipo do documento fiscal type: string enum: – CONHECIMENTO – NOTA_FISCAL_SERVICO – NOTA_FISCAL_MODELO_1 – REGIME_ESPECIAL enumTipoFatura: description: Tipo de fatura type: string enum: – RECEBER – PREVISAO enumSitDocumento: description: Situação type: string enum: – ABERTO – CANCELADO enumSitFaturaConhecimento: description: Situação type: string enum: – VINCULADO – CANCELADO enumSitConhecimentoSefaz: description: Situação SEFAZ type: string enum: – PENDENTE – AUTORIZADO – CANCELADO enumSitNotaFiscalSefaz: description: Situação SEFAZ type: string enum: – PENDENTE – AUTORIZADO – CANCELADO enumTipoPlanoConta: description: Tipo do Plano de Conta type: string enum: – TITULO – ATIVO – PASSIVO – RECEITA – DESPESA enumExibirOcorrencia: description: Plataformas que exibem as ocorrências type: string enum: – TODOS – TMS enumExigenciasContato: description: Exigências de informações de contato na movimentação da ocorrência type: string enum: – SEM_EXIGENCIA – NOME_TELEFONE – NOME – NOME_RG enumPermiteNaoPermite: description: Configuração Permite/Não permite/Configuração Geral type: string enum: – NAO_PERMITE – PERMITE enumPermiteNaoPermiteGeral: description: Configuração Permite/Não permite/Configuração Geral type: string enum: – NAO_PERMITE – PERMITE – CONFIGURACAO_GERAL enumSomenteManifestadoTodos: description: Configuração Permite/Não permite/Configuração Geral type: string enum: – TODOS – SOMENTE_MANIFESTADO enumPermiteNaoPermitePapel: description: Configuração Permite/Não permite/Papel Usuário type: string enum: – NAO_PERMITE – PERMITE – PAPEL_USUARIO enumTipoEmissao: description: Tipo de emissão do conhecimento type: string enum: – EMISSAO_NORMAL – DEVOLUCAO_TOTAL – REENTREGA – DEVOLUCAO_PARCIAL – COMPLEMENTAR – COTACAO_FRETE – ARMAZENAGEM – PALETIZACAO – DIARIA – REDESPACHO_PROPRIO – AGENDAMENTO – REDESPACHO – SUBCONTRATO – REFATURAMENTO – SUBSTITUICAO – ANULACAO enumTipoFrete: description: Tipo do frete type: string enum: – A_PAGAR – PAGO enumTipoTransporte: description: Tipo do frete type: string enum: – COLETA – ENTREGA enumCalculoCubagem: description: Calculo cubagem type: string enum: – METRAGEM_CUBICA – PESO_REAL_NF – NAO_CALCULAR enumTipoICMS: description: Tipo de ICMS type: string enum: – ICMS_NORMAL – SUBST_TRIB – DIFERIDO – OUTROS – ISENTO – SUB_CONTRATACAO – NAO_TRIBUTADO enumFiltraEnvArquivo: description: Filtro para validar a existencia do arquivo a ser enviado type: string enum: – IdBlobService – Nome enumSituacaoVencimento: description: type: string enum: – A_VENCER – VENCIDO enumSituacaoCotacaoFrete: description: Situação da cotação de frete type: string enum: – PROCESSANDO_SIMULACAO – SIMULADO – PROCESSANDO_APROVACAO – APROVADO – ERRO_SIMULACAO – ERRO_APROVACAO enumTipoColeta: description: Tipo de coleta type: string enum: – COLETA_NORMAL – DEVOLUCAO – ESPECIAL – COMPRA – OFERTA enumOrigemInclusao: description: Origem da inclusão type: string enum: – ERP – EDI – PORTAL – MOBILE – COLETOR – RBT – ERP_AUTOMATICO enumFaseColeta: description: Fase da coleta type: string enum: – EM_ABERTO – EM_TRANSITO – BAIXADA enumSituacaoColeta: description: Situação da coleta type: string enum: – PROCESSANDO – APROVADO – ERRO enumICMSIncluso: description: Define como o ICMS impactará no valor type: string enum: – NAO_INCLUSO – INCLUSO – NEGOCIACAO_CLIENTE enumTipoPercursoComercial: description: Tipo do percurso comercial type: string enum: – MASCARA_REGIAO – ROTA enumTipoNaturezaOperacao: description: Tipo de natureza de operação type: string enum: – TIPO_NORMAL – ANULACAO – COMPRAS_DENTRO_ESTADO – TRANSFERENCIA_DENTRO_ESTADO – DEVOLUCAO_DENTRO_ESTADO – ENERGIA_DENTRO_ESTADO – COMUNICACAO_DENTRO_ESTADO – TRANSPORTE_DENTRO_ESTADO – ATIVO_DENTRO_ESTADO – USO_CONSUMO_DENTRO_ESTADO – OUTRAS_DENTRO_ESTADO – VENDAS_DENTRO_ESTADO – COMPRAS_FORA_ESTADO – TRANSFERENCIA_FORA_ESTADO – DEVOLUCAO_FORA_ESTADO – ENERGIA_FORA_ESTADO – COMUNICACAO_FORA_ESTADO – TRANSPORTE_FORA_ESTADO – ATIVO_FORA_ESTADO – USO_CONSUMO_FORA_ESTADO – OUTRAS_FORA_ESTADO – VENDAS_FORA_ESTADO – COMPRAS_EXTERIOR – DEVOLUCAO_EXTERIOR – COMUNICACAO_EXTERIOR – ATIVO_EXTERIOR – USO_CONSUMO_EXTERIOR – OUTRAS_EXTERIOR – VENDAS_EXTERIOR enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumTypeSN: description: Enumeração para o tipo resposta NÃO/SIM type: string enum: – NAO – SIM enumRotinaPortal: description: Enumeração para definir a rotina do portal type: string enum: – PORTAL_CLIENTE – PORTAL_PARCEIRO enumExigeNumeroPedido: description: Enumeração para a exigência do tipo de pedido e/ou número da nota – Nenhuma, Ambas, Apenas Pedido, Apenas Nota Fiscal type: string enum: – NENHUMA – AMBAS – APENAS_PEDIDO – APENAS_NOTA enumValidaRegiaoColeta: description: Validação de região de coleta/entrega type: string enum: – NAO_VALIDA – SOMENTE_COLETA – SOMENTE_ENTREGA – AMBOS userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recRbtMessage: description: Log de mensagem robô on-premise type: object required: – message – level properties: message: type: string description: Mensagem do log level: type: string allOf: – #/definitions/enumLevel description: Nível do log recCheckData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/enumUpDown description: Status do healthcheck recPageRequest: description: Define a paginação da query type: object required: – offset – size properties: offset: type: integer format: int64 description: Número da página minimum: 0 size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recRetornoIntegracao: description: Retorno da integração type: object required: – codigoExterno – mensagem properties: codigoExterno: type: integer format: int64 description: Código externo mensagem: type: string description: Mensagem sobre a integração do registro recPapelLogisticaFiltro: description: Configuração logística no papel do usuário type: object required: – consultarDocVincInscFiscalPrefixo properties: papelID: type: string description: ID Papel consultarDocVincInscFiscal: type: string description: Consultar documentos vinculados a Inscrição fiscal consultarDocVincFilial: type: integer format: int64 description: Consultar documentos vinculados a Filial consultarDocVincInscFiscalPrefixo: type: string allOf: – #/definitions/enumTypeSN description: Consultar documentos vinculados ao prefixo da Inscrição fiscal recPapelLogisticaPropriedade: description: Propriedade de logística no papel do usuário type: object required: – consultarTodasInscFiscal properties: papelID: type: string description: ID Papel consultarTodasInscFiscal: type: string allOf: – #/definitions/enumTypeSN description: Consultar todos os documentos consultarTodasFiliais: type: string allOf: – #/definitions/enumTypeSN description: Consultar todos os documentos do portal parceiro ocultarDataPrevisaoEntrega: type: string allOf: – #/definitions/enumTypeSN description: Ocutar data de previsão de entrega/encerramento movimentaOcorrenciaConhecimentoEntregue: type: string allOf: – #/definitions/enumTypeSN description: Aceitar movimentação de ocorrências em conhecimentos já entregues permiteTipoIcmsCotacaoFrete: type: string allOf: – #/definitions/enumTypeSN description: Permite informar o tipo de ICMS na cotação de frete validaRegiaoColeta: type: string allOf: – #/definitions/enumValidaRegiaoColeta description: Validação de região de coleta/entrega exigeContatoColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o contato da coleta exigeVolumeColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar a quantidade de volumes na coleta exigePesoColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o peso na coleta exigeDestinatarioColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar o destinatário na coleta exigeNotaFiscalColeta: type: string allOf: – #/definitions/enumTypeSN description: Exige informar a nota fiscal na coleta permiteConsultarColetasDestinatario: type: string allOf: – #/definitions/enumTypeSN description: Permite consultar coletas que for Destinatário da Ordem de Coleta permiteTodosPagadoresCotacaoFrete: type: string allOf: – #/definitions/enumTypeSN description: Permite todos os pagadores na cotação de frete permiteAprovarSemValidarPagadorCotacaoFrete: type: string allOf: – #/definitions/enumTypeSN description: permite aprovar cotação de frete sem realizar a validação do pagador recPapelLogistica: description: Papel do usuário logística type: object properties: papelID: type: string description: ID Papel listaPapelLogisticaFiltro: type: array items: type: object allOf: – #/definitions/recPapelLogisticaFiltro description: Lista de configurações logística papelLogisticaPropriedade: type: object allOf: – #/definitions/recPapelLogisticaPropriedade description: Propriedade logística recUsuarioLogistica: description: Usuário logística na plataforma type: object required: – usuario – nome – email – senha properties: usuario: type: string description: Usuário nome: type: string description: Nome email: type: string description: Email senha: type: string description: Senha bloqueado: type: boolean description: Bloqueado listaPapelLogistica: type: array items: type: object allOf: – #/definitions/recPapelLogistica description: Papel logística recDocumentoDownload: description: Informações do arquivo para download type: object required: – idDocumento – tipoDownload properties: idDocumento: type: string description: Identificador do documento tipoDownload: type: string allOf: – #/definitions/enumTipoDownload description: Tipo de download recEnvArquivoBlobService: description: Informações sobre o acesso ao arquivo type: object required: – chave – tipoArquivo properties: chave: type: string description: Chave do arquivo tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Extensão do arquivo filtraEnvArquivo: type: string allOf: – #/definitions/enumFiltraEnvArquivo description: Filtro a ser utilizado para validar a existencia do arquivo recRetArquivoBlobService: description: Informações de retorno do arquivo sobre o blobservice type: object required: – idBlobServiceFile – urlAcesso – nomeArquivo – versao – dataLimiteArquivoDisponivel – arquivoExiste – ok – msgErro properties: idBlobServiceFile: type: string description: id unico do arquivo no serviço urlAcesso: type: string description: URL para realizar o upload/download do arquivo nomeArquivo: type: string description: nome do arquivo versao: type: string description: versão do arquivo criado dataLimiteArquivoDisponivel: type: string format: date-time description: Data limite para acessar realizar o download arquivoExiste: type: boolean description: Indica se o arquivo já existe ok: type: boolean description: Sucesso na operação msgErro: type: string description: Mensagem de erro, caso ocorra recTipoDocumento: description: Tipo de documento type: object required: – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo recTipoCliente: description: Tipo de clientes vinculados ao documento type: object required: – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo recTipoDocumentoFiscal: description: Tipo documento fiscal type: object required: – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido numeroModelo: type: string description: Número Modelo tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: Tipo do Documento ativo: type: boolean description: Ativo default: true recArquivo: description: Arquivos salvos no blobservice type: object required: – idBlobServiceFile – tipoArquivo properties: dataDownload: type: string format: date-time description: Data e hora da primeira baixa do arquivo idBlobServiceFile: type: string description: Identificador Blobservice tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Tipo do arquivo nome: type: string description: Nome do arquivo ativo: type: boolean description: Ativo usuarioDownload: type: string description: Usuário de download do arquivo recOcorrencia: description: Ocorrência type: object required: – codigo properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo exibir: type: string allOf: – #/definitions/enumExibirOcorrencia description: Ativo exigenciasContato: type: string allOf: – #/definitions/enumExigenciasContato description: Exigências de informações de contato na movimentação da ocorrência permiteDataMovimentoPosteriorAtual: type: string allOf: – #/definitions/enumPermiteNaoPermiteGeral description: Permite data de movimento maior que atual exigeQuantidadePallets: type: boolean description: Exige informações da quantidade de pallets permiteOcorrenciaAnteriorExistente: type: boolean description: Permite lançamentos com data/hota anterior aos movimentos já existentes permiteAgendamentoAnteriorAtual: type: boolean description: Permite informar a data/hora de agendamento anterior a data/hora atual exigeAgendamento: type: boolean description: Exige data de agendamento permiteMovimentar: type: boolean description: Permite fazer a movimentação via portal situacaoMercadoria: type: string allOf: – #/definitions/enumSituacaoMercadoria description: Situação da mercadoria recRegiao: description: Região type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: Código numeroIdentificador: type: string description: Número Identificador descricao: type: string description: Descrição atendeDomingo: type: boolean description: Domingo atendeSegunda: type: boolean description: Segunda-feira atendeTerca: type: boolean description: Terça-feira atendeQuarta: type: boolean description: Quarta-feira atendeQuinta: type: boolean description: Quinta-feira atendeSexta: type: boolean description: Sexta-feira atendeSabado: type: boolean description: Sábado freteAPagar: type: boolean description: Aceitar Frete A Pagar atendeColeta: type: boolean description: Atende Coleta atendeEntrega: type: boolean description: Atende Entrega dificilAcesso: type: boolean description: Difícil Acesso ativo: type: boolean description: Ativo recCep: description: CEP type: object required: – codigo – logradouros properties: codigo: type: integer format: int64 description: Código numeroIdentificador: type: string description: Número Identificador tipo: type: string description: Tipo logradouros: type: string description: Endereço bairro: type: string description: Bairro cidade: type: string description: Cidade uf: type: string description: UF pais: type: string description: País codigoIbge: type: string description: Código IBGE regiao: type: object allOf: – #/definitions/recRegiao description: Região ativo: type: boolean description: Ativo default: true recPercurso: description: Percurso type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido regiaoOrigem: type: object allOf: – #/definitions/recRegiao description: Região Origem regiaoDestino: type: object allOf: – #/definitions/recRegiao description: Região Destino quilometragem: type: number format: double description: Quilometragem quantidadePedagio: type: integer format: int64 description: Quantidade de Pedágios numeroDiasEntrega: type: integer format: int64 description: Número de dias para entrega numeroHorasEntrega: type: number format: double description: Número de horas para entrega ativo: type: boolean description: Ativo recPercursoComercial: description: Percurso comercial type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido tipoPercurso: type: string allOf: – #/definitions/enumTipoPercursoComercial description: Tipo do Percurso ativo: type: boolean description: Ativo default: true recTipoTransporte: description: Tipo de transporte type: object required: – codigo – descricao properties: id: type: string description: Identificação codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição geraEdiOcoren: type: boolean description: Gerar Registro para EDI OCOREN default: false geraEdiDocCob: type: boolean description: Gerar Registro para EDI DOCCOB default: false geraEdiConemb: type: boolean description: Gerar Registro para EDI CONEMB default: false exigeInfColetaConh: type: boolean description: Exige informar coleta no CTRC default: false cargaDireta: type: boolean description: Carga Direta default: false exigeVincOper: type: boolean description: Vinculação de Operação default: false indicadorLotacao: type: integer format: int64 description: Indicador de lotação para CT-e cstPis: type: string description: CST do PIS/PASEP cstCofins: type: string description: CST da COFINS valorPctBasePis: type: number format: double description: Base de Cálculo PIS valorPctBaseCofins: type: number format: double description: Base de Cálculo COFINS valorAliqPis: type: number format: double description: Alíquota PIS valorAliqCofins: type: number format: double description: Alíquota COFINS tipoTransporteRms: type: integer format: int64 description: Vinculação RMS ativo: type: boolean description: Ativo default: true recTipoVeiculo: description: Tipo de veículo type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido rebocador: type: boolean description: Rebocador default: false reboque: type: boolean description: Rebocado default: false siglaAntt: type: string description: Sigla ANTT exigeReboque: type: boolean description: Exibe reboque default: false valorCustoPorKm: type: number format: double description: Custo por KM exigeRenavam: type: boolean description: Exibe RENAVAM default: false ativo: type: boolean description: Ativo default: true recEspecieCarga: description: Espécie da carga type: object required: – codigo – descricao properties: id: type: string description: Identificação codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição receitaFederal: type: boolean description: Código da receita federal default: false valorComprimento: type: number format: double description: Comprimento valorAltura: type: number format: double description: Altura valorLargura: type: number format: double description: Largura valorCubagem: type: number format: double description: Cubagem permPaletizacao: type: boolean description: Permite paletização default: false ativo: type: boolean description: Ativo default: true recNaturezaCarga: description: Natureza da carga type: object required: – codigo – descricao properties: id: type: string description: Identificação codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido numeroIdentificador: type: string description: Número Identificador codigoMercosul: type: integer format: int64 description: Código mercosul especieCarga: type: object allOf: – #/definitions/recEspecieCarga description: Espécie da carga ativo: type: boolean description: Ativo default: true recNaturezaOperacao: description: Natureza de operação type: object required: – codigo – descricao properties: id: type: string description: Identificação codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido numeroIdentificador: type: string description: Número Identificador cfop: type: string description: CFOP tipoNaturezaOperacao: type: string allOf: – #/definitions/enumTipoNaturezaOperacao description: Tipo da natureza de operação ativo: type: boolean description: Ativo default: true recEmpresa: description: Empresa type: object properties: nome: type: string description: Nome cnpj: type: string description: CNPJ recFilial: description: Filial type: object required: – cnpj properties: codigo: type: integer format: int64 description: Código nome: type: string description: Nome apelido: type: string description: Apelido cnpj: type: string description: CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoFilial: type: string allOf: – #/definitions/enumTipoFilial description: Tipo da filial ativo: type: boolean description: Ativo empresa: type: object allOf: – #/definitions/recEmpresa description: Empresa recCliente: description: Cliente type: object required: – inscricaoFiscal – nome properties: id: type: string description: Identificação tipoInscricao: type: string allOf: – #/definitions/enumTipoInscricao description: Tipo de inscrição inscricaoFiscal: type: string description: Inscrição fiscal inscricaoEstadual: type: string description: Inscricao Estadual inscricaoMunicipal: type: string description: Inscricao Municipal nome: type: string description: Nome do Cliente endereco: type: string description: Endereço numero: type: string description: Número bairro: type: string description: Bairro cep: type: string description: CEP telefone: type: string description: Telefone complemento: type: string description: Complemento ativo: type: boolean description: Ativo origem: type: string allOf: – #/definitions/enumOrigem description: Origem recPortadorFatura: description: Portador da fatura type: object required: – codigo – descricao properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição ativo: type: boolean description: Ativo default: true recFatura: description: Fatura type: object required: – numero – parcela – dataEmissao – valorTotal – situacao – filial – cliente properties: id: type: string description: Identificação numero: type: string description: Número da fatura parcela: type: string description: Número da parcela dataEmissao: type: string format: date-time description: Data de emissão dataLeitura: type: string format: date-time description: Data da visualização dataCancelamento: type: string format: date-time description: Data de cancelamento dataVencimento: type: string format: date-time description: Data do vencimento dataPagamento: type: string format: date-time description: Data do pagamento valorTotal: type: number format: double description: Valor total valorSaldo: type: number format: double description: Valor Saldo valorDesconto: type: number format: double description: Valor de desconto valorAcrescimo: type: number format: double description: Valor de acréscimo valorEstorno: type: number format: double description: Valor de estorno valorBaseCalculo: type: number format: double description: Valor base de cálculo valorLiquido: type: number format: double description: Valor líquido valorIcms: type: number format: double description: Valor ICMS valorDescontoIcms: type: number format: double description: Valor desconto ICMS codigoTitulo: type: string description: Código do título registroBanco: type: string description: Registro do banco moeda: type: string description: Moeda condicaoVencimento: type: string description: Condição de vencimento observacao: type: string description: Observação situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação tipoFatura: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura filial: type: object allOf: – #/definitions/recFilial description: Filial da fatura cliente: type: object allOf: – #/definitions/recCliente description: Cliente portadorFatura: type: object allOf: – #/definitions/recPortadorFatura description: Portador usuarioDownload: type: string description: Usuário de download dataDownload: type: string format: date-time description: Data de download recFaturaCompleto: description: Todos os dados da fatura e suas vinculações type: object required: – fatura properties: fatura: type: object allOf: – #/definitions/recFatura description: Fatura arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos da fatura recConhecimento: description: Conhecimento type: object required: – dataEmissao – situacaoSefaz – filial – remetente – destinatario properties: id: type: string description: Chave da tabela sequenciaControle: type: integer format: int64 description: Número Sequencia Controle numero: type: string description: Número serie: type: string description: Série dataEmissao: type: string format: date-time description: Data de emissão dataPagamento: type: string format: date-time description: Data do pagamento dataEntrega: type: string format: date-time description: Data da entrega dataCancelamento: type: string format: date-time description: Data do cancelamento dataLeitura: type: string format: date-time description: Data da visualização dataPrevisaoEntrega: type: string format: date-time description: Data de previsão de entrega chaveAcesso: type: string description: Chave de acesso numeroProtocolo: type: string description: Número protocolo versaoLayout: type: string description: Versão layout placaVeiculo: type: string description: Placa veículo placaReboque1: type: string description: Placa reboque 1 placaReboque2: type: string description: Placa reboque 2 placaReboque3: type: string description: Placa reboque 3 observacao: type: string description: Observação valorMercadoria: type: number format: double description: Valor mercadoria valorTotalPrestacao: type: number format: double description: Valor total da prestação valorAliquotaIcms: type: number format: double description: Valor Alíquota ICMS valorIcms: type: number format: double description: Valor ICMS valorAliquotaIss: type: number format: double description: Valor Alíquota ISS valorIss: type: number format: double description: Valor ISS valorFretePeso: type: number format: double description: Valor Frete Peso valorFrete: type: number format: double description: Valor Frete valorSeguro: type: number format: double description: Valor Seguro valorAdeme: type: number format: double description: Valor ADEME valorItr: type: number format: double description: Valor ITR valorSeccat: type: number format: double description: Valor SEC/CAT valorDespacho: type: number format: double description: Valor Despacho valorPedagio: type: number format: double description: Valor Pedágio valorSuframa: type: number format: double description: Valor SUFRAMA valorBalsa: type: number format: double description: Valor Balsa valorOutros: type: number format: double description: Valor Outros valorGris: type: number format: double description: Valor GRIS valorTde: type: number format: double description: Valor TDE valorCap: type: number format: double description: Valor CAP valorCad: type: number format: double description: Valor CAD valorTrt: type: number format: double description: Valor TRT valorTep: type: number format: double description: Valor TEP quantidadePeso: type: number format: double description: Peso quantidadePesoCubado: type: number format: double description: Peso cubado quantidadeVolume: type: number format: double description: Volume quantidadeMetrosCubicos: type: number format: double description: Metros cúbicos situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação situacaoSefaz: type: string allOf: – #/definitions/enumSitConhecimentoSefaz description: Situação SEFAZ tipoEmissao: type: string allOf: – #/definitions/enumTipoEmissao description: Tipo de emissão tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de Frete tipoIcms: type: string allOf: – #/definitions/enumTipoICMS description: Tipo de ICMS filial: type: object allOf: – #/definitions/recFilial description: Filial remetente: type: object allOf: – #/definitions/recCliente description: Remetente destinatario: type: object allOf: – #/definitions/recCliente description: Destinatário consignatario: type: object allOf: – #/definitions/recCliente description: Consignatário redespacho: type: object allOf: – #/definitions/recCliente description: Redespacho tipoDocumentoFiscal: type: object allOf: – #/definitions/recTipoDocumentoFiscal description: Tipo de documento fiscal cepColeta: type: object allOf: – #/definitions/recCep description: CEP Coleta cepEntrega: type: object allOf: – #/definitions/recCep description: CEP Entrega enderecoColeta: type: string description: Endereço de coleta enderecoEntrega: type: string description: Endereço de entrega manifestado: type: boolean description: Manifestado recConhecimentoCompleto: description: Todos os dados do conhecimento e suas vinculações type: object required: – conhecimento properties: conhecimento: type: object allOf: – #/definitions/recConhecimento description: Conhecimento arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos do conhecimento recConhecimentoArquivos: description: Identificador do conhecimento e o vinculo com os arquivos type: object required: – numero – serie properties: numero: type: string description: Número conhecimento serie: type: string description: Série conhecimento sequenciaControle: type: integer format: int64 description: Número Sequencia Controle filial: type: object allOf: – #/definitions/recFilial description: Filial arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos do conhecimento recFaturaConhecimento: description: Vinculação da fatura com o conhecimento type: object required: – fatura – conhecimento – situacao properties: fatura: type: object allOf: – #/definitions/recFatura description: Fatura conhecimento: type: object allOf: – #/definitions/recConhecimento description: Conhecimento situacao: type: string allOf: – #/definitions/enumSitFaturaConhecimento description: Situação recFaturaConhecimentoCompleto: description: Todos os dados da vinculação entre fatura e conhecimento type: object required: – faturaNumero – faturaParcela – conhecimentoNumero – conhecimentoSerie – situacao properties: faturaNumero: type: string description: Número da fatura faturaParcela: type: string description: Parcela da fatura faturaFilialCnpj: type: string description: CNPJ da filial da fatura faturaFilialCodigo: type: integer format: int64 description: Código da filial da fatura conhecimentoNumero: type: string description: Número do conhecimento conhecimentoSerie: type: string description: Série do conhecimento conhecimentoSequenciaControle: type: integer format: int64 description: Número Sequencia Controle conhecimentoFilialCodigo: type: integer format: int64 description: Código da filial do conhecimento situacao: type: string allOf: – #/definitions/enumSitFaturaConhecimento description: Situação codigoExterno: type: integer format: int64 description: Código do sistema externo para integração recOcorrenciaConhecimentoCompleto: description: Todos os dados da ocorrência do conhecimento e suas vinculações type: object required: – conhecimentoNumero – conhecimentoSerie – ocorrenciaCodigo – dataEmissao – dataMovimento properties: conhecimentoNumero: type: string description: Número do conhecimento conhecimentoSerie: type: string description: Série do conhecimento conhecimentoSequenciaControle: type: integer format: int64 description: Número Sequencia Controle conhecimentoFilialCodigo: type: integer format: int64 description: Código da filial do conhecimento ocorrenciaCodigo: type: integer format: int64 description: Código da ocorrência sequencia: type: integer format: int64 description: Ocorrência conhecimento Sequencia dataEmissao: type: string format: date-time description: Data de emissão dataMovimento: type: string format: date-time description: Data de movimento dataAgendamento: type: string format: date-time description: Data de previsão observacao: type: string description: Observação contatoNome: type: string description: Nome do Contato contatoRg: type: string description: RG do Contato contatoTelefone: type: string description: Telefone do Contato quantidadePallets: type: integer format: int64 description: Quantidade de pallets arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos da ocorrência do conhecimento codigoExterno: type: integer format: int64 description: Código do sistema externo para integração filialEntrega: type: object allOf: – #/definitions/recFilial description: filial que realizou o movimento de entrega do conhecimento recOcorrenciaConhecimentoPorId: description: Dados da ocorrência do conhecimento e suas vinculações por id type: object required: – ocorrenciaId – dataMovimento properties: conhecimentoId: type: string description: id do conhecimento ocorrenciaId: type: string description: Código da ocorrência sequencia: type: integer format: int64 description: Ocorrência conhecimento Sequencia dataMovimento: type: string format: date-time description: Data de movimento dataAgendamento: type: string format: date-time description: Data de previsão observacao: type: string description: Observação contatoNome: type: string description: Nome do Contato contatoRg: type: string description: RG do Contato contatoTelefone: type: string description: Telefone do Contato quantidadePallets: type: integer format: int64 description: Quantidade de pallets codigoExterno: type: integer format: int64 description: Código do sistema externo para integração inconsistencia: type: string description: Inconsistência conhecimentoDestinatarioNome: type: string description: Nom de destinatário do conhecimento conhecimentoEmpresaTipoDocumentoFiscalNumero: type: string description: Concatenação do número da emprea, numero cte e tipo do documento conhecimentoRemetenteNome: type: string description: Nome Remetente do conhecimento conhecimentoDataEmissao: type: string description: Data emissão conhecimento chaveAcesso: type: string description: Chave de acesso do conheicmento filialEntregaCodigo: type: integer format: int64 description: Código da filial de entrega recSalvaComprovanteEntregaConhecimento: description: Informações para salvar o comprovante de entrega dos conhecimentos type: object required: – conhecimentoNumero – conhecimentoSerie – arquivos properties: conhecimentoNumero: type: string description: Número do conhecimento conhecimentoSerie: type: string description: Série do conhecimento conhecimentoSequenciaControle: type: integer format: int64 description: Número Sequencia Controle conhecimentoFilialCodigo: type: integer format: int64 description: Código da filial do conhecimento codigoExterno: type: integer format: int64 description: Código do sistema externo para integração arquivos: type: array items: type: object allOf: – #/definitions/recArquivo minimum: 1 description: Arquivos Relacionados recComprovanteEntregaConhecimentoSalvo: description: Informações dos comprovantes de entrega registrados type: object required: – idConhecimento – conhecimentoNumero – conhecimentoSerie – idArquivos properties: idConhecimento: type: string description: ID do conhecimento conhecimentoNumero: type: string description: Número do conhecimento conhecimentoSerie: type: string description: Série do conhecimento idArquivos: type: array items: type: string minimum: 1 description: Referência dos arquivos registrados recFiltroBuscaComprovantesEntrega: description: Filtros utilizados para busca dos comprovantes de entrega dos conhecimentos type: object properties: numeroConhecimento: type: string description: Número do conhecimento serieConhecimento: type: string description: Série do conhecimento dtEmissaoIniConhecimento: type: string format: date-time description: Data de emissão inicial do conhecimento dtEmissaoFimConhecimento: type: string format: date-time description: Data de emissão final do Conhecimento dtOcorrenciaIni: type: string format: date-time description: Data inicial das ocorrências lançadas dtOcorrenciaFim: type: string format: date-time description: Data final das ocorrências lançadas notafiscalNumero: type: string description: Número da nota fiscal chaveAcessoConhecimento: type: string description: Chave de acesso do CT-e recComprovanteEntrega: description: Informações do comprovante de entrega do conhecimento type: object required: – conhecimento – arquivo properties: conhecimento: type: object allOf: – #/definitions/recConhecimento description: Dados do conhecimento arquivo: type: object allOf: – #/definitions/recArquivo description: Dados do arquivo recComprovanteEntregaDto: description: Informações do comprovante de entrega do conhecimento type: object required: – id – numeroCte – serieCte – dataEmissao – remetenteNome – destinatarioNome – tipoArquivo – descricaoArquivo – dataDownload properties: id: type: string description: ID do blob service numeroCte: type: string description: Número do conhecimento serieCte: type: string description: Série do conhecimento dataEmissao: type: string format: date-time description: Data de emissão do conhecimento remetenteNome: type: string description: Remetente do conhecimento destinatarioNome: type: string description: Destinatário do conhecimento tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Tipo do arquivo descricaoArquivo: type: string description: Descrição do arquivo dataDownload: type: string format: date-time description: Data de download recNotaFiscal: description: Nota fiscal type: object required: – dataEmissao – valorTotal – situacaoSefaz – filial – emitente – tomador properties: id: type: string description: Chave da tabela numero: type: string description: Número serie: type: string description: Série dataEmissao: type: string format: date-time description: Data de emissão dataPagamento: type: string format: date-time description: Data do pagamento dataEntrega: type: string format: date-time description: Data da entrega dataCancelamento: type: string format: date-time description: Data do cancelamento dataLeitura: type: string format: date-time description: Data da visualização valorTotal: type: number format: double description: Valor total valorBruto: type: number format: double description: Valor Bruto valorCofins: type: number format: double description: Valor COFINS valorIrrf: type: number format: double description: Valor IRRF valorIss: type: number format: double description: Valor ISS valorPis: type: number format: double description: Valor PIS valorIcms: type: number format: double description: Valor ICMS valorIpi: type: number format: double description: Valor IPI quantidadeVolume: type: number format: double description: Volume naturezaOperacao: type: string description: Natureza numeroTransporte: type: string description: Número de transporte chaveAcesso: type: string description: Chave de acesso situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação situacaoSefaz: type: string allOf: – #/definitions/enumSitNotaFiscalSefaz description: Situação SEFAZ filial: type: object allOf: – #/definitions/recFilial description: Filial emitente: type: object allOf: – #/definitions/recCliente description: Emitente tomador: type: object allOf: – #/definitions/recCliente description: Tomador recNotaFiscalCompleto: description: Todos os dados da nota fiscal e suas vinculações type: object required: – notaFiscal properties: notaFiscal: type: object allOf: – #/definitions/recNotaFiscal description: Nota fiscal arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos da nota fiscal recOcorrenciaNotaFiscalCompleto: description: Todos os dados da ocorrência da nota fiscal e suas vinculações type: object required: – notaFiscalNumero – notaFiscalSerie – ocorrenciaCodigo – dataEmissao – dataMovimento properties: notaFiscalNumero: type: string description: Número da nota fiscal notaFiscalSerie: type: string description: Série da nota fiscal ocorrenciaCodigo: type: integer format: int64 description: Código da ocorrência dataEmissao: type: string format: date-time description: Data de emissão dataMovimento: type: string format: date-time description: Data de movimento observacao: type: string description: Observação arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos da ocorrência da nota fiscal recNotaFiscalConhecimentoCompleto: description: Todos os dados da vinculação entre nota fiscal e conhecimento type: object required: – notaFiscalNumero – notaFiscalSerie – conhecimentoNumero – conhecimentoSerie properties: notaFiscalNumero: type: string description: Número da nota fiscal notaFiscalSerie: type: string description: Série da nota fiscal notaFiscalEmitente: type: object allOf: – #/definitions/recCliente description: Emitente da nota fiscal conhecimentoNumero: type: string description: Número do conhecimento conhecimentoSerie: type: string description: Série do conhecimento conhecimentoSequenciaControle: type: integer format: int64 description: Número Sequencia Controle conhecimentoFilialCodigo: type: integer format: int64 description: Código da filial do conhecimento codigoExterno: type: integer format: int64 description: Código do sistema externo para integração recNotaFiscalServico: description: Nota fiscal de serviço type: object required: – dataEmissao – emitente – tomador properties: id: type: string description: Chave da tabela numeroRPS: type: string description: Número RPS numero: type: string description: Número NFSe serie: type: string description: Série dataEmissao: type: string format: date-time description: Data de emissão dataPagamento: type: string format: date-time description: Data do pagamento dataEntrega: type: string format: date-time description: Data da entrega dataCancelamento: type: string format: date-time description: Data do cancelamento dataLeitura: type: string format: date-time description: Data da visualização dataAutorizacao: type: string format: date-time description: Data da autorização dataVinculacao: type: string format: date-time description: Data de vinculação situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação emitente: type: object allOf: – #/definitions/recFilial description: Emitente tomador: type: object allOf: – #/definitions/recCliente description: Tomador recNotaFiscalServicoCompleto: description: Todos os dados da nota fiscal e suas vinculações type: object required: – notaFiscalServico properties: notaFiscalServico: type: object allOf: – #/definitions/recNotaFiscalServico description: Nota fiscal de serviço arquivos: type: array items: type: object allOf: – #/definitions/recArquivo description: Arquivos da nota fiscal de serviço recRelatorioDocumentoIn: description: Parametros de entrada para buscar o relatório de documentos type: object properties: notafiscalNumero: type: string description: Número da nota fiscal notafiscalSerie: type: string description: Série da nota fiscal notafiscalEmitente: type: string description: Emitente da nota fiscal notafiscalTomador: type: string description: Tomador da nota fiscal notafiscalDataEmissaoIni: type: string format: date-time description: Data início da emissão da nota fiscal notafiscalDataEmissaoFim: type: string format: date-time description: Data fim da emissão da nota fiscal conhecimentoNumero: type: string description: Número do conhecimento conhecimentoRemetente: type: string description: Remetente do conhecimento conhecimentoDestinatario: type: string description: Destinatário do conhecimento conhecimentoDataEmissaoIni: type: string format: date-time description: Data início da emissão do conhecimento conhecimentoDataEmissaoFim: type: string format: date-time description: Data fim da emissão do conhecimento conhecimentoEntregue: type: boolean description: Apenas Conhecimentos entregues conhecimentoFaturado: type: boolean description: Apenas Conhecimentos com Fatura ocorrenciaconhecimentoCodigo: type: integer format: int64 description: Còdigo da ocorrência ocorrenciaconhecimentoDescricao: type: string description: Descrição da ocorrência apenasUltimaOcorrencia: type: boolean description: Apenas ultima ocorrência faturaNumero: type: string description: Número da fatura faturaDataEmissaoIni: type: string format: date-time description: Data início da emissão da fatura faturaDataEmissaoFim: type: string format: date-time description: Data fim da emissão da fatura recRelatorioDocumento: description: Relatório de documento type: object required: – notaFiscalNumero – notaFiscalSerie – notaFiscalDataEmissao – notaFiscalDataPagamento – notaFiscalDataEntrega – notaFiscalDataCancelamento – notaFiscalDataLeitura – notaFiscalValorTotal – notaFiscalValorBruto – notaFiscalValorCofins – notaFiscalValorIrrf – notaFiscalValorIss – notaFiscalValorPis – notaFiscalValorIcms – notaFiscalValorIpi – notaFiscalQuantidadePeso – notaFiscalQuantidadePesoCubado – notaFiscalQuantidadeVolume – notaFiscalQuantidadeMetrosCubicos – notaFiscalNaturezaOperacao – notaFiscalChaveAcesso – notaFiscalMarca – notaFiscalNumeroTransporte – notaFiscalIdentificacaoCarga – notaFiscalCodigoOperadorLogistico – notaFiscalSituacao – notaFiscalSituacaoSefaz – notaFiscalFilial – notaFiscalEmitente – notaFiscalTomador – conhecimentoNumero – conhecimentoSerie – conhecimentoDataEmissao – conhecimentoDataPagamento – conhecimentoDataEntrega – conhecimentoDataCancelamento – conhecimentoDataLeitura – conhecimentoDataPrevisaoEntrega – conhecimentoChaveAcesso – conhecimentoNumeroProtocolo – conhecimentoVersaoLayout – conhecimentoPlacaVeiculo – conhecimentoPlacaReboque1 – conhecimentoPlacaReboque2 – conhecimentoPlacaReboque3 – conhecimentoObservacao – conhecimentoValorMercadoria – conhecimentoValorTotalPrestacao – conhecimentoValorAliquotaIcms – conhecimentoValorIcms – conhecimentoValorAliquotaIss – conhecimentoValorIss – conhecimentoValorFretePeso – conhecimentoValorFrete – conhecimentoValorSeguro – conhecimentoValorAdeme – conhecimentoValorItr – conhecimentoValorSeccat – conhecimentoValorDespacho – conhecimentoValorPedagio – conhecimentoValorSuframa – conhecimentoValorBalsa – conhecimentoValorOutros – conhecimentoValorGris – conhecimentoValorTde – conhecimentoValorCap – conhecimentoValorCad – conhecimentoValorTrt – conhecimentoValorTep – conhecimentoQuantidadePeso – conhecimentoQuantidadePesoCubado – conhecimentoQuantidadeVolume – conhecimentoQuantidadeMetrosCubicos – conhecimentoSituacao – conhecimentoSituacaoSefaz – conhecimentoTipoEmissao – conhecimentoTipoFrete – conhecimentoTipoIcms – conhecimentoFilial – conhecimentoRemetente – conhecimentoDestinatario – faturaNumero – faturaParcela – faturaDataEmissao – faturaDataLeitura – faturaDataCancelamento – faturaValorTotal – faturaValorDesconto – faturaValorAcrescimo – faturaValorEstorno – faturaValorBaseCalculo – faturaValorLiquido – faturaValorIcms – faturaValorDescontoIcms – faturaMoeda – faturaCondicaoVencimento – faturaObservacao – faturaSituacao – faturaTipoFatura – faturaFilial – faturaCliente – ocorrenciaConhecimentoDataEmissao – ocorrenciaConhecimentoDataMovimento – ocorrenciaConhecimentoDataAgendamento – ocorrenciaConhecimentoObservacao – ocorrenciaConhecimentoContato – ocorrenciaConhecimentoOcorrencia – destinatarioCep – cepdestinatarioCidade – cepdestinatarioUf – remetenteCep – cepremetenteCidade – cepremetenteUf – conhecimentoCepColeta – conhecimentoCepEntrega – conhecimentoEnderecoColeta – conhecimentoEnderecoEntrega properties: notaFiscalNumero: type: string description: notaFiscalSerie: type: string description: notaFiscalDataEmissao: type: string description: notaFiscalDataPagamento: type: string description: notaFiscalDataEntrega: type: string description: notaFiscalDataCancelamento: type: string description: notaFiscalDataLeitura: type: string description: notaFiscalValorTotal: type: number format: double description: notaFiscalValorBruto: type: number format: double description: notaFiscalValorCofins: type: number format: double description: notaFiscalValorIrrf: type: number format: double description: notaFiscalValorIss: type: number format: double description: notaFiscalValorPis: type: number format: double description: notaFiscalValorIcms: type: number format: double description: notaFiscalValorIpi: type: number format: double description: notaFiscalQuantidadePeso: type: number format: double description: notaFiscalQuantidadePesoCubado: type: number format: double description: notaFiscalQuantidadeVolume: type: number format: double description: notaFiscalQuantidadeMetrosCubicos: type: number format: double description: notaFiscalNaturezaOperacao: type: string description: notaFiscalChaveAcesso: type: string description: notaFiscalMarca: type: string description: notaFiscalNumeroTransporte: type: string description: notaFiscalIdentificacaoCarga: type: integer format: int64 description: notaFiscalCodigoOperadorLogistico: type: string description: notaFiscalSituacao: type: string allOf: – #/definitions/enumSitDocumento description: notaFiscalSituacaoSefaz: type: string allOf: – #/definitions/enumSitNotaFiscalSefaz description: notaFiscalFilial: type: object allOf: – #/definitions/recFilial description: notaFiscalEmitente: type: object allOf: – #/definitions/recCliente description: notaFiscalTomador: type: object allOf: – #/definitions/recCliente description: conhecimentoNumero: type: string description: conhecimentoSerie: type: string description: conhecimentoDataEmissao: type: string description: conhecimentoDataPagamento: type: string description: conhecimentoDataEntrega: type: string description: conhecimentoDataCancelamento: type: string description: conhecimentoDataLeitura: type: string description: conhecimentoDataPrevisaoEntrega: type: string description: Data de previsão de entrega conhecimentoChaveAcesso: type: string description: conhecimentoNumeroProtocolo: type: string description: conhecimentoVersaoLayout: type: string description: conhecimentoPlacaVeiculo: type: string description: conhecimentoPlacaReboque1: type: string description: conhecimentoPlacaReboque2: type: string description: conhecimentoPlacaReboque3: type: string description: conhecimentoObservacao: type: string description: conhecimentoValorMercadoria: type: number format: double description: conhecimentoValorTotalPrestacao: type: number format: double description: conhecimentoValorAliquotaIcms: type: number format: double description: conhecimentoValorIcms: type: number format: double description: conhecimentoValorAliquotaIss: type: number format: double description: conhecimentoValorIss: type: number format: double description: conhecimentoValorFretePeso: type: number format: double description: conhecimentoValorFrete: type: number format: double description: conhecimentoValorSeguro: type: number format: double description: conhecimentoValorAdeme: type: number format: double description: conhecimentoValorItr: type: number format: double description: conhecimentoValorSeccat: type: number format: double description: conhecimentoValorDespacho: type: number format: double description: conhecimentoValorPedagio: type: number format: double description: conhecimentoValorSuframa: type: number format: double description: conhecimentoValorBalsa: type: number format: double description: conhecimentoValorOutros: type: number format: double description: conhecimentoValorGris: type: number format: double description: conhecimentoValorTde: type: number format: double description: conhecimentoValorCap: type: number format: double description: conhecimentoValorCad: type: number format: double description: conhecimentoValorTrt: type: number format: double description: conhecimentoValorTep: type: number format: double description: conhecimentoQuantidadePeso: type: number format: double description: conhecimentoQuantidadePesoCubado: type: number format: double description: conhecimentoQuantidadeVolume: type: number format: double description: conhecimentoQuantidadeMetrosCubicos: type: number format: double description: conhecimentoSituacao: type: string allOf: – #/definitions/enumSitDocumento description: conhecimentoSituacaoSefaz: type: string allOf: – #/definitions/enumSitConhecimentoSefaz description: conhecimentoTipoEmissao: type: string allOf: – #/definitions/enumTipoEmissao description: conhecimentoTipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: conhecimentoTipoIcms: type: string allOf: – #/definitions/enumTipoICMS description: conhecimentoFilial: type: object allOf: – #/definitions/recFilial description: conhecimentoRemetente: type: object allOf: – #/definitions/recCliente description: conhecimentoDestinatario: type: object allOf: – #/definitions/recCliente description: conhecimentoConsignatario: type: object allOf: – #/definitions/recCliente description: conhecimentoRedespacho: type: object allOf: – #/definitions/recCliente description: faturaNumero: type: string description: faturaParcela: type: string description: faturaDataEmissao: type: string description: faturaDataLeitura: type: string description: faturaDataCancelamento: type: string description: faturaValorTotal: type: number format: double description: faturaValorDesconto: type: number format: double description: faturaValorAcrescimo: type: number format: double description: faturaValorEstorno: type: number format: double description: faturaValorBaseCalculo: type: number format: double description: faturaValorLiquido: type: number format: double description: faturaValorIcms: type: number format: double description: faturaValorDescontoIcms: type: number format: double description: faturaMoeda: type: string description: faturaCondicaoVencimento: type: string description: faturaObservacao: type: string description: faturaSituacao: type: string allOf: – #/definitions/enumSitDocumento description: faturaTipoFatura: type: string allOf: – #/definitions/enumTipoFatura description: faturaFilial: type: object allOf: – #/definitions/recFilial description: faturaCliente: type: object allOf: – #/definitions/recCliente description: ocorrenciaConhecimentoDataEmissao: type: string description: ocorrenciaConhecimentoDataMovimento: type: string description: ocorrenciaConhecimentoDataAgendamento: type: string description: ocorrenciaConhecimentoObservacao: type: string description: ocorrenciaConhecimentoContato: type: string description: ocorrenciaConhecimentoOcorrencia: type: object allOf: – #/definitions/recOcorrencia description: destinatarioCep: type: object allOf: – #/definitions/recCep description: Relação CEP x destinatário cepdestinatarioCidade: type: string description: Cidade destinatário cepdestinatarioUf: type: string description: UF destinatário remetenteCep: type: object allOf: – #/definitions/recCep description: Relação CEP x remetente cepremetenteCidade: type: string description: Cidade remetente cepremetenteUf: type: string description: UF remetente conhecimentoCepColeta: type: object allOf: – #/definitions/recCep description: Relação conhecimento x CEP coleta conhecimentoCepEntrega: type: object allOf: – #/definitions/recCep description: Relação conhecimento x CEP entrega conhecimentoEnderecoColeta: type: string description: Endereço de coleta conhecimentoEnderecoEntrega: type: string description: Endereço de entrega recClienteInfoTecnica: description: Rec informações tecnicas do cliente type: object properties: id: type: string description: Id cliente: type: object allOf: – #/definitions/recCliente description: Cliente natureza: type: object allOf: – #/definitions/recNaturezaCarga description: Natureza especie: type: object allOf: – #/definitions/recEspecieCarga description: Espécie de carga tipoTransporte: type: object allOf: – #/definitions/recTipoTransporte description: Tipo de transporte nomeProduto: type: string description: Nome do produto valorMedioVolume: type: number format: double description: valor Medio de Volume pesoMedioVolume: type: number format: double description: Peso médio volume metrosCubicosVolume: type: number format: double description: Metros cubicos volume quantidadeMediaEntrega: type: integer format: int64 description: Quantidade media entrega distanciaMedia: type: integer format: int64 description: Distância média tipoMovimentoTransporte: type: string allOf: – #/definitions/enumTipoTransporte description: Tipo de movimento de transporte incluirObservacaoConhecimento: type: boolean description: Incluir observação de conhecimento sequencia: type: integer format: int64 description: Sequencia calculoCubagem: type: string allOf: – #/definitions/enumCalculoCubagem description: Cálculo de cubagem observacao: type: string description: Observacao recColeta: description: Dados da coleta type: object properties: id: type: string description: Id codigoColeta: type: integer format: int64 description: Código da coleta situacao: type: string allOf: – #/definitions/enumSituacaoColeta description: Situação dataEmissao: type: string format: date-time description: Data emissão naturezaOperacao: type: object allOf: – #/definitions/recNaturezaCarga description: Natureza especieCarga: type: object allOf: – #/definitions/recEspecieCarga description: Espécie quantidadeVolumes: type: number format: double description: Volumes quantidadePeso: type: number format: double description: Peso observacao: type: string description: Observação tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de Frete numeroCepColeta: type: string description: CEP coleta endereco: type: string description: Endereço completo bairro: type: string description: Bairro pontoReferencia: type: string description: Ponto de referencia nomeContato: type: string description: Contato erroProcesso: type: string description: Mensagem de erro dataAgendamento: type: string format: date-time description: Data agendamento horaLimite: type: string format: date-time description: Hora limite dataAprovacao: type: string format: date-time description: valor da nota fiscal cliente: type: object allOf: – #/definitions/recCliente description: cliente recCotacaoFrete: description: Dados da cotação de frete type: object properties: id: type: string description: Chave da tabela identificador: type: integer format: int64 description: Identificador codigoCotacao: type: integer format: int64 description: Código cotação codigoColeta: type: integer format: int64 description: Código coleta filialEmitente: type: object allOf: – #/definitions/recFilial description: Emitente dataEmissao: type: string format: date-time description: Data emissão dataValidade: type: string format: date-time description: Data validade dataAprovacao: type: string format: date-time description: Data aprovação quantidadeDiasEntrega: type: integer format: int64 description: Dias de Entrega remetente: type: object allOf: – #/definitions/recCliente description: Remetente destinatario: type: object allOf: – #/definitions/recCliente description: Destinatário consignatario: type: object allOf: – #/definitions/recCliente description: Consignatário numeroCepColeta: type: string description: CEP Coleta numeroCepEntrega: type: string description: CEP Entrega percursoComercial: type: object allOf: – #/definitions/recPercursoComercial description: Percurso comercial percursoOperacional: type: object allOf: – #/definitions/recPercurso description: Percurso operacional naturezaCarga: type: object allOf: – #/definitions/recNaturezaCarga description: Natureza de carga naturezaOperacao: type: object allOf: – #/definitions/recNaturezaOperacao description: Natureza de operação tipoTransporte: type: object allOf: – #/definitions/recTipoTransporte description: Tipo transporte tipoVeiculo: type: object allOf: – #/definitions/recTipoVeiculo description: Tipo veículo icmsIncluso: type: string allOf: – #/definitions/enumICMSIncluso description: ICMS Incluso tipoIcms: type: string allOf: – #/definitions/enumTipoICMS description: Tipo ICMS tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de Frete quantidadePeso: type: string description: Peso minimum: 0 quantidadePesoCubado: type: string description: Peso cubado minimum: 0 quantidadeVolumes: type: string description: Volume minimum: 0 quantidadePares: type: integer format: int64 description: Pares quantidadeMetrosCubicos: type: string description: Metros cúbico minimum: 0 valorMercadoria: type: string description: Valor da mercadoria minimum: 0 codigoTarifa: type: integer format: int64 description: Código da tarifa descricaoTarifa: type: string description: Descrição da tarifa codigoEmpresaTabela: type: integer format: int64 description: Código empresa tabela frete codigoTabelaPreco: type: integer format: int64 description: Código tabela frete codigoPerfilUsuario: type: integer format: int64 description: Código perfil usuário valorPeso: type: number format: double description: Valor total por peso valorPesoUnitario: type: number format: double description: Valor unitário por peso valorPesoCobrado: type: number format: double description: Valor total cobrado por peso valorCoefPeso: type: number format: double description: Valor coeficiente peso valorBaseCalculo: type: number format: double description: Base de cálculo valorPercIcms: type: number format: double description: % ICMS valorIcms: type: number format: double description: ICMS valorPercIss: type: number format: double description: % ISS valorIss: type: number format: double description: ISS valorFretePeso: type: number format: double description: Frete peso valorFreteValor: type: number format: double description: Frete valor valorSeccat: type: number format: double description: SEC / CAT valorDespacho: type: number format: double description: Despacho valorPedagio: type: number format: double description: Pedágio valorAdeme: type: number format: double description: ADEME valorGris: type: number format: double description: GRIS valorItr: type: number format: double description: ITR valorSuframa: type: number format: double description: SUFRAMA valorBalsa: type: number format: double description: Balsa valorSeguro: type: number format: double description: Seguro valorCap: type: number format: double description: CAP valorCad: type: number format: double description: CAD valorTep: type: number format: double description: TEP valorTfb: type: number format: double description: TFB valorTas: type: number format: double description: TAS valorTce: type: number format: double description: TCE valorTdc: type: number format: double description: TDC valorTda: type: number format: double description: TDA valorTde: type: number format: double description: TDE valorTrt: type: number format: double description: TRT valorDesc: type: number format: double description: Desconto valorOutros: type: number format: double description: Outros valorTag: type: number format: double description: TAG valorFrete: type: number format: double description: Valor total do frete valorLiquido: type: number format: double description: Valor líquido contatoEmail: type: string description: Email do contato situacao: type: string allOf: – #/definitions/enumSituacaoCotacaoFrete description: Situação erroProcesso: type: string description: Mensagem de erro recCotacaoFreteVolume: description: Volumes da cotação de frete type: object properties: id: type: string description: Id cotacaoFrete: type: object allOf: – #/definitions/recCotacaoFrete description: Cotação de frete quantidade: type: string description: Quantidade minimum: 0 altura: type: string description: Altura minimum: 0 largura: type: string description: Largura minimum: 0 comprimento: type: string description: Comprimento minimum: 0 quantidadeMetrosCubicos: type: string description: Metros cúbico minimum: 0 quantidadePesoCubado: type: string description: Peso cubado minimum: 0 recColetaDestinoUnico: description: Destino da coleta objeto unico type: object properties: id: type: string description: Id quantidadeVolumes: type: number format: double description: Volumes quantidadePeso: type: number format: double description: Peso nomeDestinatario: type: string description: Nome Destinatário inscricaoFiscalDestinatario: type: string description: Inscrição fiscal Destinatário numeroCepDestino: type: string description: CEP entrega cidadeEstado: type: string description: Cidade estado do CEP recColetaDestino: description: Destino da coleta type: object properties: id: type: string description: Id filial: type: object allOf: – #/definitions/recFilial description: Filial coleta: type: object allOf: – #/definitions/recColeta description: Coleta sequencia: type: integer format: int64 description: Sequencia quantidadeVolumes: type: number format: double description: Volumes quantidadePeso: type: number format: double description: Peso destinatario: type: object allOf: – #/definitions/recCliente description: Destinatário filialDestino: type: object allOf: – #/definitions/recFilial description: Filial Destino numeroCepDestino: type: string description: CEP entrega embarqueUrgente: type: boolean description: Embarque Urgente quantidadeMetrosCubicos: type: number format: double description: Quantidade metros cubicos valorNotaFiscal: type: number format: double description: Valor da nota fiscal observacao: type: string description: Observação recColetaNotaFiscal: description: Notas fiscais da coleta type: object properties: id: type: string description: Id coleta: type: object allOf: – #/definitions/recColeta description: Coleta numeroNotaFiscal: type: integer format: int64 description: Numero serie: type: string description: Série numeroPedido: type: string description: Número do pedido processamento: description: Processamento type: object required: – processo – status properties: id: type: string format: uuid description: Chave da tabela processo: type: string allOf: – #/definitions/enumServicosProcessamento description: Processo status: type: string allOf: – #/definitions/enumStatusProcessamento description: Status entrada: type: string description: Dados de entrada retorno: type: string description: Dados de retorno createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoDocumento: description: Tipo de documento type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: string description: Código descricao: type: string description: Descrição 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: tipoCliente: description: Tipo de cliente type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: string description: Código descricao: type: string description: Descrição 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: tipoDocumentoFiscal: description: Tipo documento fiscal type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido numeroModelo: type: string description: Número Modelo tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: Tipo do Documento 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: arquivo: description: Arquivos type: object required: – idBlobServiceFile – tipoArquivo properties: id: type: string format: uuid description: Chave da tabela dataDownload: type: string format: date-time description: Data e hora da primeira baixa do arquivo idBlobServiceFile: type: string description: Identificador Blobservice tipoArquivo: type: string allOf: – #/definitions/enumTipoArquivo description: Tipo do arquivo nome: type: string description: Nome do arquivo usuarioDownload: type: string description: Usuário de download do arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ocorrencia: description: Ocorrência de entrega type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição exibir: type: string allOf: – #/definitions/enumExibirOcorrencia description: Que plataformas exibem a ocorrência ativo: type: boolean description: Ativo default: true exigenciasContato: type: string allOf: – #/definitions/enumExigenciasContato description: Exigências de informações de contato na movimentação da ocorrência permiteDataMovimentoPosteriorAtual: type: string allOf: – #/definitions/enumPermiteNaoPermiteGeral description: Permite data de movimento maior que atual exigeQuantidadePallets: type: boolean description: Exige informações da quantidade de pallets default: false permiteOcorrenciaAnteriorExistente: type: boolean description: Permite lançamentos com data/hota anterior aos movimentos já existentes default: false permiteAgendamentoAnteriorAtual: type: boolean description: Permite informar a data/hora de agendamento anterior a data/hora atual default: false exigeAgendamento: type: boolean description: Exige data de agendamento default: false permiteMovimentar: type: boolean description: Permite fazer a movimentação via portal default: true situacaoMercadoria: type: string allOf: – #/definitions/enumSituacaoMercadoria description: Situação da mercadoria exigeFilialEntrega: type: boolean description: Exige filial na movimentação da ocorrência default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: planoConta: description: Plano de conta type: object required: – codigo – descricao – tipoConta properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição tipoConta: type: string allOf: – #/definitions/enumTipoPlanoConta description: Tipo de conta 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: centroCusto: description: Centro de custo type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição 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: condicaoVencimento: description: Condição vencimento type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição quantidadeParcela: type: number format: double description: Quantidade de parcela 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: regiao: description: Região type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código numeroIdentificador: type: string description: Número Identificador descricao: type: string description: Descrição atendeDomingo: type: boolean description: Domingo default: false atendeSegunda: type: boolean description: Segunda-feira default: false atendeTerca: type: boolean description: Terça-feira default: false atendeQuarta: type: boolean description: Quarta-feira default: false atendeQuinta: type: boolean description: Quinta-feira default: false atendeSexta: type: boolean description: Sexta-feira default: false atendeSabado: type: boolean description: Sábado default: false freteAPagar: type: boolean description: Aceitar Frete A Pagar default: false atendeColeta: type: boolean description: Atende Coleta default: false atendeEntrega: type: boolean description: Atende Entrega default: false dificilAcesso: type: boolean description: Difícil Acesso default: false 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: cep: description: CEP type: object required: – codigo – logradouros properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código numeroIdentificador: type: string description: Número Identificador tipo: type: string description: Tipo logradouros: type: string description: Endereço bairro: type: string description: Bairro cidade: type: string description: Cidade uf: type: string description: UF pais: type: string description: País codigoIbge: type: string description: Código IBGE regiao: type: object allOf: – #/definitions/regiao description: Região 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: percurso: description: Percurso type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido regiaoOrigem: type: object allOf: – #/definitions/regiao description: Região Origem regiaoDestino: type: object allOf: – #/definitions/regiao description: Região Destino quilometragem: type: number format: double description: Quilometragem quantidadePedagio: type: integer format: int64 description: Quantidade de Pedágios numeroDiasEntrega: type: integer format: int64 description: Número de dias para entrega numeroHorasEntrega: type: number format: double description: Número de horas para entrega 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: percursoComercial: description: Percurso comercial type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido tipoPercurso: type: string allOf: – #/definitions/enumTipoPercursoComercial description: Tipo do Percurso 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: configuracoesGerais: description: Tipo de transporte type: object required: – chave – valor – tipo properties: id: type: string format: uuid description: Chave da tabela chave: type: string description: Chave TMS valor: type: string description: Valor tipo: type: string description: Tipo do valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoTransporte: description: Tipo de transporte type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição geraEdiOcoren: type: boolean description: Gerar Registro para EDI OCOREN default: false geraEdiDocCob: type: boolean description: Gerar Registro para EDI DOCCOB default: false geraEdiConemb: type: boolean description: Gerar Registro para EDI CONEMB default: false exigeInfColetaConh: type: boolean description: Exige informar coleta no CTRC default: false cargaDireta: type: boolean description: Carga Direta default: false exigeVincOper: type: boolean description: Vinculação de Operação default: false indicadorLotacao: type: integer format: int64 description: Indicador de lotação para CT-e cstPis: type: string description: CST do PIS/PASEP cstCofins: type: string description: CST da COFINS valorPctBasePis: type: number format: double description: Base de Cálculo PIS valorPctBaseCofins: type: number format: double description: Base de Cálculo COFINS valorAliqPis: type: number format: double description: Alíquota PIS valorAliqCofins: type: number format: double description: Alíquota COFINS tipoTransporteRms: type: integer format: int64 description: Vinculação RMS 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: tipoVeiculo: description: Tipo de veículo type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido rebocador: type: boolean description: Rebocador default: false reboque: type: boolean description: Rebocado default: false siglaAntt: type: string description: Sigla ANTT exigeReboque: type: boolean description: Exibe reboque default: false valorCustoPorKm: type: number format: double description: Custo por KM exigeRenavam: type: boolean description: Exibe RENAVAM default: false 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: especieCarga: description: Espécie da carga type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição receitaFederal: type: boolean description: Código da receita federal default: false valorComprimento: type: number format: double description: Comprimento valorAltura: type: number format: double description: Altura valorLargura: type: number format: double description: Largura valorCubagem: type: number format: double description: Cubagem permPaletizacao: type: boolean description: Permite paletização default: false 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: naturezaCarga: description: Natureza da carga type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido numeroIdentificador: type: string description: Número Identificador codigoMercosul: type: integer format: int64 description: Código mercosul especieCarga: type: object allOf: – #/definitions/especieCarga description: Espécie da carga 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: naturezaOperacao: description: Natureza de operação type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição apelido: type: string description: Apelido numeroIdentificador: type: string description: Número Identificador cfop: type: string description: CFOP tipoNaturezaOperacao: type: string allOf: – #/definitions/enumTipoNaturezaOperacao description: Tipo da natureza de operação 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: empresa: description: Empresa type: object required: – nome – cnpj properties: id: type: string format: uuid description: Chave da tabela nome: type: string description: Nome cnpj: type: string description: CNPJ createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Filial type: object required: – nome – cnpj – tipoFilial – empresa properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código nome: type: string description: Nome apelido: type: string description: Apelido cnpj: type: string description: CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoFilial: type: string allOf: – #/definitions/enumTipoFilial description: Tipo empresa: type: object allOf: – #/definitions/empresa description: Empresa 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: cliente: description: Cliente type: object required: – inscricaoFiscal – nome properties: id: type: string format: uuid description: Chave da tabela tipoInscricao: type: string allOf: – #/definitions/enumTipoInscricao description: Tipo de inscrição inscricaoFiscal: type: string description: Inscrição fiscal inscricaoEstadual: type: string description: Inscricao estadual inscricaoMunicipal: type: string description: Inscricao municipal nome: type: string description: Nome endereco: type: string description: Endereço numero: type: string description: Número bairro: type: string description: Bairro cep: type: string description: CEP telefone: type: string description: Telefone complemento: type: string description: Complemento ativo: type: boolean description: Status default: true origem: type: string allOf: – #/definitions/enumOrigem description: Origem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: clientePercurso: description: Cliente Percurso type: object required: – cliente – percurso properties: id: type: string format: uuid description: Chave da tabela numeroDiasEntrega: type: integer format: int64 description: Número de dias para entrega numeroHorasEntrega: type: integer format: int64 description: Número de horas para entrega cliente: type: object allOf: – #/definitions/cliente description: Cliente percurso: type: object allOf: – #/definitions/percurso description: Percurso createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: fatura: description: Fatura type: object required: – numero – dataEmissao – valorTotal – situacao – filial – cliente properties: id: type: string format: uuid description: Chave da tabela numero: type: string description: Número da fatura parcela: type: string description: Parcela dataEmissao: type: string format: date-time description: Data da emissão dataLeitura: type: string format: date-time description: Data da visualização dataCancelamento: type: string format: date-time description: Data do cancelamento dataVencimento: type: string format: date-time description: Data do vencimento dataPagamento: type: string format: date-time description: Data do pagamento valorTotal: type: number format: double description: Valor total valorSaldo: type: number format: double description: Valor Saldo valorDesconto: type: number format: double description: Valor desconto valorAcrescimo: type: number format: double description: Valor acréscimo valorEstorno: type: number format: double description: Valor estorno valorBaseCalculo: type: number format: double description: Valor base de cálculo valorLiquido: type: number format: double description: Valor líquido valorIcms: type: number format: double description: Valor ICMS valorDescontoIcms: type: number format: double description: Valor desconto ICMS codigoTitulo: type: string description: Código do título registroBanco: type: string description: Registro do banco moeda: type: string description: Moeda condicaoVencimento: type: string description: Condição de vencimento observacao: type: string description: Observação situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação tipoFatura: type: string allOf: – #/definitions/enumTipoFatura description: Tipo da fatura filial: type: object allOf: – #/definitions/filial description: Filial cliente: type: object allOf: – #/definitions/cliente description: Cliente portadorFatura: type: object allOf: – #/definitions/portadorFatura description: Portador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: portadorFatura: description: Portador da fatura type: object required: – codigo – descricao properties: id: type: string format: uuid description: Chave da tabela codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição 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: faturaArquivo: description: Arquivos da fatura type: object required: – fatura – arquivo properties: id: type: string format: uuid description: Chave da tabela fatura: type: object allOf: – #/definitions/fatura description: Fatura arquivo: type: object allOf: – #/definitions/arquivo description: Arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: conhecimento: description: Conhecimento type: object required: – dataEmissao – situacaoSefaz – filial – remetente – destinatario properties: id: type: string format: uuid description: Chave da tabela sequenciaControle: type: integer format: int64 description: Número Sequencia Controle numero: type: string description: Número serie: type: string description: Série dataEmissao: type: string format: date-time description: Data de emissão dataPagamento: type: string format: date-time description: Data do pagamento dataEntrega: type: string format: date-time description: Data da entrega dataCancelamento: type: string format: date-time description: Data do cancelamento dataLeitura: type: string format: date-time description: Data da visualização dataPrevisaoEntrega: type: string format: date-time description: Data de previsão de entrega chaveAcesso: type: string description: Chave de acesso numeroProtocolo: type: string description: Número protocolo versaoLayout: type: string description: Versão layout placaVeiculo: type: string description: Placa veículo placaReboque1: type: string description: Placa reboque 1 placaReboque2: type: string description: Placa reboque 2 placaReboque3: type: string description: Placa reboque 3 observacao: type: string description: Observação valorMercadoria: type: number format: double description: Valor mercadoria valorTotalPrestacao: type: number format: double description: Valor total da prestação valorAliquotaIcms: type: number format: double description: Valor alíquota ICMS valorIcms: type: number format: double description: Valor ICMS valorAliquotaIss: type: number format: double description: Valor alíquota ISS valorIss: type: number format: double description: Valor ISS valorFretePeso: type: number format: double description: Valor frete peso valorFrete: type: number format: double description: Valor frete valorSeguro: type: number format: double description: Valor seguro valorAdeme: type: number format: double description: Valor ADEME valorItr: type: number format: double description: Valor ITR valorSeccat: type: number format: double description: Valor SEC/CAT valorDespacho: type: number format: double description: Valor despacho valorPedagio: type: number format: double description: Valor pedágio valorSuframa: type: number format: double description: Valor SUFRAMA valorBalsa: type: number format: double description: Valor balsa valorOutros: type: number format: double description: Valor outros valorGris: type: number format: double description: Valor GRIS valorTde: type: number format: double description: Valor TDE valorCap: type: number format: double description: Valor CAP valorCad: type: number format: double description: Valor CAD valorTrt: type: number format: double description: Valor TRT valorTep: type: number format: double description: Valor TEP quantidadePeso: type: number format: double description: Peso quantidadePesoCubado: type: number format: double description: Peso cubado quantidadeVolume: type: number format: double description: Volume quantidadeMetrosCubicos: type: number format: double description: Metros cúbicos situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação situacaoSefaz: type: string allOf: – #/definitions/enumSitConhecimentoSefaz description: Situação SEFAZ tipoEmissao: type: string allOf: – #/definitions/enumTipoEmissao description: Tipo de emissão tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de frete tipoIcms: type: string allOf: – #/definitions/enumTipoICMS description: Tipo de ICMS filial: type: object allOf: – #/definitions/filial description: Filial remetente: type: object allOf: – #/definitions/cliente description: Remetente destinatario: type: object allOf: – #/definitions/cliente description: Destinatário consignatario: type: object allOf: – #/definitions/cliente description: Consignatário redespacho: type: object allOf: – #/definitions/cliente description: Redespacho tipoDocumentoFiscal: type: object allOf: – #/definitions/tipoDocumentoFiscal description: Tipo de documento fiscal cepColeta: type: object allOf: – #/definitions/cep description: Cep Coleta cepEntrega: type: object allOf: – #/definitions/cep description: Cep Entrega enderecoColeta: type: string description: Endereço de coleta enderecoEntrega: type: string description: Endereço de entrega manifestado: type: boolean description: Manifestado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: conhecimentoArquivo: description: Arquivos do conhecimento type: object required: – conhecimento – arquivo properties: id: type: string format: uuid description: Chave da tabela conhecimento: type: object allOf: – #/definitions/conhecimento description: Conhecimento arquivo: type: object allOf: – #/definitions/arquivo description: Arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: faturaConhecimento: description: Vinculação da fatura com o conhecimento type: object required: – fatura – conhecimento – situacao properties: id: type: string format: uuid description: Chave da tabela fatura: type: object allOf: – #/definitions/fatura description: Fatura conhecimento: type: object allOf: – #/definitions/conhecimento description: Conhecimento situacao: type: string allOf: – #/definitions/enumSitFaturaConhecimento description: Situação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ocorrenciaConhecimento: description: Ocorrência de entrega do conhecimento type: object required: – conhecimento – ocorrencia – dataEmissao – dataMovimento properties: id: type: string format: uuid description: Chave da tabela conhecimento: type: object allOf: – #/definitions/conhecimento description: Conhecimento ocorrencia: type: object allOf: – #/definitions/ocorrencia description: Ocorrência sequencia: type: integer format: int64 description: Ocorr�ncia conhecimento Sequencia dataEmissao: type: string format: date-time description: Data de emissão dataMovimento: type: string format: date-time description: Data de movimento dataAgendamento: type: string format: date-time description: Data de previsão observacao: type: string description: Observação contatoNome: type: string description: Nome do Contato contatoRg: type: string description: RG do Contato contatoTelefone: type: string description: Telefone do Contato quantidadePallets: type: integer format: int64 description: Quantidade de pallets filialEntrega: type: object allOf: – #/definitions/filial description: filial que realizou o movimento de entrega do conhecimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ocorrenciaConhecimentoArquivo: description: Arquivos da ocorrência type: object required: – ocorrenciaConhecimento – arquivo properties: id: type: string format: uuid description: Chave da tabela ocorrenciaConhecimento: type: object allOf: – #/definitions/ocorrenciaConhecimento description: Ocorrência do conhecimento arquivo: type: object allOf: – #/definitions/arquivo description: Arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notaFiscal: description: Nota fiscal type: object required: – dataEmissao – valorTotal – situacaoSefaz – filial – emitente – tomador properties: id: type: string format: uuid description: Chave da tabela numero: type: string description: Número serie: type: string description: Série dataEmissao: type: string format: date-time description: Data de emissão dataPagamento: type: string format: date-time description: Data do pagamento dataEntrega: type: string format: date-time description: Data da entrega dataCancelamento: type: string format: date-time description: Data do cancelamento dataLeitura: type: string format: date-time description: Data da visualização valorTotal: type: number format: double description: Valor total valorBruto: type: number format: double description: Valor bruto valorCofins: type: number format: double description: Valor COFINS valorIrrf: type: number format: double description: Valor IRRF valorIss: type: number format: double description: Valor ISS valorPis: type: number format: double description: Valor PIS valorIcms: type: number format: double description: Valor ICMS valorIpi: type: number format: double description: Valor IPI quantidadePeso: type: number format: double description: Peso quantidadePesoCubado: type: number format: double description: Peso cubado quantidadeVolume: type: number format: double description: Volume quantidadeMetrosCubicos: type: number format: double description: Metros cúbicos naturezaOperacao: type: string description: Natureza chaveAcesso: type: string description: Chave de acesso marca: type: string description: Marca numeroTransporte: type: string description: Número de transporte identificacaoCarga: type: integer format: int64 description: Identificação da carga codigoOperadorLogistico: type: string description: Código do operador logístico situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação situacaoSefaz: type: string allOf: – #/definitions/enumSitNotaFiscalSefaz description: Situação SEFAZ filial: type: object allOf: – #/definitions/filial description: Filial emitente: type: object allOf: – #/definitions/cliente description: Emitente tomador: type: object allOf: – #/definitions/cliente description: Tomador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notaFiscalArquivo: description: Arquivos da nota fiscal type: object required: – notaFiscal – arquivo properties: id: type: string format: uuid description: Chave da tabela notaFiscal: type: object allOf: – #/definitions/notaFiscal description: Nota fiscal arquivo: type: object allOf: – #/definitions/arquivo description: Arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notaFiscalConhecimento: description: Vinculação da nota fiscal com o conhecimento type: object required: – notaFiscal – conhecimento properties: id: type: string format: uuid description: Chave da tabela notaFiscal: type: object allOf: – #/definitions/notaFiscal description: Nota Fiscal conhecimento: type: object allOf: – #/definitions/conhecimento description: Conhecimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notaFiscalServico: description: Nota fiscal de serviço type: object required: – dataEmissao – emitente – tomador properties: id: type: string format: uuid description: Chave da tabela numeroRPS: type: string description: Número RPS numero: type: string description: Número NFSe serie: type: string description: Série dataEmissao: type: string format: date-time description: Data de emissão dataPagamento: type: string format: date-time description: Data do pagamento dataEntrega: type: string format: date-time description: Data da entrega dataCancelamento: type: string format: date-time description: Data do cancelamento dataLeitura: type: string format: date-time description: Data da visualização dataAutorizacao: type: string format: date-time description: Data da autorização dataVinculacao: type: string format: date-time description: Data de vinculação situacao: type: string allOf: – #/definitions/enumSitDocumento description: Situação emitente: type: object allOf: – #/definitions/filial description: Emitente tomador: type: object allOf: – #/definitions/cliente description: Tomador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notaFiscalServicoArquivo: description: Arquivos da nota fiscal de serviço type: object required: – notaFiscalServico – arquivo properties: id: type: string format: uuid description: Chave da tabela notaFiscalServico: type: object allOf: – #/definitions/notaFiscalServico description: Nota fiscal de serviço arquivo: type: object allOf: – #/definitions/arquivo description: Arquivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: relSituacaoTransporte: description: View rel_situacao_transporte type: object properties: id: type: string format: uuid description: Id notafiscalNumero: type: string description: notafiscalSerie: type: string description: notafiscalDataEmissao: type: string format: date-time description: notafiscalValorTotal: type: number format: double description: notafiscalQuantidadePeso: type: number format: double description: notafiscalQuantidadePesoCubado: type: number format: double description: notafiscalQuantidadeVolume: type: number format: double description: notafiscalQuantidadeMetrosCubicos: type: number format: double description: notafiscalNaturezaOperacao: type: string description: notafiscalChaveAcesso: type: string description: notafiscalMarca: type: string description: notafiscalNumeroTransporte: type: string description: notafiscalIdentificacaoCarga: type: integer format: int64 description: notafiscalCodigoOperadorLogistico: type: string description: emitentenotafiscalInscricaoFiscal: type: string description: emitentenotafiscalNome: type: string description: emitentenotafiscalEndereco: type: string description: emitentenotafiscalNumero: type: string description: emitentenotafiscalBairro: type: string description: emitentenotafiscalCep: type: string description: tomadornotafiscalInscricaoFiscal: type: string description: tomadornotafiscalNome: type: string description: tomadornotafiscalEndereco: type: string description: tomadornotafiscalNumero: type: string description: tomadornotafiscalBairro: type: string description: tomadornotafiscalCep: type: string description: conhecimentoId: type: string format: uuid description: conhecimentoNumero: type: string description: conhecimentoSerie: type: string description: conhecimentoDataEmissao: type: string format: date-time description: conhecimentoDataEntrega: type: string format: date-time description: conhecimentoDataPrevisaoEntrega: type: string format: date-time description: conhecimentoValorMercadoria: type: number format: double description: conhecimentoValorTotalPrestacao: type: number format: double description: conhecimentoValorAliquotaIcms: type: number format: double description: conhecimentoValorIcms: type: number format: double description: conhecimentoValorFretePeso: type: number format: double description: conhecimentoValorFrete: type: number format: double description: conhecimentoValorAdeme: type: number format: double description: conhecimentoValorItr: type: number format: double description: conhecimentoValorSeccat: type: number format: double description: conhecimentoValorDespacho: type: number format: double description: conhecimentoValorPedagio: type: number format: double description: conhecimentoValorGris: type: number format: double description: conhecimentoQuantidadePeso: type: number format: double description: conhecimentoQuantidadePesoCubado: type: number format: double description: conhecimentoQuantidadeVolume: type: number format: double description: conhecimentoQuantidadeMetrosCubicos: type: number format: double description: conhecimentoNumeroProtocolo: type: string description: conhecimentoChaveAcesso: type: string description: conhecimentoTipoEmissao: type: string allOf: – #/definitions/enumTipoEmissao description: conhecimentoTipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: conhecimentoTipoIcms: type: string allOf: – #/definitions/enumTipoICMS description: filialconhecimentoCodigo: type: integer format: int64 description: filialconhecimentoNome: type: string description: filialconhecimentoCnpj: type: string description: remetenteconhecimentoInscricaoFiscal: type: string description: remetenteconhecimentoNome: type: string description: remetenteconhecimentoEndereco: type: string description: remetenteconhecimentoNumero: type: string description: remetenteconhecimentoBairro: type: string description: remetenteconhecimentoCep: type: string description: destinatarioconhecimentoInscricaoFiscal: type: string description: destinatarioconhecimentoNome: type: string description: destinatarioconhecimentoEndereco: type: string description: destinatarioconhecimentoNumero: type: string description: destinatarioconhecimentoBairro: type: string description: destinatarioconhecimentoCep: type: string description: redespachoconhecimentoInscricaoFiscal: type: string description: redespachoconhecimentoNome: type: string description: redespachoconhecimentoEndereco: type: string description: redespachoconhecimentoNumero: type: string description: redespachoconhecimentoBairro: type: string description: redespachoconhecimentoCep: type: string description: consignatarioconhecimentoInscricaoFiscal: type: string description: consignatarioconhecimentoNome: type: string description: consignatarioconhecimentoEndereco: type: string description: consignatarioconhecimentoNumero: type: string description: consignatarioconhecimentoBairro: type: string description: consignatarioconhecimentoCep: type: string description: ocorrenciaconhecimentoDataMovimento: type: string format: date-time description: ocorrenciaconhecimentoDataAgendamento: type: string format: date-time description: ocorrenciaconhecimentoObservacao: type: string description: ocorrenciaconhecimentoContato: type: string description: ocorrenciaconhecimentoocorrenciaDescricao: type: string description: ocorrenciaconhecimentoocorrenciaExibir: type: string allOf: – #/definitions/enumExibirOcorrencia description: faturaNumero: type: string description: faturaParcela: type: string description: faturaDataEmissao: type: string format: date-time description: faturaValorTotal: type: number format: double description: faturaValorDesconto: type: number format: double description: faturaValorIcms: type: number format: double description: faturaValorLiquido: type: number format: double description: faturaSituacao: type: string allOf: – #/definitions/enumSitDocumento description: faturaDataVencimento: type: string format: date-time description: faturaDataPagamento: type: string format: date-time description: faturaPortadorFatura: type: string description: filialfaturaCodigo: type: integer format: int64 description: filialfaturaNome: type: string description: filialfaturaCnpj: type: string description: clientefaturaInscricaoFiscal: type: string description: clientefaturaNome: type: string description: clientefaturaEndereco: type: string description: clientefaturaNumero: type: string description: clientefaturaBairro: type: string description: clientefaturaCep: type: string description: cepdestinatarioCidade: type: string description: cepdestinatarioUf: type: string description: cepremetenteCidade: type: string description: cepremetenteUf: type: string description: cepcoletaconhecimentoCidade: type: string description: cepcoletaconhecimentoUf: type: string description: conhecimentoEnderecoColeta: type: string description: cepcoletaconhecimentoBairro: type: string description: cepcoletaconhecimentoCep: type: string description: cepentregaconhecimentoCidade: type: string description: cepentregaconhecimentoUf: type: string description: conhecimentoEnderecoEntrega: type: string description: cepentregaconhecimentoBairro: type: string description: cepentregaconhecimentoCep: type: string description: conhecimentoSituacao: type: string allOf: – #/definitions/enumSitDocumento description: conhecimentoSituacaoSefaz: type: string allOf: – #/definitions/enumSitConhecimentoSefaz description: clienteInfoTecnica: description: Informações tecnicas do cliente type: object required: – id – cliente – nomeProduto properties: id: type: string format: uuid description: Id cliente: type: object allOf: – #/definitions/cliente description: Cliente embarcador: type: object allOf: – #/definitions/embarcador description: Embarcador natureza: type: object allOf: – #/definitions/naturezaCarga description: Natureza especie: type: object allOf: – #/definitions/especieCarga description: Espécie de carga tipoTransporte: type: object allOf: – #/definitions/tipoTransporte description: Tipo de transporte nomeProduto: type: string description: Nome do produto valorMedioVolume: type: number format: double description: valor Medio de Volume pesoMedioVolume: type: number format: double description: Peso médio volume metrosCubicosVolume: type: number format: double description: Metros cubicos volume quantidadeMediaEntrega: type: integer format: int64 description: Quantidade media entrega distanciaMedia: type: integer format: int64 description: Distância média tipoMovimentoTransporte: type: string allOf: – #/definitions/enumTipoTransporte description: Tipo de movimento de transporte incluirObservacaoConhecimento: type: boolean description: Incluir observação de conhecimento sequencia: type: integer format: int64 description: Sequencia calculoCubagem: type: string allOf: – #/definitions/enumCalculoCubagem description: Cálculo de cubagem observacao: type: string description: Observacao createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: coleta: description: Dados da coleta type: object required: – id – contato properties: id: type: string format: uuid description: Id filial: type: object allOf: – #/definitions/filial description: Filial codigoColeta: type: integer format: int64 description: Código da coleta contato: type: object allOf: – #/definitions/embarcadorContato description: Contato embarcador dataEmissao: type: string format: date-time description: Data emissão naturezaOperacao: type: object allOf: – #/definitions/naturezaCarga description: Natureza especieCarga: type: object allOf: – #/definitions/especieCarga description: Espécie quantidadeVolumes: type: number format: double description: Volumes quantidadePeso: type: number format: double description: Peso destinatario: type: object allOf: – #/definitions/cliente description: destinatário observacao: type: string description: Observação placaVeiculo: type: string description: Placa do veículo cpfMotorista: type: string description: CPF Motorista codigoFuncionario: type: integer format: int64 description: codigo do funcionario embarcador: type: object allOf: – #/definitions/embarcador description: Embarcador regiao: type: object allOf: – #/definitions/regiao description: Região codigoSubRegiao: type: integer format: int64 description: Código de sub região tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de Frete nomeEmbarcador: type: string description: Nome do embarcador numeroCepColeta: type: string description: CEP Coleta endereco: type: string description: Endereço completo bairro: type: string description: Bairro pontoReferencia: type: string description: Ponto de referencia localDestino: type: string description: Local destino filialDestino: type: object allOf: – #/definitions/filial description: Filial destino romaneioColeta: type: boolean description: Romaneio Coleta nomeDestinatario: type: string description: Nome do destinatário nomeContato: type: string description: Contato codigoMotivoCancelamento: type: integer format: int64 description: Código do motivo de cancelamento situacao: type: string allOf: – #/definitions/enumSituacaoColeta description: Situação descricaoMotivoCancelamento: type: string description: Descrição do motivo do cancelamento faseColeta: type: string allOf: – #/definitions/enumFaseColeta description: Fase da coleta urgente: type: boolean description: Urgente tipoColeta: type: string description: Tipo de coleta usuarioTms: type: string description: Usuário TMS dataCadastro: type: string format: date-time description: Data cadastro erroProcesso: type: string description: Mensagem de erro dataAgendamento: type: string format: date-time description: Data agendamento horaLimite: type: string format: date-time description: Hora limite valorNotaFiscal: type: number format: double description: valor da nota fiscal dataAprovacao: type: string format: date-time description: Data aprovação codigoRota: type: integer format: int64 description: Codigo da rota tipoTransporte: type: object allOf: – #/definitions/tipoTransporte description: tipo de transporte quantidadeMetrosCubicos: type: number format: double description: Quantidade de metros cubicos quantidadePesoCubado: type: number format: double description: Quantidade de peso cubado pedirVisto: type: boolean description: Pedir visto? usuarioVistoTms: type: string description: Usuario visto tms dataVisto: type: string format: date-time description: Data do visto codigoGerenciadorRisco: type: integer format: int64 description: Código do gerenciador de risco usuarioCancelamentoTms: type: string description: Usuário de cancelmaneto do TMS dataCancelamento: type: string format: date-time description: Data de cancelamento usuarioBaixaTms: type: string description: Usuário baixa TMS dataBaixa: type: string format: date-time description: Data da baixa codigoRegiaoColetaEntrega: type: integer format: int64 description: Código da região de coleta entrega consignatario: type: object allOf: – #/definitions/cliente description: Consignatário observacaoConhecimento: type: string description: Observação do conhecimento codigoViagem: type: integer format: int64 description: Código da viagem ano: type: integer format: int64 description: Ano smp: type: integer format: int64 description: SMP placaReboque1: type: integer format: int64 description: Placa do reboque 1 placaReboque2: type: integer format: int64 description: Placa do reboque 2 codigoAtendimento: type: integer format: int64 description: Código de atendimento filialAtendimento: type: integer format: int64 description: Filial de atendimento localInformacaoVeiculo: type: integer format: int64 description: Local informação veiculo telefoneContato: type: string description: Telefone Contato numeroTransporte: type: integer format: int64 description: Número do transporte primeiraColeta: type: boolean description: Primeira coleta? usuarioImpressaoTms: type: string description: Usuário de impressão do TMS dataImpressao: type: string format: date-time description: Data da impressão impresso: type: boolean description: Impresso? idMobile: type: string description: Id mobile dataInicioColeta: type: string format: date-time description: Data de inicio da coleta origemInclusao: type: string description: Origem da inclusao codigoEmpresaTabela: type: integer format: int64 description: Código empresa tabela codigoTabelaCliente: type: integer format: int64 description: Código tabela cliente dataInicioVigencia: type: string format: date-time description: Data de inicio de vigência dataFimVigencia: type: string format: date-time description: Data fim da vigência codigoConceitoCliente: type: integer format: int64 description: Código conceito cliente filialCotacao: type: integer format: int64 description: filial cotação codigoCotacao: type: integer format: int64 description: codigo_cotacao atividadeRms: type: integer format: int64 description: Atividade RMS numeroPedidoColeta: type: integer format: int64 description: Número pedido coleta dataAgendamentoEntrega: type: string format: date-time description: Data de agendamento da entrega numeroPreSmp: type: integer format: int64 description: Número pre SMP cliente: type: object allOf: – #/definitions/cliente description: cliente createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cotacaoFrete: description: Cotação de frete type: object required: – identificador – dataEmissao properties: id: type: string format: uuid description: Id identificador: type: integer format: int64 description: Identificador da simulação do frete codigoCotacao: type: integer format: int64 description: Código cotação codigoColeta: type: integer format: int64 description: Código coleta filialEmitente: type: object allOf: – #/definitions/filial description: Emitente dataEmissao: type: string format: date-time description: Data emissão dataValidade: type: string format: date-time description: Data validade dataAprovacao: type: string format: date-time description: Data aprovação quantidadeDiasEntrega: type: integer format: int64 description: Dias de Entrega remetente: type: object allOf: – #/definitions/cliente description: Remetente destinatario: type: object allOf: – #/definitions/cliente description: Destinatário consignatario: type: object allOf: – #/definitions/cliente description: Consignatário numeroCepColeta: type: string description: CEP Coleta numeroCepEntrega: type: string description: CEP Entrega percursoComercial: type: object allOf: – #/definitions/percursoComercial description: Percurso comercial percursoOperacional: type: object allOf: – #/definitions/percurso description: Percurso operacional naturezaCarga: type: object allOf: – #/definitions/naturezaCarga description: Natureza de carga naturezaOperacao: type: object allOf: – #/definitions/naturezaOperacao description: Natureza de operação tipoTransporte: type: object allOf: – #/definitions/tipoTransporte description: Tipo transporte tipoVeiculo: type: object allOf: – #/definitions/tipoVeiculo description: Tipo veículo icmsIncluso: type: string allOf: – #/definitions/enumICMSIncluso description: ICMS Incluso tipoIcms: type: string allOf: – #/definitions/enumTipoICMS description: Tipo ICMS tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de Frete quantidadePeso: type: string description: Peso minimum: 0 quantidadePesoCubado: type: string description: Peso cubado minimum: 0 quantidadeVolumes: type: string description: Volume minimum: 0 quantidadePares: type: integer format: int64 description: Pares quantidadeMetrosCubicos: type: string description: Metros cúbico minimum: 0 valorMercadoria: type: string description: Valor da mercadoria minimum: 0 codigoTarifa: type: integer format: int64 description: Código da tarifa descricaoTarifa: type: string description: Descrição da tarifa codigoEmpresaTabela: type: integer format: int64 description: Código empresa tabela frete codigoTabelaPreco: type: integer format: int64 description: Código tabela frete codigoPerfilUsuario: type: integer format: int64 description: Código perfil usuário valorPeso: type: number format: double description: Valor total por peso valorPesoUnitario: type: number format: double description: Valor unitário por peso valorPesoCobrado: type: number format: double description: Valor total cobrado por peso valorCoefPeso: type: number format: double description: Valor coeficiente peso valorBaseCalculo: type: number format: double description: Base de cálculo valorPercIcms: type: number format: double description: % ICMS valorIcms: type: number format: double description: ICMS valorPercIss: type: number format: double description: % ISS valorIss: type: number format: double description: ISS valorFretePeso: type: number format: double description: Frete peso valorFreteValor: type: number format: double description: Frete valor valorSeccat: type: number format: double description: SEC / CAT valorDespacho: type: number format: double description: Despacho valorPedagio: type: number format: double description: Pedágio valorAdeme: type: number format: double description: ADEME valorGris: type: number format: double description: GRIS valorItr: type: number format: double description: ITR valorSuframa: type: number format: double description: SUFRAMA valorBalsa: type: number format: double description: Balsa valorSeguro: type: number format: double description: Seguro valorCap: type: number format: double description: CAP valorCad: type: number format: double description: CAD valorTep: type: number format: double description: TEP valorTfb: type: number format: double description: TFB valorTas: type: number format: double description: TAS valorTce: type: number format: double description: TCE valorTdc: type: number format: double description: TDC valorTda: type: number format: double description: TDA valorTde: type: number format: double description: TDE valorTrt: type: number format: double description: TRT valorDesc: type: number format: double description: Desconto valorOutros: type: number format: double description: Outros valorTag: type: number format: double description: TAG valorFrete: type: number format: double description: Valor total do frete valorLiquido: type: number format: double description: Valor líquido contatoEmail: type: string description: Email do contato situacao: type: string allOf: – #/definitions/enumSituacaoCotacaoFrete description: Situação erroProcesso: type: string description: Mensagem de erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cotacaoFreteVolume: description: Volumes da cotação de frete type: object required: – cotacaoFrete properties: id: type: string format: uuid description: Id cotacaoFrete: type: object allOf: – #/definitions/cotacaoFrete description: Cotação de frete quantidade: type: string description: Quantidade minimum: 0 altura: type: string description: Altura minimum: 0 largura: type: string description: Largura minimum: 0 comprimento: type: string description: Comprimento minimum: 0 quantidadeMetrosCubicos: type: string description: Metros cúbico minimum: 0 quantidadePesoCubado: type: string description: Peso cubado minimum: 0 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: coletaDestino: description: Destinos da coleta type: object required: – id properties: id: type: string format: uuid description: Id filial: type: object allOf: – #/definitions/filial description: Filial coleta: type: object allOf: – #/definitions/coleta description: Coleta sequencia: type: integer format: int64 description: Sequencia quantidadeVolumes: type: number format: double description: Volumes quantidadePeso: type: number format: double description: Peso destinatario: type: object allOf: – #/definitions/cliente description: Destinatário filialDestino: type: object allOf: – #/definitions/filial description: Filial Destino numeroCepDestino: type: string description: CEP entrega embarqueUrgente: type: boolean description: Embarque Urgente quantidadeMetrosCubicos: type: number format: double description: Quantidade metros cubicos valorNotaFiscal: type: number format: double description: Valor da nota fiscal observacao: type: string description: Observação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: embarcador: description: Embarcador type: object required: – id – telefone – filial – codigoLocalEmbarque – dataInicioColeta properties: id: type: string format: uuid description: Id telefone: type: string description: Telefone nome: type: string description: Nome inscricao: type: object allOf: – #/definitions/cliente description: Inscrição endereco: type: string description: Endereço bairro: type: string description: Bairro cep: type: object allOf: – #/definitions/cep description: Cep pontoReferencia: type: string description: ponto de referencia dataLimite: type: string format: date-time description: Data limite naturezaCarga: type: object allOf: – #/definitions/naturezaCarga description: Natureza carga especieCarga: type: object allOf: – #/definitions/especieCarga description: Especie Carga tipoFrete: type: string description: Tipo de frete observacao: type: string description: Observação filial: type: object allOf: – #/definitions/filial description: Filial codigoLocalEmbarque: type: integer format: int64 description: Código de local de embarque dataInicioColeta: type: string format: date-time description: Data de inicio de coleta createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: embarcadorContato: description: Embarcador Contato type: object required: – id properties: id: type: string format: uuid description: id embarcador: type: object allOf: – #/definitions/embarcador description: Embarcador codigo: type: integer format: int64 description: Código nome: type: string description: Nome apelido: type: string description: Apelido cep: type: object allOf: – #/definitions/cep description: CEP endereco: type: string description: Endereço bairro: type: string description: Bairro email: type: string description: Email setor: type: string description: Setor telefoneContato: type: string description: Telefone contato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: coletaNotaFiscal: description: Notas fiscais da coleta type: object properties: id: type: string format: uuid description: Id coleta: type: object allOf: – #/definitions/coleta description: Coleta numeroNotaFiscal: type: integer format: int64 description: Numero serie: type: string description: Série remetente: type: object allOf: – #/definitions/cliente description: Remetente filial: type: object allOf: – #/definitions/filial description: Filial situacao: type: string description: Situação destinatario: type: object allOf: – #/definitions/cliente description: Destinatario dataEmissao: type: string format: date-time description: Data emissão quantidadePeso: type: number format: double description: Quantidade Peso quantidadePesoCubado: type: number format: double description: Quanitade de Peso Cubado valorNotaFiscal: type: number format: double description: Valor da nota fiscal valorBaseCalculo: type: number format: double description: Valor de base de cálculo quantidadeVolumes: type: number format: double description: Quantidade Volumes quantidadeMetrosCubicos: type: number format: double description: Quantidade de metros cubicos naturezaCarga: type: object allOf: – #/definitions/naturezaCarga description: Natureza de carga especieCarga: type: object allOf: – #/definitions/especieCarga description: Especie de carga quantidadePares: type: integer format: int64 description: Quantidade de pares cfop: type: string description: CFOP identificacaoCarga: type: integer format: int64 description: Identificação de carga numeroTransporte: type: integer format: int64 description: Numero de transporte identificacaoCargaBeta: type: string description: Identificação de carga beta tipoFrete: type: string description: Tipo frete inscricaoFilialPrestServ: type: string description: Inscrição filial prestadora de serviço logCalculoMetrosCubicos: type: string description: Log do calculo de metro cubicos numeroPedido: type: string description: Número do pedido createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: processamentoIntegracao: description: Processamento da integração type: object required: – processo – status properties: id: type: string format: uuid description: Id processo: type: string allOf: – #/definitions/enumIntegracaoProcesso description: Processo status: type: string allOf: – #/definitions/enumStatusProcessamento description: Status entrada: type: string description: Dados de entrada retorno: type: string description: Dados de retorno codigoExterno: type: string description: Código externo tentativas: type: integer format: int64 description: Número de tentativas default: 1 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 description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação