2.0info: 2.0.0 Expedição de documento de transporte description: Serviço de expedição de documento de transporte TMSX x-senior-domain: tmsx_exp x-senior-domain-path: tmsx_exp x-senior-service-path: documento_transporte contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/tmsx_expsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /documento_transporte/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/getDocumentosTransporteOrigem: post: description: API para buscar os documentos transporte de origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idDocumentoTransporte properties: idDocumentoTransporte: type: string description: Id do documento de transporte gerado offset: type: integer format: int64 description: Número da página default: 0 size: type: integer format: int64 description: Quantidade de registro página default: 10 responses: 200: description: Ok schema: type: object required: – content – totalPage – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recDocumentoTransporteOrigem minimum: 1 description: Lista dos documentos de transporte de origem totalPage: type: integer format: int64 description: Total de página totalElements: type: integer format: int64 description: Total de Elementos por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API para buscar os documentos transporte de origem tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idDocumentoTransporte description: Id do documento de transporte gerado in: query required: true type: string – name: offset description: Número da página in: query type: integer format: int64 – name: size description: Quantidade de registro página in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content – totalPage – totalElements properties: content: type: array items: type: object allOf: – #/definitions/recDocumentoTransporteOrigem minimum: 1 description: Lista dos documentos de transporte de origem totalPage: type: integer format: int64 description: Total de página totalElements: type: integer format: int64 description: Total de Elementos por página 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/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 /documento_transporte/queries/exportEspecie: 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 /documento_transporte/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 /documento_transporte/queries/exportPais: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportEstado: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportCidade: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportTipoDocumentoEmbarque: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportDocumentoEmbarque: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportDocumentoEmbarqueDadosTransporte: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportPessoa: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportPessoaCliente: 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 /documento_transporte/queries/exportPessoaEndereco: 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 /documento_transporte/queries/exportPessoaTransportadora: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/queries/exportModeloDocumentoTransporte: 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 /documento_transporte/queries/exportModeloDocumentoTransporteFilial: 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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/queries/exportClassificacaoOperacaoTransporte: 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 /documento_transporte/queries/exportClassificacaoOperacaoModeloDocumentoTransporte: 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 /documento_transporte/queries/exportDocumentoTransporte: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/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 /documento_transporte/queries/exportConhecimentoTransporte: 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 /documento_transporte/queries/exportConhecimentoTransporteEletronico: 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 /documento_transporte/queries/exportComponenteFrete: 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 /documento_transporte/queries/exportGatilhoComponenteFrete: 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 /documento_transporte/queries/exportDocumentoTransporteComponenteFrete: 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 /documento_transporte/queries/exportDocumentoTransporteComponenteFreteLog: 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 /documento_transporte/queries/exportRateio: 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 /documento_transporte/queries/exportRateioComponenteFrete: 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 /documento_transporte/queries/exportLoteDocumentoTransporte: 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 /documento_transporte/queries/exportConfiguracaoTipoDocumentoTransporte: 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 /documento_transporte/queries/exportOperacoes: 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 /documento_transporte/queries/exportServicos: 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 /documento_transporte/queries/exportTransacaoVinculada: 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 /documento_transporte/queries/exportEventoDocumentoTransporte: 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 /documento_transporte/queries/exportHistoricoDocumentoTransporte: 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 /documento_transporte/queries/exportHistoricoCalculo: 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 /documento_transporte/queries/exportTransacao: 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 /documento_transporte/queries/exportTransacaoFiscalSaida: 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 /documento_transporte/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 /documento_transporte/queries/exportFinalidadeCompraVenda: 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 /documento_transporte/queries/exportFilialFiscal: 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 /documento_transporte/queries/exportVariavel: 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 /documento_transporte/queries/exportVariavelEntidade: 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 /documento_transporte/queries/exportMensagemDocumentoFiscal: 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 /documento_transporte/queries/exportCamposDinamicosMensagem: 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 /documento_transporte/queries/exportBeneficioFiscal: 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 /documento_transporte/queries/exportE027str: 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 /documento_transporte/queries/exportE027eqi: 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 /documento_transporte/queries/exportClassificacaoTributaria: 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 /documento_transporte/queries/exportNaturezaReceitaPISCOFINS: 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 /documento_transporte/queries/exportE140imi: 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 /documento_transporte/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 /documento_transporte/actions/alterarDocumentoTransporte: post: description: API para alteração da cfop e natureza de operação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – documentoTransporte properties: documentoTransporte: type: string description: ID do documento transporte cfop: type: integer format: int64 description: Novo valor da cfop naturezaCarga: type: object allOf: – #/definitions/recEntidadeRelacionada description: Nova natureza de carga responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/integrarLoteDocumentoTransporte: post: description: Fachada Rateio Lote Documento Transporte tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – classificacaoOperacaoTransporte – filial – valorTotal – componentesFrete – impostos properties: documentosEmbarque: type: array items: type: object allOf: – #/definitions/recVariavel description: tags que referenciam os documentos de embarque cfop: type: integer format: int64 description: CFOP classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recChavesIdCodigo description: Classificação de Operação de Transporte filial: type: object allOf: – #/definitions/recChavesFilial description: Filial valorTotal: type: number format: double description: Valor Total componentesFrete: type: array items: type: object allOf: – #/definitions/recComponentesLoteFrete minimum: 1 description: Componentes de Frete impostos: type: object allOf: – #/definitions/recImpostos description: Valores dos impostos tags: type: array items: type: object allOf: – #/definitions/recTag description: tags que identificam o lote variaveis: type: array items: type: object allOf: – #/definitions/recVariavel description: variáveis que identificam o lote documentosTransporte: type: array items: type: object allOf: – #/definitions/recChavesDocumentoTransporte description: tags que referenciam os documentos de transporte observacoes: type: string description: Observações do documento responses: 200: description: Ok schema: type: object required: – loteDocumentoTransporte – documentoTransporte properties: loteDocumentoTransporte: type: object allOf: – #/definitions/recChavesIdCodigo description: Dados do lote criado documentoTransporte: type: object allOf: – #/definitions/recFacadeDocumentoTransporteOutput description: Dados do Documento de Transporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/reintegrarLoteDocumentoTransporte: post: description: Fachada Rateio Lote Documento Transporte tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idLote – classificacaoOperacaoTransporte – filial – valorTotal – componentesFrete – impostos properties: idLote: type: string description: Id do lote documentosEmbarque: type: array items: type: object allOf: – #/definitions/recVariavel description: tags que referenciam os documentos de embarque cfop: type: integer format: int64 description: CFOP classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recChavesIdCodigo description: Classificação de Operação de Transporte filial: type: object allOf: – #/definitions/recChavesFilial description: Filial valorTotal: type: number format: double description: Valor Total componentesFrete: type: array items: type: object allOf: – #/definitions/recComponentesLoteFrete minimum: 1 description: Componentes de Frete impostos: type: object allOf: – #/definitions/recImpostos description: Valores dos impostos tags: type: array items: type: object allOf: – #/definitions/recTag description: tags que identificam o lote variaveis: type: array items: type: object allOf: – #/definitions/recVariavel description: variáveis que identificam o lote documentosTransporte: type: array items: type: object allOf: – #/definitions/recChavesDocumentoTransporte description: tags que referenciam os documentos de transporte observacoes: type: string description: Observações do documento responses: 200: description: Ok schema: type: object required: – loteDocumentoTransporte – documentoTransporte properties: loteDocumentoTransporte: type: object allOf: – #/definitions/recChavesIdCodigo description: Dados do lote criado documentoTransporte: type: object allOf: – #/definitions/recFacadeDocumentoTransporteOutput description: Dados do Documento de Transporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/getPdfDocumento: post: description: API para impressão de DACTE tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – chaveDocumentoTransporte properties: chaveDocumentoTransporte: type: object allOf: – #/definitions/recChavesDocumentoTransporte description: Chave Documento Transporte responses: 200: description: Ok schema: type: object required: – arquivo properties: arquivo: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importarNFeXML: post: description: Action para importar XML da NFe tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nfeXml properties: nfeXml: type: string description: XML da NFe responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/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 /documento_transporte/actions/importEspecie: 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 /documento_transporte/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 /documento_transporte/actions/importPais: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importEstado: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importCidade: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importTipoDocumentoEmbarque: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importDocumentoEmbarque: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importDocumentoEmbarqueDadosTransporte: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importPessoa: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importPessoaCliente: 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 /documento_transporte/actions/importPessoaEndereco: 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 /documento_transporte/actions/importPessoaTransportadora: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/actions/importModeloDocumentoTransporte: 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 /documento_transporte/actions/importModeloDocumentoTransporteFilial: 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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/actions/importClassificacaoOperacaoTransporte: 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 /documento_transporte/actions/importClassificacaoOperacaoModeloDocumentoTransporte: 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 /documento_transporte/actions/importDocumentoTransporte: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/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 /documento_transporte/actions/importConhecimentoTransporte: 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 /documento_transporte/actions/importConhecimentoTransporteEletronico: 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 /documento_transporte/actions/importComponenteFrete: 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 /documento_transporte/actions/importGatilhoComponenteFrete: 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 /documento_transporte/actions/importDocumentoTransporteComponenteFrete: 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 /documento_transporte/actions/importDocumentoTransporteComponenteFreteLog: 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 /documento_transporte/actions/importRateio: 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 /documento_transporte/actions/importRateioComponenteFrete: 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 /documento_transporte/actions/importLoteDocumentoTransporte: 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 /documento_transporte/actions/importConfiguracaoTipoDocumentoTransporte: 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 /documento_transporte/actions/importOperacoes: 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 /documento_transporte/actions/importServicos: 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 /documento_transporte/actions/importTransacaoVinculada: 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 /documento_transporte/actions/importEventoDocumentoTransporte: 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 /documento_transporte/actions/importHistoricoDocumentoTransporte: 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 /documento_transporte/actions/importHistoricoCalculo: 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 /documento_transporte/actions/importTransacao: 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 /documento_transporte/actions/importTransacaoFiscalSaida: 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 /documento_transporte/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 /documento_transporte/actions/importFinalidadeCompraVenda: 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 /documento_transporte/actions/importFilialFiscal: 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 /documento_transporte/actions/importVariavel: 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 /documento_transporte/actions/importVariavelEntidade: 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 /documento_transporte/actions/importMensagemDocumentoFiscal: 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 /documento_transporte/actions/importCamposDinamicosMensagem: 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 /documento_transporte/actions/importBeneficioFiscal: 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 /documento_transporte/actions/importE027str: 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 /documento_transporte/actions/importE027eqi: 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 /documento_transporte/actions/importClassificacaoTributaria: 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 /documento_transporte/actions/importNaturezaReceitaPISCOFINS: 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 /documento_transporte/actions/importE140imi: 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 /documento_transporte/events/criacaoLote: post: description: Evento de sucesso da Criação do lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idLote properties: idLote: type: string description: Id da entidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/validacaoLote: post: description: Evento de sucesso da validação do lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idLote properties: idLote: type: string description: Id da entidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/calculoComponentesLote: post: description: Evento de erro do calculo do lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idLote – eventoPrevio properties: idLote: type: string description: Id da entidade eventoPrevio: type: string allOf: – #/definitions/enumEvento description: Evento Anterior a Etapa de Validação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/calculoImpostosLote: post: description: Evento de erro do calculo do lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idLote – eventoPrevio properties: idLote: type: string description: Id da entidade eventoPrevio: type: string allOf: – #/definitions/enumEvento description: Evento Anterior a Etapa de Validação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/eventDispatcher: post: description: Evento centralizador que distribui os eventos do Lote x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – idLote – evento – eventoSituacao properties: idLote: type: string description: Id da entidade evento: type: string allOf: – #/definitions/enumEvento description: Evento eventoSituacao: type: string allOf: – #/definitions/enumEventoSituacao description: Situação do Evento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/eventPersistObject: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importEspecieEvent: 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 /documento_transporte/events/exportEspecieEvent: 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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/events/importPaisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportPaisEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importEstadoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportEstadoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importCidadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportCidadeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importTipoDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportTipoDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportDocumentoEmbarqueEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importDocumentoEmbarqueDadosTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportDocumentoEmbarqueDadosTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importPessoaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportPessoaEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importPessoaClienteEvent: 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 /documento_transporte/events/exportPessoaClienteEvent: 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 /documento_transporte/events/importPessoaEnderecoEvent: 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 /documento_transporte/events/exportPessoaEnderecoEvent: 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 /documento_transporte/events/importPessoaTransportadoraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportPessoaTransportadoraEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/importModeloDocumentoTransporteEvent: 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 /documento_transporte/events/exportModeloDocumentoTransporteEvent: 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 /documento_transporte/events/importModeloDocumentoTransporteFilialEvent: 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 /documento_transporte/events/exportModeloDocumentoTransporteFilialEvent: 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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/events/importClassificacaoOperacaoTransporteEvent: 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 /documento_transporte/events/exportClassificacaoOperacaoTransporteEvent: 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 /documento_transporte/events/importClassificacaoOperacaoModeloDocumentoTransporteEvent: 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 /documento_transporte/events/exportClassificacaoOperacaoModeloDocumentoTransporteEvent: 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 /documento_transporte/events/importDocumentoTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/events/exportDocumentoTransporteEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /documento_transporte/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 /documento_transporte/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 /documento_transporte/events/importConhecimentoTransporteEvent: 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 /documento_transporte/events/exportConhecimentoTransporteEvent: 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 /documento_transporte/events/importConhecimentoTransporteEletronicoEvent: 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 /documento_transporte/events/exportConhecimentoTransporteEletronicoEvent: 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 /documento_transporte/events/importComponenteFreteEvent: 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 /documento_transporte/events/exportComponenteFreteEvent: 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 /documento_transporte/events/importGatilhoComponenteFreteEvent: 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 /documento_transporte/events/exportGatilhoComponenteFreteEvent: 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 /documento_transporte/events/importDocumentoTransporteComponenteFreteEvent: 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 /documento_transporte/events/exportDocumentoTransporteComponenteFreteEvent: 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 /documento_transporte/events/importDocumentoTransporteComponenteFreteLogEvent: 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 /documento_transporte/events/exportDocumentoTransporteComponenteFreteLogEvent: 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 /documento_transporte/events/importRateioEvent: 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 /documento_transporte/events/exportRateioEvent: 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 /documento_transporte/events/importRateioComponenteFreteEvent: 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 /documento_transporte/events/exportRateioComponenteFreteEvent: 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 /documento_transporte/events/importLoteDocumentoTransporteEvent: 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 /documento_transporte/events/exportLoteDocumentoTransporteEvent: 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 /documento_transporte/events/importConfiguracaoTipoDocumentoTransporteEvent: 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 /documento_transporte/events/exportConfiguracaoTipoDocumentoTransporteEvent: 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 /documento_transporte/events/importOperacoesEvent: 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 /documento_transporte/events/exportOperacoesEvent: 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 /documento_transporte/events/importServicosEvent: 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 /documento_transporte/events/exportServicosEvent: 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 /documento_transporte/events/importTransacaoVinculadaEvent: 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 /documento_transporte/events/exportTransacaoVinculadaEvent: 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 /documento_transporte/events/importEventoDocumentoTransporteEvent: 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 /documento_transporte/events/exportEventoDocumentoTransporteEvent: 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 /documento_transporte/events/importHistoricoDocumentoTransporteEvent: 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 /documento_transporte/events/exportHistoricoDocumentoTransporteEvent: 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 /documento_transporte/events/importHistoricoCalculoEvent: 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 /documento_transporte/events/exportHistoricoCalculoEvent: 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 /documento_transporte/events/importTransacaoEvent: 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 /documento_transporte/events/exportTransacaoEvent: 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 /documento_transporte/events/importTransacaoFiscalSaidaEvent: 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 /documento_transporte/events/exportTransacaoFiscalSaidaEvent: 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 /documento_transporte/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 /documento_transporte/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 /documento_transporte/events/importFinalidadeCompraVendaEvent: 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 /documento_transporte/events/exportFinalidadeCompraVendaEvent: 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 /documento_transporte/events/importFilialFiscalEvent: 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 /documento_transporte/events/exportFilialFiscalEvent: 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 /documento_transporte/events/importVariavelEvent: 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 /documento_transporte/events/exportVariavelEvent: 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 /documento_transporte/events/importVariavelEntidadeEvent: 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 /documento_transporte/events/exportVariavelEntidadeEvent: 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 /documento_transporte/events/importMensagemDocumentoFiscalEvent: 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 /documento_transporte/events/exportMensagemDocumentoFiscalEvent: 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 /documento_transporte/events/importCamposDinamicosMensagemEvent: 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 /documento_transporte/events/exportCamposDinamicosMensagemEvent: 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 /documento_transporte/events/importBeneficioFiscalEvent: 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 /documento_transporte/events/exportBeneficioFiscalEvent: 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 /documento_transporte/events/importE027strEvent: 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 /documento_transporte/events/exportE027strEvent: 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 /documento_transporte/events/importE027eqiEvent: 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 /documento_transporte/events/exportE027eqiEvent: 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 /documento_transporte/events/importClassificacaoTributariaEvent: 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 /documento_transporte/events/exportClassificacaoTributariaEvent: 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 /documento_transporte/events/importNaturezaReceitaPISCOFINSEvent: 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 /documento_transporte/events/exportNaturezaReceitaPISCOFINSEvent: 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 /documento_transporte/events/importE140imiEvent: 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 /documento_transporte/events/exportE140imiEvent: 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 /documento_transporte/apis/documentoEmbarque: post: description: Fachada Documento de Embarque tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/documentoEmbarqueFacadeInput responses: 200: description: Ok schema: #/definitions/documentoEmbarqueFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada Documento de Embarque tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentoEmbarqueFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/documentoEmbarque/{id}: get: description: Fachada Documento de Embarque tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentoEmbarqueFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Fachada Documento de Embarque tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/documentoEmbarqueFacadeInput responses: 200: description: Ok schema: #/definitions/documentoEmbarqueFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/modeloDocumentoTransporte: get: description: Fachada Modelo Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/modeloDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/modeloDocumentoTransporte/{id}: get: description: Fachada Modelo Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/modeloDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/filialSerie: post: description: Fachada Filial Série tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/filialSerieFacadeInput responses: 200: description: Ok schema: #/definitions/filialSerieFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada Filial Série tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/filialSerieFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/filialSerie/{id}: get: description: Fachada Filial Série tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/filialSerieFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada Filial Série tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/alteraVigenciaFilialSerie/{id}: put: description: Fachada de alteração de vigência para Filial Série tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/alteraVigenciaFilialSerieFacadeInput responses: 200: description: Ok schema: #/definitions/alteraVigenciaFilialSerieFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/documentoTransporte: get: description: Fachada documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/documentoTransporte/{id}: get: description: Fachada documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/rateioLoteDocumentoTransporte: post: description: Fachada Rateio Lote Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/rateioLoteDocumentoTransporteFacadeInput responses: 200: description: Ok schema: #/definitions/rateioLoteDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/rateioLoteDocumentoTransporte/{id}: get: description: Fachada Rateio Lote Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/rateioLoteDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada Rateio Lote Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/loteDocumentoTransporte/{id}: get: description: Fachada Lote Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/loteDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/conhecimentoTransporteEletronico: get: description: Fachada Conhecimento Transporte Eletrônico tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/conhecimentoTransporteEletronicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/conhecimentoTransporteEletronico/{id}: get: description: Fachada Conhecimento Transporte Eletrônico tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/conhecimentoTransporteEletronicoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/tipoDocumentoEmbarque: get: description: Tipo Documento Embarque tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/tipoDocumentoEmbarqueFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/tipoDocumentoEmbarque/{id}: get: description: Tipo Documento Embarque tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tipoDocumentoEmbarqueFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/classificacaoOperacaoTransporte: get: description: Classificação de Operação de Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/classificacaoOperacaoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/classificacaoOperacaoTransporte/{id}: get: description: Classificação de Operação de Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/classificacaoOperacaoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/componenteFrete: get: description: Componente Frete tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/componenteFreteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/componenteFrete/{id}: get: description: Componente Frete tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/componenteFreteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/componenteFreteImposto: get: description: Componente Frete Imposto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/componenteFreteImpostoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/componenteFreteImposto/{id}: get: description: Componente Frete Imposto tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/componenteFreteImpostoFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/gerarNumeracaoDocumentoTransportePorLote: post: description: Gerar Numeração Documento Transporte Por Lote tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/gerarNumeracaoDocumentoTransportePorLoteFacade responses: 200: description: Ok schema: #/definitions/gerarNumeracaoDocumentoTransportePorLoteFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/eventoDocumentoTransporte: get: description: Evento documento transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventoDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/eventoDocumentoTransporte/{id}: get: description: Evento documento transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventoDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/historicoDocumentoTransporte: get: description: Historico documento transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/historicoDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/historicoDocumentoTransporte/{id}: get: description: Historico documento transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/historicoDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/emitirDocumentoTransporte: post: description: Emitir Documento Transporte DFI tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/emitirDocumentoTransporteFacade responses: 200: description: Ok schema: #/definitions/emitirDocumentoTransporteFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/variavel: get: description: Fachada Variavel tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/variavelFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/componentesFreteDocumentoTransporte: get: description: Componentes de Frete do Documento de Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/componentesFreteDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/reprocessarLote: post: description: Reprocessar as etapas de criação ou emissão do documento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/reprocessarLoteFacade responses: 200: description: Ok schema: #/definitions/reprocessarLoteFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/cancelarDocumentoTransporte: post: description: Cancelar Documento Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/cancelarDocumentoTransporteFacade responses: 200: description: Ok schema: #/definitions/cancelarDocumentoTransporteFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/verificarAcoesLote/{id}: get: description: Verificar ações do lote tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/verificarAcoesLoteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/impostosDocumentoTransporte/{id}: get: description: Impostos do Documento de Transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/impostosDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/apis/informacoesComplementaresDocumentoTransporte/{id}: get: description: Fachada Informações complementares documento transporte tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/informacoesComplementaresDocumentoTransporteFacadeOutput 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/especie: 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/especie responses: 200: description: The created resource schema: #/definitions/especie 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/especie responses: 200: description: The created resource schema: #/definitions/especie 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/especie 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/especie/{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/editEspecie responses: 200: description: Ok schema: #/definitions/editEspecie 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/especie responses: 200: description: Ok schema: #/definitions/especie 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/especie 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 /documento_transporte/entities/especie/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/especie responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/naturezaCarga 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/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/editNaturezaCarga responses: 200: description: Ok schema: #/definitions/editNaturezaCarga 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 /documento_transporte/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 /documento_transporte/entities/estado: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/estado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoEmbarque: 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/documentoEmbarque responses: 200: description: The created resource schema: #/definitions/documentoEmbarque 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/documentoEmbarque responses: 200: description: The created resource schema: #/definitions/documentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentoEmbarque 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoEmbarque/{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/editDocumentoEmbarque responses: 200: description: Ok schema: #/definitions/editDocumentoEmbarque 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/documentoEmbarque responses: 200: description: Ok schema: #/definitions/documentoEmbarque 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/documentoEmbarque 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 /documento_transporte/entities/documentoEmbarque/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentoEmbarque responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoEmbarqueDadosTransporte: 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/documentoEmbarqueDadosTransporte responses: 200: description: The created resource schema: #/definitions/documentoEmbarqueDadosTransporte 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/documentoEmbarqueDadosTransporte responses: 200: description: The created resource schema: #/definitions/documentoEmbarqueDadosTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentoEmbarqueDadosTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoEmbarqueDadosTransporte/{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/editDocumentoEmbarqueDadosTransporte responses: 200: description: Ok schema: #/definitions/editDocumentoEmbarqueDadosTransporte 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/documentoEmbarqueDadosTransporte responses: 200: description: Ok schema: #/definitions/documentoEmbarqueDadosTransporte 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/documentoEmbarqueDadosTransporte 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 /documento_transporte/entities/documentoEmbarque/{parentId}/documentoEmbarqueDadosTransporte: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentoEmbarqueDadosTransporte responses: 200: description: The created resource schema: #/definitions/documentoEmbarqueDadosTransporte 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/documentoEmbarqueDadosTransporte responses: 200: description: The created resource schema: #/definitions/documentoEmbarqueDadosTransporte 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/documentoEmbarqueDadosTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoEmbarque/{parentId}/documentoEmbarqueDadosTransporte/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editDocumentoEmbarqueDadosTransporte responses: 200: description: Ok schema: #/definitions/editDocumentoEmbarqueDadosTransporte 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/documentoEmbarqueDadosTransporte responses: 200: description: Ok schema: #/definitions/documentoEmbarqueDadosTransporte 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/documentoEmbarqueDadosTransporte 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoEmbarqueDadosTransporte/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/documentoEmbarqueDadosTransporte responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/pessoa: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/filial: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/filial 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/empresa: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/empresa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/classificacaoOperacaoTransporte: 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/classificacaoOperacaoTransporte responses: 200: description: The created resource schema: #/definitions/classificacaoOperacaoTransporte 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/classificacaoOperacaoTransporte responses: 200: description: The created resource schema: #/definitions/classificacaoOperacaoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/classificacaoOperacaoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/classificacaoOperacaoTransporte/{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/editClassificacaoOperacaoTransporte responses: 200: description: Ok schema: #/definitions/editClassificacaoOperacaoTransporte 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/classificacaoOperacaoTransporte responses: 200: description: Ok schema: #/definitions/classificacaoOperacaoTransporte 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/classificacaoOperacaoTransporte 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 /documento_transporte/entities/classificacaoOperacaoTransporte/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/classificacaoOperacaoTransporte responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/classificacaoOperacaoModeloDocumentoTransporte: 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/classificacaoOperacaoModeloDocumentoTransporte responses: 200: description: The created resource schema: #/definitions/classificacaoOperacaoModeloDocumentoTransporte 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/classificacaoOperacaoModeloDocumentoTransporte responses: 200: description: The created resource schema: #/definitions/classificacaoOperacaoModeloDocumentoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/classificacaoOperacaoModeloDocumentoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/classificacaoOperacaoModeloDocumentoTransporte/{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/editClassificacaoOperacaoModeloDocumentoTransporte responses: 200: description: Ok schema: #/definitions/editClassificacaoOperacaoModeloDocumentoTransporte 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/classificacaoOperacaoModeloDocumentoTransporte responses: 200: description: Ok schema: #/definitions/classificacaoOperacaoModeloDocumentoTransporte 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/classificacaoOperacaoModeloDocumentoTransporte 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 /documento_transporte/entities/classificacaoOperacaoModeloDocumentoTransporte/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/classificacaoOperacaoModeloDocumentoTransporte responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoTransporte/{parentId}/notaFiscalServico: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – 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: parentId in: path required: true type: string – 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/notaFiscalServico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoTransporte/{parentId}/notaFiscalServico/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editNotaFiscalServico responses: 200: description: Ok schema: #/definitions/editNotaFiscalServico 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: parentId in: path required: true type: string – 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: parentId in: path required: true type: string – 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoTransporte/{parentId}/conhecimentoTransporte: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/conhecimentoTransporte responses: 200: description: The created resource schema: #/definitions/conhecimentoTransporte 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/conhecimentoTransporte responses: 200: description: The created resource schema: #/definitions/conhecimentoTransporte 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/conhecimentoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoTransporte/{parentId}/conhecimentoTransporte/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editConhecimentoTransporte responses: 200: description: Ok schema: #/definitions/editConhecimentoTransporte 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/conhecimentoTransporte responses: 200: description: Ok schema: #/definitions/conhecimentoTransporte 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/conhecimentoTransporte 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoTransporte/{parentId}/conhecimentoTransporteEletronico: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/conhecimentoTransporteEletronico responses: 200: description: The created resource schema: #/definitions/conhecimentoTransporteEletronico 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: parentId in: path required: true type: string – name: entity in: body required: true schema: type: object allOf: – #/definitions/conhecimentoTransporteEletronico responses: 200: description: The created resource schema: #/definitions/conhecimentoTransporteEletronico 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: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/conhecimentoTransporteEletronico 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/documentoTransporte/{parentId}/conhecimentoTransporteEletronico/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editConhecimentoTransporteEletronico responses: 200: description: Ok schema: #/definitions/editConhecimentoTransporteEletronico 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: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/conhecimentoTransporteEletronico responses: 200: description: Ok schema: #/definitions/conhecimentoTransporteEletronico 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/conhecimentoTransporteEletronico 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: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/configuracaoTipoDocumentoTransporte: 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/configuracaoTipoDocumentoTransporte responses: 200: description: The created resource schema: #/definitions/configuracaoTipoDocumentoTransporte 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/configuracaoTipoDocumentoTransporte responses: 200: description: The created resource schema: #/definitions/configuracaoTipoDocumentoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/configuracaoTipoDocumentoTransporte 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/configuracaoTipoDocumentoTransporte/{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/editConfiguracaoTipoDocumentoTransporte responses: 200: description: Ok schema: #/definitions/editConfiguracaoTipoDocumentoTransporte 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/configuracaoTipoDocumentoTransporte responses: 200: description: Ok schema: #/definitions/configuracaoTipoDocumentoTransporte 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/configuracaoTipoDocumentoTransporte 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 /documento_transporte/entities/configuracaoTipoDocumentoTransporte/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/configuracaoTipoDocumentoTransporte responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/transacaoVinculada: 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/transacaoVinculada responses: 200: description: The created resource schema: #/definitions/transacaoVinculada 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/transacaoVinculada responses: 200: description: The created resource schema: #/definitions/transacaoVinculada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/transacaoVinculada 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/transacaoVinculada/{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/editTransacaoVinculada responses: 200: description: Ok schema: #/definitions/editTransacaoVinculada 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/transacaoVinculada responses: 200: description: Ok schema: #/definitions/transacaoVinculada 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/transacaoVinculada 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 /documento_transporte/entities/transacaoVinculada/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/transacaoVinculada responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/transacao: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/transacao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/mensagemDocumentoFiscal: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/mensagemDocumentoFiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/camposDinamicosMensagem: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/camposDinamicosMensagem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/beneficioFiscal: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/beneficioFiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/beneficioFiscal/{id}: 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/beneficioFiscal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/e027eqi: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e027eqi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/e027eqi/{id}: 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/e027eqi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/classificacaoTributaria: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/classificacaoTributaria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/classificacaoTributaria/{id}: 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/classificacaoTributaria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/naturezaReceitaPISCOFINS: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/naturezaReceitaPISCOFINS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /documento_transporte/entities/naturezaReceitaPISCOFINS/{id}: 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/naturezaReceitaPISCOFINS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTipoMercado: type: string enum: – MERCADO_INTERNO – MERCADO_EXTERNO description: Tipo de mercado: * `MERCADO_INTERNO` – Interno (Nacional) * `MERCADO_EXTERNO` – Externo (Exterior) enumTipoPessoa: type: string enum: – PESSOA_JURIDICA – PESSOA_FISICA description: Tipo da pessoa: * `PESSOA_JURIDICA` – Pessoa Jurídica * `PESSOA_FISICA` – Pessoa Física enumEntidade: type: string enum: – DOCUMENTO_TRANSPORTE – DOCUMENTO_EMBARQUE description: Enum Entidade: * `DOCUMENTO_TRANSPORTE` – Documento Transporte * `DOCUMENTO_EMBARQUE` – Documento Embarque enumRotinaAplicacaoMensagem: type: string enum: – NOTA_FISCAL – CONTRATO – MENSAGEM_AVISO – OUTROS description: Rotina de aplicação da mensagem: * `NOTA_FISCAL` – Nota Fiscal (Mensagem Fiscal) * `CONTRATO` – Contrato (Mensagem Fiscal) * `MENSAGEM_AVISO` – Mensagem de Aviso em Tela * `OUTROS` – Outros enumEntidadeMensagemDinamica: type: string enum: – NOTA_FISCAL_ENTRADA – NOTA_FISCAL_SAIDA – ITEM_NOTA_FISCAL_ENTRADA – ITEM_NOTA_FISCAL_SAIDA description: Tipo da entidade da mensagem dinâmica: * `NOTA_FISCAL_ENTRADA` – Nota fiscal * `NOTA_FISCAL_SAIDA` – Nota fiscal * `ITEM_NOTA_FISCAL_ENTRADA` – Item da nota fiscal * `ITEM_NOTA_FISCAL_SAIDA` – Item da nota fiscal enumInteresseMensagem: type: string enum: – FISCO – CONTRIBUINTE – NENHUM – PRODUTO description: Aplicação: * `FISCO` – Fisco * `CONTRIBUINTE` – Contribuinte * `NENHUM` – Nenhum * `PRODUTO` – Produto enumOrigemProcessoAtoConcessorio: type: string enum: – SEFAZ – JUSTICA_FEDERAL – JUSTICA_ESTADUAL – SECEX_RFB – OUTROS description: Origem do processo ou ato concessório: * `SEFAZ` – Sefaz – V0 * `JUSTICA_FEDERAL` – Justiça Federal – V1 * `JUSTICA_ESTADUAL` – Justiça Estadual – V2 * `SECEX_RFB` – Secex/RFB – V3 * `OUTROS` – Outros – V9 enumAgrupadorDinamicoObservacao: type: string enum: – REFERENCIADO – PROPRIO – DEVOLUCAO – RECURSIVO – COBRANCA description: Agrupador dos campos para mensagens dinamicas com observação: * `REFERENCIADO` – Nota referenciada * `PROPRIO` – Próprio * `DEVOLUCAO` – Devolucao * `RECURSIVO` – Recursivo * `COBRANCA` – Cobrança enumSitRegErpx: type: string enum: – VA – VI description: Situação registro do ERPx: * `VA` – Ativo * `VI` – Inativo modeloDocumentoCarga: type: string enum: – NF – NFE – DECLARACAO – DUTOVIARIO – CFE_SAT – NFCE – OUTROS description: Enum Modelo documento de carga: * `NF` – Nota Fiscal * `NFE` – Nota Fiscal Eletrônica * `DECLARACAO` – Declaração * `DUTOVIARIO` – Dutoviário * `CFE_SAT` – Cupons Fiscais Eletrônicos SAT * `NFCE` – Nota Fiscal de Consumidor Eletrônica * `OUTROS` – Outros Documentos enumTipoPagador: type: string enum: – EMITENTE – DESTINATARIO – CONSIGNATARIO – TRANSPORTADOR description: Tipo do pagador: * `EMITENTE` – Emitente * `DESTINATARIO` – Destinatário * `CONSIGNATARIO` – Consignatário * `TRANSPORTADOR` – Transportador enumTipoOperacao: type: string enum: – OPERACAO_NORMAL – COMPLEMENTO_VALORES – SUBSTITUICAO description: Tipo Operação: * `OPERACAO_NORMAL` – Operação Normal * `COMPLEMENTO_VALORES` – Complemento Valores * `SUBSTITUICAO` – Substituição enumTipoOperacaoErpx: type: string enum: – VSAIDA – VENTRADA – VAMBOS description: Tipo de operação do ERPx: * `VSAIDA` – Saída * `VENTRADA` – Entrada * `VAMBOS` – Ambos enumTipoOrigemErpx: type: string enum: – USUARIO – SENIOR – PARCEIRO description: Tipo da origem da entidade do ERPx: * `USUARIO` – Usuário * `SENIOR` – Senior * `PARCEIRO` – Parceiro enumTipImpCstErpx: type: string enum: – PIS_COFINS – IPI – ICMS – ISS – CBS_IBS – IS description: Tipo de imposto documento do Erpx: * `PIS_COFINS` – PIS/COFINS * `IPI` – IPI * `ICMS` – ICMS * `ISS` – ISS * `CBS_IBS` – CBS/IBS Estadual e Municipal * `IS` – Imposto seletivo enumSituacaoErpx: type: string enum: – VATIVO – VINATIVO description: Situação do ERPx: * `VATIVO` – Ativo * `VINATIVO` – Inativo enumSituacaoClassificacaoTributariaErpx: type: string enum: – ATIVO – INATIVO description: Situação Classificação Tributária do ERPx: * `ATIVO` – Ativo * `INATIVO` – Inativo enumModalTransporte: type: string enum: – RODOVIARIO – AEREO – AQUAVIARIO – FERROVIARIO – DUTOVIARIO – MULTIMODAL description: Modal Transporte: * `RODOVIARIO` – Rodoviário * `AEREO` – Aéreo * `AQUAVIARIO` – Aquaviário * `FERROVIARIO` – Ferroviário * `DUTOVIARIO` – Dutoviário * `MULTIMODAL` – Multimodal enumTipoServico: type: string enum: – SERVICO_NORMAL – SUBCONTRATACAO – REDESPACHO – REDESPACHO_INTERMEDIARIO – SERVICO_VINCULADO_MULTIMODAL description: Tipo Serviço: * `SERVICO_NORMAL` – Normal * `SUBCONTRATACAO` – Subcontratação * `REDESPACHO` – Redespacho * `REDESPACHO_INTERMEDIARIO` – Redespacho intermediário * `SERVICO_VINCULADO_MULTIMODAL` – Serviço vinculado Multimodal enumTipoDocumentoFiscal: type: string enum: – CONHECIMENTO – NF_SERVICO description: Documento Fiscal: * `CONHECIMENTO` – Conhecimento * `NF_SERVICO` – Nota fiscal de serviço enumIntegracao: type: string enum: – ELETRONICA – ARQUIVO – SEM_INTEGRACAO description: Integração: * `ELETRONICA` – Eletrônica * `ARQUIVO` – Arquivo * `SEM_INTEGRACAO` – Sem integração enumGatilhoComponenteFrete: type: string enum: – ICMS – ISS description: Gatilho componente frete: * `ICMS` – ICMS * `ISS` – ISS enumGatilhoImposto: type: string enum: – ICMS – ISS description: Gatilho Imposto: * `ICMS` – ICMS * `ISS` – ISS enumOperacaoOrigemDestinoTransporte: type: string enum: – MUNICIPAL – ESTADUAL – INTERESTADUAL description: enum Operacao Origem Destino Transporte: * `MUNICIPAL` – O/D mesma cidade * `ESTADUAL` – O/D mesmo estado independente de cidade * `INTERESTADUAL` – O/D estados diferentes independente de cidade enumSituacaoDocumentoTransporte: type: string enum: – EM_DIGITACAO – AGUARDANDO_EMISSAO – PROCESSANDO_EMISSAO – ERRO_EMISSAO – REJEITADO – AUTORIZADO – ERRO_DIGITACAO – PROCESSANDO_CANCELAMENTO – CANCELADO description: Situação do documento de transporte: * `EM_DIGITACAO` – Em digitação * `AGUARDANDO_EMISSAO` – Aguardando a emissão * `PROCESSANDO_EMISSAO` – Processando a emissão * `ERRO_EMISSAO` – Erro na emissão * `REJEITADO` – Rejeitado * `AUTORIZADO` – Autorizado * `ERRO_DIGITACAO` – Erro Digitação * `PROCESSANDO_CANCELAMENTO` – Processando Cancelamento * `CANCELADO` – Cancelado enumTipoRamoAtividade: type: string enum: – INDUSTRIA – COMERCIO – DISTRIBUIDOR – TRANSPORTADOR_REVENDEDOR_RETALHISTA – EXTRACAO_MINERAL_OUTROS – INDUSTRIA_TRANSPORTE – PRODUTOR_RURAL – PRESTADOR_SERVICO – ATIVIDADE_FINANCEIRA – ATIVIDADE_IMOBILIARIA – COOPERATIVA – SOCIEDADE_SEGURADORES_PREVIDENCIA_COMPLEMENTAR – DISTRIBUIDOR_ENERGIA_ELETRICA – PRESTADOR_SERVICO_COMUNICACAO – OUTROS description: Tipo do ramo de atividade: * `INDUSTRIA` – Indústria * `COMERCIO` – Comércio * `DISTRIBUIDOR` – Distribuidor * `TRANSPORTADOR_REVENDEDOR_RETALHISTA` – Transportador-Revendedor-Retalhista (TRR) * `EXTRACAO_MINERAL_OUTROS` – Extração mineral/outros * `INDUSTRIA_TRANSPORTE` – Indústria/Transporte * `PRODUTOR_RURAL` – Produtor rural * `PRESTADOR_SERVICO` – Prestador de serviço * `ATIVIDADE_FINANCEIRA` – Atividade financeira * `ATIVIDADE_IMOBILIARIA` – Atividade imobiliária * `COOPERATIVA` – Cooperativa * `SOCIEDADE_SEGURADORES_PREVIDENCIA_COMPLEMENTAR` – Sociedades seguradoras de capitalização ou entidade aberta de previdência complementar * `DISTRIBUIDOR_ENERGIA_ELETRICA` – Distribuidor de energia elétrica * `PRESTADOR_SERVICO_COMUNICACAO` – Prestador de serviço de comunicação * `OUTROS` – Outros enumEvento: type: string enum: – CRIACAO_LOTE – VALIDACAO – CALCULO_COMPONENTE – CALCULO_IMPOSTO – EMISSAO – CANCELAMENTO_VALIDACAO – CANCELAMENTO – IMPRESSAO – DEFINICAO_CFOP description: Situação do Enum Evento: * `CRIACAO_LOTE` – Criação do Lote * `VALIDACAO` – Validação * `CALCULO_COMPONENTE` – Cálculo De Componente * `CALCULO_IMPOSTO` – Cálculo De Imposto * `EMISSAO` – Emissão * `CANCELAMENTO_VALIDACAO` – Cancelamento Validação * `CANCELAMENTO` – Cancelamento * `IMPRESSAO` – Impressão * `DEFINICAO_CFOP` – Definição CFOP enumEventoSituacao: type: string enum: – NAO_REALIZADO – PROCESSANDO – SUCESSO – ERRO – CANCELADO description: Situação do Enum Evento: * `NAO_REALIZADO` – Não Realizado * `PROCESSANDO` – Processando * `SUCESSO` – Sucesso * `ERRO` – Erro * `CANCELADO` – Cancelado enumTipoIcms: type: string enum: – ICMS00 – ICMS20 – ICMS45 – ICMS60 – ICMS90 – ICMSSN – ICMS_OUTRA_UF description: Tipo de ICMS: * `ICMS00` – ICMS00 * `ICMS20` – ICMS20 * `ICMS45` – ICMS45 * `ICMS60` – ICMS60 * `ICMS90` – ICMS90 * `ICMSSN` – ICMSSN * `ICMS_OUTRA_UF` – ICMS de outra UF enumTipoAmbiente: type: string enum: – PRODUCAO – HOMOLOGACAO description: Tipo de ambiente: * `PRODUCAO` – Produção * `HOMOLOGACAO` – Homologação enumCodRegimeTributario: type: string enum: – SIMPLES_NACIONAL – SIMPLES_NACIONAL_EXCESSO – REGIME_NORMAL description: Código do Regime Tributário: * `SIMPLES_NACIONAL` – Simples Nacional * `SIMPLES_NACIONAL_EXCESSO` – Simples Nacional – excesso de sublimite de receita bruta * `REGIME_NORMAL` – Regime Normal enumInformacoesCarga: type: string enum: – QUANTIDADE_VOLUMES – PESO_FISICO – PESO_CUBADO_CALCULADO – PESO_CUBADO_OPERACIONAL – FATOR_CUBAGEM – METROS_CUBICOS description: Informações da Carga: * `QUANTIDADE_VOLUMES` – Quantidade de Volumes * `PESO_FISICO` – Peso Físico * `PESO_CUBADO_CALCULADO` – Peso Cubado Calculado * `PESO_CUBADO_OPERACIONAL` – Peso Cubado Operacional * `FATOR_CUBAGEM` – Fator Cubagem * `METROS_CUBICOS` – Metros cubicos userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error recDocumentoTransporteOrigem: description: Record Documento de Transporte Origem type: object required: – dataEmissao – serie – numero – emitente – valorDocumento – modeloDocumentoTransporte properties: dataEmissao: type: string format: date-time description: Data Emissão serie: type: string maxLength: 3 description: Série numero: type: string maxLength: 255 description: Número emitente: type: string maxLength: 255 description: Nome do Remetente valorDocumento: type: number format: double description: Valor Total Mercadoria modeloDocumentoTransporte: type: string description: Modelo Documento Transporte recOrigemDestino: description: Dados de origem e destino type: object properties: cep: type: string maxLength: 20 description: CEP logradouro: type: string maxLength: 255 description: Logradouro endereço numero: type: string maxLength: 255 description: Numero endereço complemento: type: string maxLength: 255 description: Complemento endereço bairro: type: string maxLength: 255 description: Bairro complemento cidade: type: string maxLength: 255 description: Cidade complemento estado: type: string maxLength: 255 description: Estado complemento pais: type: string maxLength: 255 description: Pais complemento recOrigemDestinoDocumentoTransporte: description: Dados de origem e destino type: object properties: cep: type: string maxLength: 20 description: CEP logradouro: type: string maxLength: 255 description: Logradouro endereço numero: type: string maxLength: 255 description: Numero endereço complemento: type: string maxLength: 255 description: Complemento endereço bairro: type: string maxLength: 255 description: Bairro complemento cidade: type: object allOf: – #/definitions/recFacadeCidadeOutput description: Cidade complemento recOrigemDestinoInput: description: Dados de origem e destino Input type: object required: – cep properties: cep: type: string maxLength: 20 description: CEP logradouro: type: string maxLength: 255 description: Logradouro endereço bairro: type: string maxLength: 255 description: Bairro endereço numero: type: string maxLength: 255 description: Numero endereço default: 0 complemento: type: string maxLength: 255 description: Complemento endereço recFacadeEstadoOutput: description: Dados referente ao Estado type: object required: – codigo – nome – pais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/recFacadePaisOutput description: País excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadePessoaOutput: description: Dados da entidade pessoa type: object required: – id – codigo – nome – nomeFantasia – tipoPessoa – tipoMercado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código pessoa nome: type: string description: Nome pessoa nomeFantasia: type: string description: Nome fantasia pessoa tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa pessoaTransportadora: type: object allOf: – #/definitions/recPessoaTransportadora description: Transportadora cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumTipoRamoAtividade description: Tipo do ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro pais: type: object allOf: – #/definitions/pais description: Pais estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false emailsEletronicos: type: string description: Lista de emails para enviar quando CTe for emitido recFacadeTipoDocumentoEmbarqueOutput: description: Dados da entidade tipoDocumentoEmbarque type: object required: – id – codigo – abreviacao – descricao – modeloDocumentoCarga – exigeChaveAcesso properties: id: type: string description: Identificador único codigo: type: string maxLength: 255 description: Código abreviacao: type: string maxLength: 50 description: Abreviação descricao: type: string maxLength: 255 description: Descrição modeloDocumentoCarga: type: string allOf: – #/definitions/modeloDocumentoCarga description: Modelo documento carga chaveAcessoTamanho: type: integer format: int64 description: Chave acesso tamanho chaveAcessoExpressao: type: string description: Chave acesso expressão chaveAcessoGrupoEmitente: type: integer format: int64 description: Chave acesso grupo emitente chaveAcessoGrupoNumero: type: integer format: int64 description: Chave acesso grupo número chaveAcessoGrupoSerie: type: integer format: int64 description: Chave acesso grupo série chaveAcessoGrupoEmissao: type: integer format: int64 description: Chave acesso grupo emissão serieNumerica: type: boolean description: Série númerica default: true exigeChaveAcesso: type: boolean description: Exige chave acesso ativo: type: boolean description: Situação default: true padrao: type: boolean description: Padrão default: false recFacadeDocumentoEmbarqueDadosTransporteInput: description: Dados da entidade documentoEmbarqueDadosTransporte type: object required: – pagador – pagadorTipo – natureza properties: id: type: string description: Id da entidade pagador: type: object allOf: – #/definitions/recPessoa description: Pagador pagadorTipo: type: string allOf: – #/definitions/enumTipoPagador description: Tipo de pagador natureza: type: object allOf: – #/definitions/recNaturezaCarga description: Natureza da carga especie: type: object allOf: – #/definitions/recChavesIdCodigo description: Especie quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes pesoFisico: type: number format: double description: Peso físico pesoCubadoCalculado: type: number format: double description: Peso cubado calculado pesoCubadoOperacional: type: number format: double description: Peso cubado operacional fatorCubagem: type: number format: double description: Fator cubagem metrosCubicos: type: number format: double description: Metros cúbidos recFacadeDocumentoEmbarqueDadosTransporteOutput: description: Dados da entidade documentoEmbarqueDadosTransporte type: object required: – pagador – tipoPagador properties: id: type: string description: Id da entidade pagador: type: object allOf: – #/definitions/recFacadePessoaOutput description: Pagador tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo de pagador natureza: type: object allOf: – #/definitions/recFacadeNaturezaCargaOutput description: Natureza da carga especie: type: object allOf: – #/definitions/recFacadeEspecieOutput description: Especie quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes pesoFisico: type: number format: double description: Peso físico pesoCubadoCalculado: type: number format: double description: Peso cubado calculado pesoCubadoOperacional: type: number format: double description: Peso cubado operacional fatorCubagem: type: number format: double description: Fator cubagem metrosCubicos: type: number format: double description: Metros cúbidos createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeNaturezaCargaOutput: description: Dados da entidade naturezaCarga type: object required: – codigo – descricao – abreviacao – detalhes properties: id: type: string description: Identificador único codigo: type: integer format: int64 description: Código ncm: type: string maxLength: 255 description: Nomenclatura Comum do Mercosul descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 20 description: Abreviação detalhes: type: string maxLength: 500 description: Detalhes especie: type: object allOf: – #/definitions/especie description: Espécie ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false recFacadeEspecieOutput: description: Dados da entidade especie type: object required: – codigo – descricao – abreviacao properties: id: type: string description: Identificador único codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 20 description: Abreviação ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false recFacadeClassificacaoOperacaoTransporteInput: description: Dados Classificação Operação Transporte type: object required: – codigo – descricao – abreviacao – tipoOperacao – modalTransporte – tipoServico – servicoPrestado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da classificação operação transporte descricao: type: string maxLength: 255 description: Descrição da classificação operação transporte abreviacao: type: string maxLength: 15 description: Abreviação da classificação operação transporte tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo operação modalTransporte: type: string allOf: – #/definitions/enumModalTransporte description: Modal transporte tipoServico: type: string allOf: – #/definitions/enumTipoServico description: Tipo serviço servicoPrestado: type: object allOf: – #/definitions/servicos description: Serviço prestado recFacadeClassificacaoOperacaoTransporteOutput: description: Dados Classificação Operação Transporte type: object required: – codigo – descricao – abreviacao – tipoOperacao – modalTransporte – tipoServico – servicoPrestado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da classificação operação transporte descricao: type: string maxLength: 255 description: Descrição da classificação operação transporte abreviacao: type: string maxLength: 15 description: Abreviação da classificação operação transporte tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo operação modalTransporte: type: string allOf: – #/definitions/enumModalTransporte description: Modal transporte tipoServico: type: string allOf: – #/definitions/enumTipoServico description: Tipo serviço servicoPrestado: type: object allOf: – #/definitions/recFacadeServicosOutput description: Serviço prestado recChavesFilial: description: Record com id, código e cnpj da entidade filial type: object properties: id: type: string description: Identificador único codigo: type: integer format: int64 description: Código da filial numeroCgc: type: string description: CNPJ empresa: type: object allOf: – #/definitions/recChavesIdCodigo description: Empresa recComponentesLoteFrete: description: type: object required: – componente – valor properties: componente: type: object allOf: – #/definitions/recComponenteFrete description: Componente valor: type: number format: double description: Valor do componente recComponenteFrete: description: Entidade de componente de frete type: object properties: id: type: string description: Id da entidade nome: type: string description: Nome abreviacao: type: string description: Abreviação – Identificador único descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true recImpostos: description: type: object properties: icms: type: object allOf: – #/definitions/recICMS description: recICMS: description: Entidade Conhecimento De Transporte Eletrônico type: object properties: icmsValor: type: number format: double description: ICMS icmsValorBaseCalculo: type: number format: double description: ICMS Base Cálculo icmsPercentual: type: number format: double description: ICMS Alíquota Cálculo icmsPercentualDestino: type: number format: double description: ICMS Alíqutota Destino icmsPercentualInterestadual: type: number format: double description: ICMS Percentual Interestadual Destino icmsValorCreditoPresumido: type: number format: double description: ICMS Crédito Pesumido icmsTipo: type: string allOf: – #/definitions/enumTipoIcms description: ICMS Tipo cst: type: string maxLength: 4 description: CST reducaoBasePercentual: type: number format: double description: Redução Base Percentual icmsPercentualFcpDestino: type: number format: double description: FCP Alíquota icmsValorBaseCalculoDestino: type: number format: double description: ICMS Valor Base Calculo Destino icmsValorUfOrigem: type: number format: double description: ICMS Valor UF Origem icmsValorFcpDestino: type: number format: double description: ICMS Valor FCP Destino icmsValorUfDestino: type: number format: double description: ICMS Valor UF Destino recChavesDocumentoTransporte: description: Record com chaves para consulta de documento de transporte type: object properties: id: type: string description: id chaveAcesso: type: string description: chave de acesso tag: type: object allOf: – #/definitions/recTag description: Busca por tag variavel: type: object allOf: – #/definitions/recVariavel description: Busca por variável checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recFacadePaisOutput: description: Dados referente ao País type: object required: – codigo – codigoIso – nome – mercosul properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeCidadeOutput: description: Dados referente a Cidade type: object required: – codigo – nome – estado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/recFacadeEstadoOutput description: Estado codigoIbge: type: integer format: int64 description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeEmpresaOutput: description: Dados referente a Empresa type: object required: – codigo – nome – sigla – pais properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa sigla: type: string description: Nome fantasia da empresa pais: type: object allOf: – #/definitions/recFacadePaisOutput description: País excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeModeloDocumentoTransporteOutput: description: Dados do modelo documento transporte type: object required: – id – codigo – descricao – abreviacao – tipoDocumentoFiscal – integracao properties: id: type: string description: Id codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 15 description: Abreviação tipoDocumentoFiscal: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: Tipo do documento fiscal integracao: type: string allOf: – #/definitions/enumIntegracao description: Integração ativo: type: boolean description: Status default: true createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação recFacadeFilialOutput: description: Dados da Filial type: object required: – empresa – codigo – nome – sigla properties: id: type: string description: Id da entidade empresa: type: object allOf: – #/definitions/recFacadeEmpresaOutput description: Empresa codigo: type: integer format: int64 description: Filial nome: type: string description: Nome sigla: type: string description: Fantasia numeroCgc: type: string description: CPF/CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro estado: type: object allOf: – #/definitions/recFacadeEstadoOutput description: Estado cidade: type: object allOf: – #/definitions/recFacadeCidadeOutput description: Cidade telefone: type: string description: Telefone matriz: type: boolean description: Filial matriz createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação filialComoPessoa: type: object allOf: – #/definitions/recFacadePessoaOutput description: Filial com pessoa recFacadeLoteDocumentoTransporteOutput: description: Dados de Lote Documento Transporte type: object required: – numeroLote properties: id: type: string description: Id numeroLote: type: integer format: int64 description: Número rateio: type: object allOf: – #/definitions/recFacadeRateioOutput description: Id da entidade Rateio quantidadeDocumentosTransporte: type: integer format: int64 description: Quantidade de documentos de transportes criados valorTotalFrete: type: number format: double description: Valor total do frete valorTotalMercadoria: type: number format: double description: Valor total das mercadorias recFacadeRateioOutput: description: Dados de Rateio type: object required: – valor properties: id: type: string description: Id valor: type: number format: double description: Valor Rateio recFacadeRateioInput: description: Dados de fachada do Rateio Input type: object required: – componentesFrete properties: valorTotal: type: number format: double description: Valor Total componentesFrete: type: array items: type: object allOf: – #/definitions/recFacadeRateioComponentesInput minimum: 1 description: Dados de fachada do Rateio Componentes Frete Input componentesImposto: type: array items: type: object allOf: – #/definitions/recEntidadeRelacionada description: Componentes Imposto impostoEmbutido: type: boolean description: Valor imposto embutido default: true recFacadeRateioComponentesInput: description: Dados de fachada Rateio Componentes Input type: object required: – componente properties: componente: type: object allOf: – #/definitions/recEntidadeRelacionada description: Componente valorPercentual: type: number format: double description: Valor percentual recFacadeDocumentoTransporteOutput: description: Dados documento Transporte type: object required: – numeroInterno – serie – modeloDocumentoTransporte – observacao properties: id: type: string description: Id da entidade numeroInterno: type: string maxLength: 255 description: Número interno serie: type: string maxLength: 3 description: Série filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial naturezaCarga: type: object allOf: – #/definitions/recFacadeNaturezaCargaOutput description: Natureza Carga especie: type: object allOf: – #/definitions/recFacadeEspecieOutput description: Espécie remetente: type: object allOf: – #/definitions/recFacadePessoaOutput description: Rementente destinatario: type: object allOf: – #/definitions/recFacadePessoaOutput description: Destinatário expedidor: type: object allOf: – #/definitions/recFacadePessoaOutput description: Expedidor recebedor: type: object allOf: – #/definitions/recFacadePessoaOutput description: Recebedor pagador: type: object allOf: – #/definitions/recFacadePessoaOutput description: Pagador classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recFacadeClassificacaoOperacaoTransporteOutput description: Classificação operação transporte tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo Pagador origem: type: object allOf: – #/definitions/recOrigemDestinoDocumentoTransporte description: Origem destino: type: object allOf: – #/definitions/recOrigemDestinoDocumentoTransporte description: Destino modeloDocumentoTransporte: type: object allOf: – #/definitions/recFacadeModeloDocumentoTransporteOutput description: Modelo Documento Transporte dataEmissao: type: string format: date-time description: Data Emissão chave: type: string maxLength: 255 description: Chave quantidadeVolumes: type: integer format: int64 description: Quantidade Volume pesoFisico: type: number format: double description: Peso Físico pesoCubadoCalculado: type: number format: double description: Peso Cubado Calculado pesoCubadoOperacional: type: number format: double description: Peso Cubado Operacional fatorCubagem: type: number format: double description: Fator Cubagem metrosCubicos: type: number format: double description: Metros Cúbicos valorTotal: type: number format: double description: Valor Total valorTotalMercadoria: type: number format: double description: Valor Total da Mercadoria valorLiquido: type: number format: double description: Valor Líquido observacao: type: string maxLength: 255 description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data Previsão Entrega lote: type: object allOf: – #/definitions/recFacadeLoteDocumentoTransporteOutput description: Lote motivoCancelamento: type: string description: Motivo Cancelamento dataCancelamento: type: string format: date-time description: Data Cancelamento recFacadeServicosOutput: description: Dados referente aos Serviços type: object required: – id – codigo properties: id: type: string description: Id da entidade codigo: type: string description: Código excluido: type: boolean description: Indica se o registro foi excluído default: false recEntidadeRelacionada: description: Record genérico com id da entidade relacionada type: object required: – id properties: id: type: string description: Identificador único recFacadeComponenteFreteOutput: description: type: object required: – nome – abreviacao – descricao properties: id: type: string description: Id da entidade nome: type: string maxLength: 255 description: Nome abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true recFacadeOperacoesOutput: description: Dados referentes às Operações type: object properties: id: type: string description: Id da entidade codigo: type: string maxLength: 5 description: Código saida: type: string maxLength: 512 description: Saída excluido: type: boolean description: Indica se o registro foi excluído default: false recPessoa: description: type: object properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código pessoa nome: type: string description: Nome pessoa nomeFantasia: type: string description: Nome fantasia pessoa tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa pessoaTransportadora: type: object allOf: – #/definitions/recPessoaTransportadora description: Transportadora cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumTipoRamoAtividade description: Tipo do ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro pais: type: object allOf: – #/definitions/recPais description: Pais estado: type: object allOf: – #/definitions/recEstado description: Estado cidade: type: object allOf: – #/definitions/recCidade description: Cidade email: type: string description: Email ativo: type: boolean description: Situação default: true emailsEletronicos: type: string description: Lista de emails para enviar quando CTe for emitido recPessoaTransportadora: description: type: object properties: id: type: string description: Id da entidade rntrc: type: string maxLength: 14 description: Registro nacional de transportadores rodoviários de carga – RNTRC numeroRegistroAdministracaoEstadual: type: string maxLength: 25 description: Número de registro adquirido junto a administração estadual ativo: type: boolean description: Situação da transportadora default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração recPais: description: Dados referente ao País type: object properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul recEstado: description: Dados referente ao Estado type: object properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome recCidade: description: Dados referente a Cidade type: object properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade codigoIbge: type: integer format: int64 description: Código IBGE município recTag: description: Dados referente a Tag type: object required: – nome – valor properties: nome: type: string description: Chave da tag valor: type: string description: Valor da tag recTagEntidade: description: type: object required: – id – tag – idEntidade – valor – entidade properties: id: type: string description: Id da entidade tag: type: object allOf: – #/definitions/recTag description: Entidade tag idEntidade: type: string description: Código identidade Entidade valor: type: string description: Valor tag entidade: type: string allOf: – #/definitions/enumEntidade description: Enum Entidade recVariavel: description: Dados referente a Variável type: object required: – nome – valor properties: nome: type: string description: Chave da variável valor: type: string description: Valor da variável recVariavelEntidade: description: Dados referente a entidade variável type: object required: – id – variavel – idEntidade – valor – entidade properties: id: type: string description: Id da entidade variavel: type: object allOf: – #/definitions/recVariavel description: Entidade variável idEntidade: type: string description: Código identidade Entidade valor: type: string description: Valor variável entidade: type: string allOf: – #/definitions/enumEntidade description: Enum Entidade recChavesIdCodigoString: description: Record com id e código da entidade Tipo de Documento type: object properties: id: type: string description: Identificador único codigo: type: string description: Tipo Documento recChavesIdCodigo: description: Record genérico com id e código da entidade relacionada type: object properties: id: type: string description: Identificador único codigo: type: integer format: int64 description: Código da entidade recNaturezaCarga: description: type: object properties: id: type: string description: Identificador único codigo: type: integer format: int64 description: Código da entidade descricao: type: string maxLength: 255 description: Descrição ncm: type: string maxLength: 255 description: NCM abreviacao: type: string maxLength: 15 description: Abreviação detalhes: type: string maxLength: 500 description: Detalhes especie: type: object allOf: – #/definitions/recChavesIdCodigo description: Espécie especie: description: Espécie type: object required: – codigo – descricao – abreviacao properties: id: type: string format: uuid description: Identificador único codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 15 description: Abreviação ativo: type: boolean description: Situação default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editEspecie: type: object required: – id allOf: – #/definitions/especie naturezaCarga: description: Natureza de Carga type: object required: – codigo – descricao – abreviacao – detalhes properties: id: type: string format: uuid description: Identificador único codigo: type: integer format: int64 description: Código ncm: type: string maxLength: 255 description: Nomenclatura Comum do Mercosul descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 15 description: Abreviação detalhes: type: string maxLength: 500 description: Detalhes especie: type: object allOf: – #/definitions/especie description: Espécie ativo: type: boolean description: Situação default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNaturezaCarga: type: object required: – id allOf: – #/definitions/naturezaCarga pais: description: País type: object required: – codigo – codigoIso – nome – mercosul properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código codigoIso: type: string description: Código ISO do país nome: type: string description: Nome codigoMoeda: type: string description: Código moeda mercosul: type: boolean description: Mercosul excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: estado: description: Estado type: object required: – codigo – nome – pais properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código sigla: type: string description: Sigla nome: type: string description: Nome pais: type: object allOf: – #/definitions/pais description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: cidade: description: Cidade type: object required: – codigo – nome – estado properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código cidade nome: type: string description: Nome cidade estado: type: object allOf: – #/definitions/estado description: Estado codigoIbge: type: integer format: int64 description: Código IBGE município excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tipoDocumentoEmbarque: description: Tipo Documento Embarque type: object required: – codigo – abreviacao – descricao – modeloDocumentoCarga – exigeChaveAcesso properties: id: type: string format: uuid description: Identificador único codigo: type: string maxLength: 255 description: Código abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string maxLength: 255 description: Descrição modeloDocumentoCarga: type: string allOf: – #/definitions/modeloDocumentoCarga description: Modelo documento carga chaveAcessoTamanho: type: integer format: int64 description: Chave acesso tamanho chaveAcessoExpressao: type: string description: Chave acesso expressão chaveAcessoGrupoEmitente: type: integer format: int64 description: Chave acesso grupo emitente chaveAcessoGrupoNumero: type: integer format: int64 description: Chave acesso grupo número chaveAcessoGrupoSerie: type: integer format: int64 description: Chave acesso grupo série chaveAcessoGrupoEmissao: type: integer format: int64 description: Chave acesso grupo emissão serieNumerica: type: boolean description: Série númerica default: true exigeChaveAcesso: type: boolean description: Exige chave acesso ativo: type: boolean description: Situação default: true padrao: type: boolean description: Padrão default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoEmbarque: description: Documentos de embarque type: object required: – numero – serie – emitente – tipo – documentoEmbarqueDadosTransporte – valorDocumento properties: id: type: string format: uuid description: Id da entidade numero: type: string description: Numero serie: type: string maxLength: 3 description: Série emitente: type: object allOf: – #/definitions/pessoa description: Emitente tipo: type: object allOf: – #/definitions/tipoDocumentoEmbarque description: Tipo do documento destinatario: type: object allOf: – #/definitions/pessoa description: Destinatário origemCep: type: string maxLength: 20 description: Cep origem origemLogradouro: type: string description: Logradouro endereço origem origemNumero: type: string maxLength: 255 description: Numero endereço origem origemComplemento: type: string description: Complemento endereço origem origemBairro: type: string description: Bairro complemento origem origemCidade: type: string description: Cidade complemento origem origemEstado: type: string description: Estado complemento origem documentoEmbarqueDadosTransporte: type: object allOf: – #/definitions/documentoEmbarqueDadosTransporte description: Dados do transporte origemPais: type: string description: Pais complemento origem destinoCep: type: string maxLength: 20 description: Cel destino destinoLogradouro: type: string description: Logradouro endereço destino destinoNumero: type: string maxLength: 255 description: Numero endereço destino destinoComplemento: type: string description: Complemento endereço destino destinoBairro: type: string description: Bairro endereço destino destinoCidade: type: string description: Cidade endereço destino destinoEstado: type: string description: Estado endereço destino destinoPais: type: string description: Pais endereço destino dataEmissao: type: string format: date-time description: Data de emissão chave: type: string description: Chave valorDocumento: type: number format: double description: Valor documento observacao: type: string maxLength: 2000 description: Observação documentoTransporte: type: array items: type: object allOf: – #/definitions/documentoTransporte description: Documento de Transporte createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentoEmbarque: type: object required: – id allOf: – #/definitions/documentoEmbarque documentoEmbarqueDadosTransporte: description: Dados do transporte type: object required: – pagador – tipoPagador properties: id: type: string format: uuid description: Id da entidade documentoEmbarque: type: object allOf: – #/definitions/documentoEmbarque description: Documento de embarque pagador: type: object allOf: – #/definitions/pessoa description: Pagador tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo de pagador natureza: type: object allOf: – #/definitions/naturezaCarga description: Natureza da carga especie: type: object allOf: – #/definitions/especie description: Especie quantidadeVolumes: type: integer format: int64 description: Quantidade de volumes pesoFisico: type: number format: double description: Peso físico pesoCubadoCalculado: type: number format: double description: Peso cubado calculado pesoCubadoOperacional: type: number format: double description: Peso cubado operacional fatorCubagem: type: number format: double description: Fator cubagem metrosCubicos: type: number format: double description: Metros cúbidos createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editDocumentoEmbarqueDadosTransporte: type: object required: – id allOf: – #/definitions/documentoEmbarqueDadosTransporte pessoa: description: Entidade pessoa type: object required: – codigo – nome – nomeFantasia – tipoPessoa – tipoMercado properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código pessoa nome: type: string description: Nome pessoa nomeFantasia: type: string description: Nome fantasia pessoa tipoPessoa: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de pessoa pessoaTransportadora: type: object allOf: – #/definitions/pessoaTransportadora description: Transportadora cnpjCpf: type: string description: CNPJ/CPF inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal tipoMercado: type: string allOf: – #/definitions/enumTipoMercado description: Tipo de mercado do cliente tipoRamoAtividade: type: string allOf: – #/definitions/enumTipoRamoAtividade description: Tipo do ramo de atividade cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro pais: type: object allOf: – #/definitions/pais description: Pais estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração emailsEletronicos: type: string description: Lista de emails para enviar quando CTe for emitido createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaCliente: description: Cliente type: object properties: id: type: string format: uuid description: Id da entidade ativo: type: boolean description: Situação do cliente default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaEndereco: description: Endereço da pessoa type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa aceitaEntrega: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true aceitaCobranca: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false aceitaColeta: type: boolean description: Indica se o endereço é utilizado para coleta default: false cepCodigo: type: string maxLength: 20 description: Código Postal endereco: type: string maxLength: 100 description: Endereço enderecoNumero: type: string maxLength: 60 description: Número enderecoComplemento: type: string maxLength: 200 description: Complemento bairro: type: string maxLength: 75 description: Bairro enderecoPontoReferencia: type: string maxLength: 200 description: Ponto de referência pais: type: object allOf: – #/definitions/pais description: Pais estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade ativo: type: boolean description: Situação default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pessoaTransportadora: description: Transportadora type: object properties: id: type: string format: uuid description: Id da entidade pessoa: type: object allOf: – #/definitions/pessoa description: Pessoa rntrc: type: string maxLength: 14 description: Registro nacional de transportadores rodoviários de carga – RNTRC numeroRegistroAdministracaoEstadual: type: string maxLength: 25 description: Número de registro adquirido junto a administração estadual ativo: type: boolean description: Situação da transportadora default: true excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: modeloDocumentoTransporte: description: Entidade modelo documento Transporte type: object required: – codigo – descricao – abreviacao – tipoDocumentoFiscal – integracao properties: id: type: string format: uuid description: Id codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 15 description: Abreviação tipoDocumentoFiscal: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: Tipo do documento fiscal integracao: type: string allOf: – #/definitions/enumIntegracao description: Integração ativo: type: boolean description: Status default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: modeloDocumentoTransporteFilial: description: Entidade modelo documento transporte filial type: object required: – modeloDocumentoTransporte – filial – serie – dataInicio – dataFim properties: id: type: string format: uuid description: Id modeloDocumentoTransporte: type: object allOf: – #/definitions/modeloDocumentoTransporte description: Modelo do documento de transporte filial: type: object allOf: – #/definitions/filial description: Filial serie: type: string maxLength: 3 description: Série ultimaNumeracao: type: integer format: int64 description: Última numeração default: 0 dataInicio: type: string format: date description: Data de inicio dataFim: type: string format: date description: Data de finalização createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filial: description: Entidade filial type: object required: – empresa – codigo – nome – sigla properties: id: type: string format: uuid description: Id da entidade empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: integer format: int64 description: Filial nome: type: string description: Nome sigla: type: string description: Fantasia numeroCgc: type: string description: CPF/CNPJ inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal cepCodigo: type: string description: Código Postal endereco: type: string description: Endereço enderecoNumero: type: string description: Número enderecoComplemento: type: string description: Complemento bairro: type: string description: Bairro estado: type: object allOf: – #/definitions/estado description: Estado cidade: type: object allOf: – #/definitions/cidade description: Cidade telefone: type: string description: Telefone matriz: type: boolean description: Filial matriz excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração filialComoPessoa: type: object allOf: – #/definitions/pessoa description: Filial como pessoa 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: – codigo – nome – sigla properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código da empresa nome: type: string description: Nome da empresa sigla: type: string description: Nome fantasia da empresa pais: type: object allOf: – #/definitions/pais description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: classificacaoOperacaoTransporte: description: Entidade Classificação Operação Transporte type: object required: – codigo – descricao – abreviacao – tipoOperacao – modalTransporte – tipoServico properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código da classificação operação transporte descricao: type: string maxLength: 255 description: Descrição da classificação operação transporte abreviacao: type: string maxLength: 15 description: Abreviação da classificação operação transporte tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo operação modalTransporte: type: string allOf: – #/definitions/enumModalTransporte description: Modal transporte tipoServico: type: string allOf: – #/definitions/enumTipoServico description: Tipo serviço servicoPrestado: type: object allOf: – #/definitions/servicos description: Serviço prestado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editClassificacaoOperacaoTransporte: type: object required: – id allOf: – #/definitions/classificacaoOperacaoTransporte classificacaoOperacaoModeloDocumentoTransporte: description: Entidade Classificação Operação Modelo Documento Transporte type: object properties: id: type: string format: uuid description: Id da entidade classificacaoOperacaoTransporte: type: object allOf: – #/definitions/classificacaoOperacaoTransporte description: Classificação operação transporte modeloDocumentoTransporte: type: object allOf: – #/definitions/modeloDocumentoTransporte description: Modelo documento transporte createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editClassificacaoOperacaoModeloDocumentoTransporte: type: object required: – id allOf: – #/definitions/classificacaoOperacaoModeloDocumentoTransporte documentoTransporte: description: Entidade documento Transporte type: object required: – numero – serie – situacao – modeloDocumentoTransporte – observacao properties: id: type: string format: uuid description: Id da entidade numeroInterno: type: integer format: int64 description: Número interno numero: type: string maxLength: 255 description: Número serie: type: string maxLength: 3 description: Série situacao: type: string allOf: – #/definitions/enumSituacaoDocumentoTransporte description: Situação filial: type: object allOf: – #/definitions/filial description: Filial naturezaCarga: type: object allOf: – #/definitions/naturezaCarga description: Natureza Carga especie: type: object allOf: – #/definitions/especie description: Espécie remetente: type: object allOf: – #/definitions/pessoa description: Rementente destinatario: type: object allOf: – #/definitions/pessoa description: Destinatário expedidor: type: object allOf: – #/definitions/pessoa description: Expedidor recebedor: type: object allOf: – #/definitions/pessoa description: Recebedor pagador: type: object allOf: – #/definitions/pessoa description: Pagador classificacaoOperacaoTransporte: type: object allOf: – #/definitions/classificacaoOperacaoTransporte description: Classificação operação transporte tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo Pagador origemCep: type: string maxLength: 20 description: Cep origemLogradouro: type: string maxLength: 255 description: Logradouro origemNumero: type: string maxLength: 255 description: Número origemComplemento: type: string maxLength: 255 description: Complemento origemBairro: type: string maxLength: 255 description: Bairro destinoCep: type: string maxLength: 20 description: Cep Destino destinoLogradouro: type: string maxLength: 255 description: Logradouro Destino destinoNumero: type: string maxLength: 255 description: Número Destino destinoComplemento: type: string maxLength: 255 description: Complemento Destino destinoBairro: type: string maxLength: 255 description: Bairro Destino modeloDocumentoTransporte: type: object allOf: – #/definitions/modeloDocumentoTransporte description: Modelo Documento Transporte conhecimentoTransporte: type: object allOf: – #/definitions/conhecimentoTransporte description: Conhecimento de Transporte conhecimentoTransporteEletronico: type: object allOf: – #/definitions/conhecimentoTransporteEletronico description: Conhecimento Transporte eletrônico dataEmissao: type: string format: date-time description: Data Emissão chave: type: string maxLength: 255 description: Chave quantidadeVolumes: type: integer format: int64 description: Quantidade Volume pesoFisico: type: number format: double description: Peso Físico pesoCubadoCalculado: type: number format: double description: Peso Cubado Calculado pesoCubadoOperacional: type: number format: double description: Peso Cubado Operacional fatorCubagem: type: number format: double description: Fator Cubagem metrosCubicos: type: number format: double description: Metros Cúbicos valorTotal: type: number format: double description: Valor Total valorTotalMercadoria: type: number format: double description: Valor Total da Mercadoria valorLiquido: type: number format: double description: Valor Líquido observacao: type: string maxLength: 255 description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data Previsão Entrega notaFiscalServico: type: object allOf: – #/definitions/notaFiscalServico description: Nota fiscal de serviço lote: type: object allOf: – #/definitions/loteDocumentoTransporte description: Lote origemCidade: type: object allOf: – #/definitions/cidade description: Cidade complemento origem destinoCidade: type: object allOf: – #/definitions/cidade description: Cidade destino documentoEmbarque: type: array items: type: object allOf: – #/definitions/documentoEmbarque description: Documento de Embarque transacao: type: object allOf: – #/definitions/transacao description: Transação motivoCancelamento: type: string description: Motivo Cancelamento dataCancelamento: type: string format: date-time description: Data Cancelamento documentosTransporteOrigem: type: array items: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte Origem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notaFiscalServico: description: Dados da nota fiscal serviço type: object properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte pis: type: number format: double description: PIS pisBaseCalculo: type: number format: double description: PIS Base Cálculo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editNotaFiscalServico: type: object required: – id allOf: – #/definitions/notaFiscalServico conhecimentoTransporte: description: Entidade Conhecimento Transporte type: object properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte cfop: type: integer format: int64 description: CFOP icmsValor: type: number format: double description: ICMS icmsValorBaseCalculo: type: number format: double description: ICMS Base Cálculo icmsPercentual: type: number format: double description: ICMS Alíquota Cálculo icmsPercentualDestino: type: number format: double description: ICMS Alíqutota Destino icmsPercentualInterestadual: type: number format: double description: ICMS Percentual Interestadual Destino icmsValorCreditoPresumido: type: number format: double description: ICMS Crédito Pesumido icmsTipo: type: string allOf: – #/definitions/enumTipoIcms description: ICMS Tipo cst: type: string maxLength: 4 description: CST icmsPercentualReducaoBaseCalculo: type: number format: double description: Redução Base Percentual icmsPercentualFcpDestino: type: number format: double description: FCP Alíquota icmsValorBaseCalculoDestino: type: number format: double description: ICMS Valor Base Calculo Destino icmsValorUfOrigem: type: number format: double description: ICMS Valor UF Origem icmsValorFcpDestino: type: number format: double description: ICMS Valor FCP Destino icmsValorUfDestino: type: number format: double description: ICMS Valor UF Destino createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConhecimentoTransporte: type: object required: – id allOf: – #/definitions/conhecimentoTransporte conhecimentoTransporteEletronico: description: Entidade Conhecimento De Transporte Eletrônico type: object required: – operacao properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte cfop: type: integer format: int64 description: CFOP icmsValor: type: number format: double description: ICMS icmsValorBaseCalculo: type: number format: double description: ICMS Base Cálculo icmsPercentual: type: number format: double description: ICMS Alíquota Cálculo icmsPercentualDestino: type: number format: double description: ICMS Alíqutota Destino icmsPercentualInterestadual: type: number format: double description: ICMS Percentual Interestadual Destino icmsValorCreditoPresumido: type: number format: double description: ICMS Crédito Pesumido icmsTipo: type: string allOf: – #/definitions/enumTipoIcms description: ICMS Tipo cst: type: string maxLength: 4 description: CST icmsPercentualReducaoBaseCalculo: type: number format: double description: Redução Base Percentual icmsPercentualFcpDestino: type: number format: double description: FCP Alíquota protocolo: type: string maxLength: 255 description: Protocolo dataProtocolo: type: string format: date-time description: Data do protocolo tipoAmbiente: type: string allOf: – #/definitions/enumTipoAmbiente description: Tipo do ambiente operacao: type: object allOf: – #/definitions/operacoes description: Operação icmsValorBaseCalculoDestino: type: number format: double description: ICMS Valor Base Calculo Destino icmsValorUfOrigem: type: number format: double description: ICMS Valor UF Origem icmsValorFcpDestino: type: number format: double description: ICMS Valor FCP Destino icmsValorUfDestino: type: number format: double description: ICMS Valor UF Destino createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConhecimentoTransporteEletronico: type: object required: – id allOf: – #/definitions/conhecimentoTransporteEletronico componenteFrete: description: Entidade de componente de frete type: object required: – nome – abreviacao – descricao properties: id: type: string format: uuid description: Id da entidade nome: type: string maxLength: 255 description: Nome abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: gatilhoComponenteFrete: description: Entidade gatilho do componente de frete type: object required: – componenteFrete – gatilho properties: id: type: string format: uuid description: Id da entidade componenteFrete: type: object allOf: – #/definitions/componenteFrete description: Id da entidade componente frete gatilho: type: string allOf: – #/definitions/enumGatilhoComponenteFrete description: Enum gatilho componente frete createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoTransporteComponenteFrete: description: Documento transporte componente frete type: object required: – documentoTransporte – componenteFrete – valor properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Id do documento de transporte componenteFrete: type: object allOf: – #/definitions/componenteFrete description: Id do componente de frete valor: type: number format: double description: Valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: documentoTransporteComponenteFreteLog: description: Documento transporte componente frete log type: object required: – documentoTransporte – componenteFrete – valor properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Id do documento de transporte componenteFrete: type: object allOf: – #/definitions/componenteFrete description: Id do componente de frete valor: type: number format: double description: Valor createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: rateio: description: Entidade de Rateio type: object required: – id – valor properties: id: type: string format: uuid description: Id da entidade valor: type: number format: double description: Valor Rateio createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: rateioComponenteFrete: description: Entidade de Rateio Componente Frete type: object required: – rateio – componenteFrete – porcentagem – gatilho properties: id: type: string format: uuid description: Id da entidade rateio: type: object allOf: – #/definitions/rateio description: Id da entidade Rateio componenteFrete: type: object allOf: – #/definitions/componenteFrete description: Id da entidade Componente Frete porcentagem: type: number format: double description: Valor gatilho: type: string allOf: – #/definitions/enumGatilhoComponenteFrete description: Enum gatilho componente frete createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: loteDocumentoTransporte: description: Entidade de Lote Documento Transporte type: object required: – id properties: id: type: string format: uuid description: Id da entidade numeroLote: type: integer format: int64 description: Número rateio: type: object allOf: – #/definitions/rateio description: Id da entidade Rateio filial: type: object allOf: – #/definitions/filial description: Id da entidade Filial classificacaoOperacaoTransporte: type: object allOf: – #/definitions/classificacaoOperacaoTransporte description: Id da entidade Classificação Operação Transporte quantidadeDocumentosTransporte: type: integer format: int64 description: Quantidade de documentos de transportes criados valorTotalFrete: type: number format: double description: Valor total do frete valorTotalMercadoria: type: number format: double description: Valor total das mercadorias createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: configuracaoTipoDocumentoTransporte: description: Entidade Configuracao Tipo Documento Transporte type: object required: – tipoDocumentoFiscal – integracao – operacao properties: id: type: string format: uuid description: Id da entidade tipoDocumentoFiscal: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: TipoDocumentoFiscal integracao: type: string allOf: – #/definitions/enumIntegracao description: Integracao operacao: type: string allOf: – #/definitions/enumOperacaoOrigemDestinoTransporte description: Operacao createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editConfiguracaoTipoDocumentoTransporte: type: object required: – id allOf: – #/definitions/configuracaoTipoDocumentoTransporte operacoes: description: Operações type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 5 description: Código saida: type: string maxLength: 512 description: Saída excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: servicos: description: Entidade Serviços type: object required: – codigo properties: id: type: string format: uuid description: Id da entidade codigo: type: string description: Código excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Status da integração extIntMsg: type: string description: Mensagem recebida via integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: transacaoVinculada: description: Entidade de Transação Vinculada type: object required: – empresa properties: id: type: string format: uuid description: Id da entidade ufTransportador: type: string maxLength: 2 description: Unidade Federativa do transportador tipoPessoaRemetente: type: string allOf: – #/definitions/enumTipoPessoa description: Tipo de remetente tipoRamoAtividadeRemetente: type: string allOf: – #/definitions/enumTipoRamoAtividade description: Tipo do ramo da atividade do remetente remetenteComIeRegistrada: type: boolean description: Remetente com Ie registrada ufInicioPrestacao: type: string maxLength: 2 description: Unidade Federativa do início da prestação ufFimPrestacao: type: string maxLength: 2 description: Unidade Federativa do fim da prestação transacao: type: object allOf: – #/definitions/transacao description: Transação empresa: type: object allOf: – #/definitions/empresa description: Empresa codigo: type: integer format: int64 description: Código createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editTransacaoVinculada: type: object required: – id allOf: – #/definitions/transacaoVinculada eventoDocumentoTransporte: description: Entidade de Evento Documento Transporte type: object required: – documentoTransporte – sequencia – evento – situacao properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte sequencia: type: integer format: int64 description: Sequência evento: type: string allOf: – #/definitions/enumEvento description: EnumEvento situacao: type: string allOf: – #/definitions/enumEventoSituacao description: EnumEventoSituacao integracaoMensagem: type: string maxLength: 255 description: Mensagem de Integração integracaoCodigo: type: string maxLength: 50 description: Código de Integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: historicoDocumentoTransporte: description: Entidade de Histórico Documento Transporte type: object required: – documentoTransporte – sequencia properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte sequencia: type: integer format: int64 description: Sequência dominioServico: type: string maxLength: 100 description: Domínio Serviço servicoNome: type: string maxLength: 100 description: Serviço Nome primitiva: type: string maxLength: 100 description: Primitiva primitivaInput: type: string maxLength: 255 description: Primitva Input descricao: type: string maxLength: 500 description: Descrição integracaoCodigo: type: string maxLength: 50 description: Integração Código integracaoMensagem: type: string maxLength: 255 description: Integração Mensagem createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: historicoCalculo: description: Entidade Histórico Cálculo type: object required: – documentoTransporte properties: id: type: string format: uuid description: Id da entidade primitiva: type: string maxLength: 255 description: Primitiva descricao: type: string maxLength: 255 description: Descrição input: type: string description: Input output: type: string description: Output documentoTransporte: type: object allOf: – #/definitions/documentoTransporte description: Documento Transporte createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: transacao: description: Entidade de Transação type: object required: – empresa properties: id: type: string format: uuid description: Id da entidade codigo: type: string maxLength: 5 description: Código descricao: type: string description: Descrição transacaoFiscalSaida: type: object allOf: – #/definitions/transacaoFiscalSaida description: Transação Fiscal de Saída empresa: type: object allOf: – #/definitions/empresa description: Empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: transacaoFiscalSaida: description: Entidade de Transação Fiscal de Saída type: object properties: id: type: string format: uuid description: Id da entidade cfop: type: string maxLength: 5 description: Código fiscal de operação transacao: type: object allOf: – #/definitions/transacao description: Transação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: configuracoesGerais: description: Entidade Configurações Gerais type: object properties: id: type: string format: uuid description: Id da entidade chave: type: string maxLength: 255 description: Campo chave armazena o nome da configuração valor: type: string maxLength: 255 description: Campo valor armazena o valor da configuração tipo: type: string maxLength: 255 description: Campo tipo é uma alfanumérico que armazena o tipo do campo valor(int, string etc) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: finalidadeCompraVenda: description: Entidade Finalidade Compra Venda type: object properties: id: type: string format: uuid description: Id da entidade descricao: type: string maxLength: 255 description: Descricao codigo: type: integer format: int64 description: Código ativo: type: boolean description: Ativo default: true excluido: type: boolean description: Excluido default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: filialFiscal: description: Especialização de compliance da filial type: object properties: id: type: string format: uuid description: Id da entidade codigoRegimeTributario: type: string allOf: – #/definitions/enumCodRegimeTributario description: Código do regime tributário extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: variavel: description: Entidade Variavel type: object required: – id – nome properties: id: type: string format: uuid description: Id da entidade nome: type: string description: Nome da variável createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: variavelEntidade: description: Entidade Variavel Entidade type: object required: – id – variavel – idEntidade – valor – entidade properties: id: type: string format: uuid description: Id da entidade variavel: type: object allOf: – #/definitions/variavel description: Entidade variável idEntidade: type: string format: uuid description: Código identidade Entidade valor: type: string description: Valor variável entidade: type: string allOf: – #/definitions/enumEntidade description: Enum Entidade createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: mensagemDocumentoFiscal: description: Mensagem type: object required: – codigo – descricao – interesse properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código mensagem minimum: 0 maximum: 9999 descricao: type: string maxLength: 1000 description: Descrição mensagem rotinaAplicacao: type: string allOf: – #/definitions/enumRotinaAplicacaoMensagem description: Rotina de aplicação da mensagem mensagemFiscal: type: boolean description: Mensagem fiscal mensagemEspecial: type: boolean description: Mensagem especial entidadeDinamica: type: string allOf: – #/definitions/enumEntidadeMensagemDinamica description: Entidade dinâmica mensagemDinamica: type: string maxLength: 1000 description: Descrição dinâmica com variável interesse: type: string allOf: – #/definitions/enumInteresseMensagem description: Interesse da mensagem camposDinamicos: type: array items: type: object allOf: – #/definitions/camposDinamicosMensagem description: Campos dinamicos numeroProcesso: type: string maxLength: 20 description: Número do processo ou ato concessório origemProcesso: type: string allOf: – #/definitions/enumOrigemProcessoAtoConcessorio description: Origem do processo ou ato concessório excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: camposDinamicosMensagem: description: Tabelas – mensagens para nota fiscal de saída e contrato de venda – campos dinâmicos type: object required: – nomeVariavel – informacoes properties: id: type: string format: uuid description: Id da entidade mensagemDocumentoFiscal: type: object allOf: – #/definitions/mensagemDocumentoFiscal description: Código mensagem nomeVariavel: type: string maxLength: 150 description: Nome da váriavel campoResultante: type: string maxLength: 255 description: Campo resultante valorSimulado: type: string maxLength: 255 description: Valor simulado informacoes: type: string maxLength: 150 description: Informações da mensagem tipoNota: type: string allOf: – #/definitions/enumAgrupadorDinamicoObservacao description: Referência (observação) para nota fiscal excluido: type: boolean description: Indica se o registro foi excluído default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: beneficioFiscal: description: Tabela de cadastro de benefício fical type: object properties: id: type: string format: uuid description: Identificador codigo: type: string description: Código descricao: type: string description: Descrição abreviatura: type: string description: Abreviatura vigenciaInicial: type: string format: date description: Vigência Inicial vigenciaFinal: type: string format: date description: Vigência Final situacao: type: string allOf: – #/definitions/enumSitRegErpx description: Situação observacao: type: string description: Observação excluido: type: boolean description: Indica se o registro foi excluido default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e027str: description: Cadastro de Situação tributária type: object required: – codStr – desStr – tipImp – tipOpe – situacao – excluido properties: id: type: string format: uuid description: Id da entidade codStr: type: string maxLength: 3 description: Código interno da situação desStr: type: string maxLength: 250 description: Descrição da situação tributária abrStr: type: string description: Abreviatura tipImp: type: string allOf: – #/definitions/enumTipImpCstErpx description: Imposto tipOpe: type: string allOf: – #/definitions/enumTipoOperacaoErpx description: Tipo de operação situacao: type: string allOf: – #/definitions/enumSituacaoErpx description: Situação excluido: type: boolean description: Indica se o registro foi excluído extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e027eqi: description: Tabelas – Enquadramento de IPI type: object required: – codEnq – desEnq – situacao properties: id: type: string format: uuid description: Id entidade codEnq: type: integer format: int64 description: Código do enquadramento minimum: 0 maximum: 999 desEnq: type: string maxLength: 499 description: Descrição enquadramento situacao: type: string allOf: – #/definitions/enumSituacaoErpx description: situacao excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: classificacaoTributaria: description: Cadastro de classificação tributária type: object required: – e027str – codigo – descricao – vigenciaInicial – situacao properties: id: type: string format: uuid description: Identificação unica da classificação tributária e027str: type: object allOf: – #/definitions/e027str description: Situação tributária codigo: type: string maxLength: 10 description: Código descricao: type: string maxLength: 2000 description: Descrição leiComplementar: type: string maxLength: 500 description: Lei complementar leiComplementarDescricao: type: string maxLength: 2000 description: Descrição da lei complementar perRedAliquota: type: number format: double description: Percentual de redução da alíquota minimum: 0.00 maximum: 999.9999 exigeNbsNcm: type: boolean description: Exige NBS ou NCM default: false exigeCodigoServico: type: boolean description: Exige código do serviço default: false vigenciaInicial: type: string format: date description: Vigência inicial vigenciaFinal: type: string format: date description: Vigência final situacao: type: string allOf: – #/definitions/enumSituacaoClassificacaoTributariaErpx description: Situação tipoOrigem: type: string allOf: – #/definitions/enumTipoOrigemErpx description: Tipo da origem do cadastro origem: type: string maxLength: 150 description: Tenant de origem do cadastro extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: naturezaReceitaPISCOFINS: description: Natureza de receita para PIS/COFINS type: object properties: id: type: string format: uuid description: Id da entidade codigo: type: integer format: int64 description: Código minimum: 0 maximum: 9999 descricao: type: string maxLength: 500 description: Descrição vigenciaInicial: type: string format: date description: Vigência inicial vigenciaFinal: type: string format: date description: Vigência final csts: type: string maxLength: 100 description: CSTs excluido: type: boolean description: Indica se o registro foi excluido default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: e140imi: description: Dados do imposto type: object properties: id: type: string description: Id da entidade tipImp: type: string description: Tipo de imposto basImp: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0 aliImp: type: number format: double description: Alíquota do imposto minimum: 0.00 maximum: 99999999999.9999 vlrImp: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0 vlrOut: type: string description: Valor Outras minimum: 0.00 maximum: 9999999999999.99 default: 0 vlrIse: type: string description: Valor Isentas minimum: 0.00 maximum: 9999999999999.99 default: 0 perRed: type: number format: double description: Percentual de redução da base do imposto minimum: 0.00 maximum: 999.99999 perMva: type: number format: double description: Percentual da margem de valor Adicionado do ICMS ST minimum: 0.00 maximum: 999.9999 motDes: type: string description: Motivo desoneração ICMS oriMer: type: string description: Origem fiscal da mercadoria aplLiq: type: string description: Aplicação do imposto impMan: type: boolean description: Aplicação manual de imposto guiDoc: type: boolean description: Guia por Documento default: false aliDes: type: number format: double description: Alíquota de ICMS interestadual da UF de destino minimum: 0.00 maximum: 99999999999.9999 default: 0.00 vlrRec: type: string description: Valor recolhido pelo substituto minimum: 0.00 maximum: 99999999999.9999 supCon: type: number format: double description: Suportado consumidor final minimum: 0.00 maximum: 99999999999.9999 vlrRet: type: string description: Valor Icms St retido minimum: 0.00 maximum: 99999999999.9999 tipDif: type: string description: Tipo de diferimento regimeControleRetencao: type: string description: Regime do contrle de retenção codigoTributacao: type: string maxLength: 6 description: Código de Tributação regimeTributario: type: string description: Regime tributário parametroCalculoImpostos: type: string description: Id do parametro utilizado no cáculo do imposto perfilTributarioCalculoImpostos: type: string description: Id do perfil tributário que contem os parametros de cálculo parametroStCalculoImpostos: type: string description: Id do parâmetro de Substituição Tributária usado no cálculo dos impostos indicativoAquisicao: type: string description: Indicativo de aquisição para o FUNRURAL paramStEstadoCalculoImpostos: type: string description: Id do parâmetro de Substituição Tributária usado no cálculo dos impostos por estado percentualSuspensaoParcial: type: number format: double description: Percentual de suspensão parcial minimum: 0 maximum: 999.9999 taxRateReduction: type: number format: double description: Percentual de redução da alíquota do imposto minimum: 0.00 maximum: 99999999999.9999 effectiveTaxRate: type: number format: double description: Alíquota efetiva minimum: 0.00 maximum: 99999999999.9999 valorImpostoBruto: type: string description: Valor imposto bruto minimum: 0.00 maximum: 9999999999999.99 default: 0 tipoCalculoImposto: type: string description: Tipo do calculo do imposto 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. 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 documentoEmbarqueFacadeInput: description: Fachada Documento de Embarque type: object required: – numero – serie – emitente – tipo – destinatario – origem – destino – valorDocumento properties: id: type: string format: uuid description: Id da entidade numero: type: string description: Numero serie: type: string maxLength: 3 description: Série emitente: type: object allOf: – #/definitions/recPessoa description: Emitente tipo: type: object allOf: – #/definitions/recChavesIdCodigoString description: Tipo do documento de embarque destinatario: type: object allOf: – #/definitions/recPessoa description: Destinatário do cadastro pessoa dadosTransporte: type: object allOf: – #/definitions/recFacadeDocumentoEmbarqueDadosTransporteInput description: Dados do transporte origem: type: object allOf: – #/definitions/recOrigemDestinoInput description: Dados referentes a origem destino: type: object allOf: – #/definitions/recOrigemDestinoInput description: Dados referentes ao destino dataEmissao: type: string format: date-time description: Data de emissão chave: type: string description: Chave valorDocumento: type: number format: double description: Valor documento observacao: type: string maxLength: 2000 description: Observação tags: type: array items: type: object allOf: – #/definitions/recTag description: Tags variaveis: type: array items: type: object allOf: – #/definitions/recVariavel description: Variáveis documentoEmbarqueFacadeOutput: description: Fachada Documento de Embarque type: object required: – id – numero – serie – emitente – tipo – valorDocumento properties: id: type: string description: Id da entidade numero: type: string description: Numero serie: type: string maxLength: 3 description: Série emitente: type: object allOf: – #/definitions/recFacadePessoaOutput description: Emitente tipo: type: object allOf: – #/definitions/recFacadeTipoDocumentoEmbarqueOutput description: Tipo do documento destinatario: type: object allOf: – #/definitions/recFacadePessoaOutput description: Destinatário origem: type: object allOf: – #/definitions/recOrigemDestino description: Dados referentes a origem destino: type: object allOf: – #/definitions/recOrigemDestino description: Dados referentes ao destino dadosTransporte: type: object allOf: – #/definitions/recFacadeDocumentoEmbarqueDadosTransporteOutput description: Dados do transporte dataEmissao: type: string format: date-time description: Data de emissão chave: type: string description: Chave valorDocumento: type: number format: double description: Valor documento observacao: type: string maxLength: 2000 description: Observação tags: type: array items: type: object allOf: – #/definitions/recTag description: Tags variaveis: type: array items: type: object allOf: – #/definitions/recVariavel description: Variáveis createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação modeloDocumentoTransporteFacadeInput: description: Fachada Modelo Documento Transporte type: object required: – codigo – descricao – abreviacao – tipoDocumentoFiscal – integracao properties: id: type: string format: uuid description: Id codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 15 description: Abreviação tipoDocumentoFiscal: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: Tipo do documento fiscal integracao: type: string allOf: – #/definitions/enumIntegracao description: Integração ativo: type: boolean description: Status default: true modeloDocumentoTransporteFacadeOutput: description: Fachada Modelo Documento Transporte type: object required: – id – codigo – descricao – abreviacao – tipoDocumentoFiscal – integracao – ativo properties: id: type: string description: Id codigo: type: integer format: int64 description: Código descricao: type: string maxLength: 255 description: Descrição abreviacao: type: string maxLength: 15 description: Abreviação tipoDocumentoFiscal: type: string allOf: – #/definitions/enumTipoDocumentoFiscal description: Tipo do documento fiscal integracao: type: string allOf: – #/definitions/enumIntegracao description: Integração ativo: type: boolean description: Status createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação filialSerieFacadeInput: description: Fachada Filial Série type: object required: – modeloDocumentoTransporte – filial – serie – dataInicio – dataFim properties: id: type: string format: uuid description: Id modeloDocumentoTransporte: type: object allOf: – #/definitions/recEntidadeRelacionada description: Modelo do documento de transporte filial: type: object allOf: – #/definitions/recEntidadeRelacionada description: Filial serie: type: string maxLength: 3 description: Série ultimaNumeracao: type: integer format: int64 description: Última numeração default: 0 dataInicio: type: string format: date description: Data de inicio dataFim: type: string format: date description: Data de finalização filialSerieFacadeOutput: description: Fachada Filial Série type: object required: – id – modeloDocumentoTransporte – filial – serie – dataInicio – dataFim properties: id: type: string description: Id modeloDocumentoTransporte: type: object allOf: – #/definitions/recFacadeModeloDocumentoTransporteOutput description: Modelo do documento de transporte filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial serie: type: string maxLength: 3 description: Série ultimaNumeracao: type: integer format: int64 description: Última numeração default: 0 dataInicio: type: string format: date description: Data de inicio dataFim: type: string format: date description: Data de finalização createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação alteraVigenciaFilialSerieFacadeInput: description: Fachada de alteração de vigência para Filial Série type: object required: – dataInicio – dataFim properties: id: type: string format: uuid description: Id dataInicio: type: string format: date description: Data de inicio dataFim: type: string format: date description: Data de finalização alteraVigenciaFilialSerieFacadeOutput: description: Fachada de alteração de vigência para Filial Série type: object required: – id – modeloDocumentoTransporte – filial – serie – dataInicio – dataFim properties: id: type: string description: Id modeloDocumentoTransporte: type: object allOf: – #/definitions/recFacadeModeloDocumentoTransporteOutput description: Modelo do documento de transporte filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial serie: type: string maxLength: 3 description: Série ultimaNumeracao: type: integer format: int64 description: Última numeração default: 0 dataInicio: type: string format: date description: Data de inicio dataFim: type: string format: date description: Data de finalização createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação documentoTransporteFacadeInput: description: Fachada documento Transporte type: object required: – numero – serie – situacao – modeloDocumentoTransporte – observacao properties: id: type: string format: uuid description: Id da entidade numero: type: string maxLength: 255 description: Número serie: type: string maxLength: 3 description: Série situacao: type: string allOf: – #/definitions/enumSituacaoDocumentoTransporte description: Situação filial: type: object allOf: – #/definitions/recEntidadeRelacionada description: Filial natureza: type: object allOf: – #/definitions/recEntidadeRelacionada description: Natureza Carga especie: type: object allOf: – #/definitions/recEntidadeRelacionada description: Espécie remetente: type: object allOf: – #/definitions/recEntidadeRelacionada description: Rementente destinatario: type: object allOf: – #/definitions/recEntidadeRelacionada description: Destinatário expedidor: type: object allOf: – #/definitions/recEntidadeRelacionada description: Expedidor recebedor: type: object allOf: – #/definitions/recEntidadeRelacionada description: Recebedor pagador: type: object allOf: – #/definitions/recEntidadeRelacionada description: Pagador classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recEntidadeRelacionada description: Classificação operação transporte tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo Pagador origem: type: object allOf: – #/definitions/recOrigemDestino description: Origem destino: type: object allOf: – #/definitions/recOrigemDestino description: Destino modeloDocumentoTransporte: type: object allOf: – #/definitions/recEntidadeRelacionada description: Modelo Documento Transporte dataEmissao: type: string format: date-time description: Data Emissão chave: type: string maxLength: 255 description: Chave quantidadeVolumes: type: integer format: int64 description: Quantidade Volume pesoFisico: type: number format: double description: Peso Físico pesoCubadoCalculado: type: number format: double description: Peso Cubado Calculado pesoCubadoOperacional: type: number format: double description: Peso Cubado Operacional fatorCubagem: type: number format: double description: Fator Cubagem metrosCubicos: type: number format: double description: Metros Cúbicos valorTotal: type: number format: double description: Valor Total valorLiquido: type: number format: double description: Valor Líquido observacao: type: string maxLength: 255 description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data Previsão Entrega tag: type: object allOf: – #/definitions/recTag description: variavel: type: object allOf: – #/definitions/recVariavel description: Variável motivoCancelamento: type: string description: Motivo Cancelamento dataCancelamento: type: string format: date-time description: Data Cancelamento documentoTransporteFacadeOutput: description: Fachada documento Transporte type: object required: – numero – numeroInterno – serie – situacao – modeloDocumentoTransporte – observacao properties: id: type: string description: Id da entidade numero: type: string maxLength: 255 description: Número numeroInterno: type: string maxLength: 255 description: Número interno serie: type: string maxLength: 3 description: Série situacao: type: string allOf: – #/definitions/enumSituacaoDocumentoTransporte description: Situação filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial naturezaCarga: type: object allOf: – #/definitions/recFacadeNaturezaCargaOutput description: Natureza Carga especie: type: object allOf: – #/definitions/recFacadeEspecieOutput description: Espécie remetente: type: object allOf: – #/definitions/recFacadePessoaOutput description: Rementente destinatario: type: object allOf: – #/definitions/recFacadePessoaOutput description: Destinatário expedidor: type: object allOf: – #/definitions/recFacadePessoaOutput description: Expedidor recebedor: type: object allOf: – #/definitions/recFacadePessoaOutput description: Recebedor pagador: type: object allOf: – #/definitions/recFacadePessoaOutput description: Pagador classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recFacadeClassificacaoOperacaoTransporteOutput description: Classificação operação transporte tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo Pagador origem: type: object allOf: – #/definitions/recOrigemDestinoDocumentoTransporte description: Origem destino: type: object allOf: – #/definitions/recOrigemDestinoDocumentoTransporte description: Destino modeloDocumentoTransporte: type: object allOf: – #/definitions/recFacadeModeloDocumentoTransporteOutput description: Modelo Documento Transporte dataEmissao: type: string format: date-time description: Data Emissão chave: type: string maxLength: 255 description: Chave quantidadeVolumes: type: integer format: int64 description: Quantidade Volume pesoFisico: type: number format: double description: Peso Físico pesoCubadoCalculado: type: number format: double description: Peso Cubado Calculado pesoCubadoOperacional: type: number format: double description: Peso Cubado Operacional fatorCubagem: type: number format: double description: Fator Cubagem metrosCubicos: type: number format: double description: Metros Cúbicos valorTotal: type: number format: double description: Valor Total valorTotalMercadoria: type: number format: double description: Valor Total da Mercadoria valorLiquido: type: number format: double description: Valor Líquido observacao: type: string maxLength: 255 description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data Previsão Entrega lote: type: object allOf: – #/definitions/recFacadeLoteDocumentoTransporteOutput description: Lote motivoCancelamento: type: string description: Motivo Cancelamento dataCancelamento: type: string format: date-time description: Data Cancelamento createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação tags: type: array items: type: object allOf: – #/definitions/recTag description: Tags variaveis: type: array items: type: object allOf: – #/definitions/recVariavel description: Variáveis rateioLoteDocumentoTransporteFacadeInput: description: Fachada Rateio Lote Documento Transporte type: object required: – documentoEmbarque – classificacaoOperacaoTransporte – filial – rateio properties: id: type: string format: uuid description: Id do Lote documentoEmbarque: type: array items: type: object allOf: – #/definitions/recEntidadeRelacionada minimum: 1 description: Documento embarque classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recEntidadeRelacionada description: Classificação de Operação de Transporte filial: type: object allOf: – #/definitions/recEntidadeRelacionada description: Filial rateio: type: object allOf: – #/definitions/recFacadeRateioInput description: Rateio rateioLoteDocumentoTransporteFacadeOutput: description: Fachada Rateio Lote Documento Transporte type: object required: – id – numero – rateio properties: id: type: string description: Id do lote numero: type: string description: Número do lote rateio: type: object allOf: – #/definitions/recFacadeRateioOutput description: Rateio filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial do Lote quantidadeDocumentosTransporte: type: integer format: int64 description: Quantidade de documentos de transportes criados valorTotalFrete: type: number format: double description: Valor total do frete valorTotalMercadoria: type: number format: double description: Valor total das mercadorias loteDocumentoTransporteFacadeInput: description: Fachada Lote Documento Transporte type: object properties: id: type: string format: uuid description: Id do Lote loteDocumentoTransporteFacadeOutput: description: Fachada Lote Documento Transporte type: object required: – id – numero properties: id: type: string description: Id do lote numero: type: string description: Número do lote filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial do Lote quantidadeDocumentosTransporte: type: integer format: int64 description: Quantidade de documentos de transportes criados valorTotalFrete: type: number format: double description: Valor total do frete valorTotalMercadoria: type: number format: double description: Valor total das mercadorias conhecimentoTransporteEletronicoFacadeInput: description: Fachada Conhecimento Transporte Eletrônico type: object required: – numero – operacao properties: id: type: string format: uuid description: Id da entidade numero: type: string maxLength: 255 description: Número cfop: type: integer format: int64 description: CFOP icmsValor: type: number format: double description: ICMS icmsValorBaseCalculo: type: number format: double description: ICMS Base Cálculo icmsPercentual: type: number format: double description: ICMS Alíquota Cálculo icmsPercentualDestino: type: number format: double description: ICMS Alíqutota Destino icmsPercentualInterestadual: type: number format: double description: ICMS Percentual Interestadual Destino icmsValorCreditoPresumido: type: number format: double description: ICMS Crédito Pesumido icmsTipo: type: string allOf: – #/definitions/enumTipoIcms description: ICMS Tipo cst: type: string maxLength: 4 description: CST icmsPercentualReducaoBaseCalculo: type: number format: double description: Redução Base Percentual icmsPercentualFcpDestino: type: number format: double description: FCP Alíquota protocolo: type: string maxLength: 255 description: Protocolo dataProtocolo: type: string format: date-time description: Data do protocolo tipoAmbiente: type: string allOf: – #/definitions/enumTipoAmbiente description: Tipo do ambiente operacao: type: object allOf: – #/definitions/recEntidadeRelacionada description: Operação icmsValorBaseCalculoDestino: type: number format: double description: ICMS Valor Base Calculo Destino icmsValorUfOrigem: type: number format: double description: ICMS Valor UF Origem icmsValorFcpDestino: type: number format: double description: ICMS Valor FCP Destino icmsValorUfDestino: type: number format: double description: ICMS Valor UF Destino conhecimentoTransporteEletronicoFacadeOutput: description: Fachada Conhecimento Transporte Eletrônico type: object required: – numero – numeroInterno – serie – modelo – observacao properties: id: type: string description: Id da entidade numero: type: string maxLength: 255 description: Número numeroInterno: type: integer format: int64 description: Número interno serie: type: string maxLength: 3 description: Série filial: type: object allOf: – #/definitions/recFacadeFilialOutput description: Filial naturezaCarga: type: object allOf: – #/definitions/recFacadeNaturezaCargaOutput description: Natureza Carga especie: type: object allOf: – #/definitions/recFacadeEspecieOutput description: Espécie remetente: type: object allOf: – #/definitions/recFacadePessoaOutput description: Rementente destinatario: type: object allOf: – #/definitions/recFacadePessoaOutput description: Destinatário expedidor: type: object allOf: – #/definitions/recFacadePessoaOutput description: Expedidor recebedor: type: object allOf: – #/definitions/recFacadePessoaOutput description: Recebedor pagador: type: object allOf: – #/definitions/recFacadePessoaOutput description: Pagador classificacaoOperacaoTransporte: type: object allOf: – #/definitions/recFacadeClassificacaoOperacaoTransporteOutput description: Classificação operação transporte tipoPagador: type: string allOf: – #/definitions/enumTipoPagador description: Tipo Pagador origem: type: object allOf: – #/definitions/recOrigemDestinoDocumentoTransporte description: Origem destino: type: object allOf: – #/definitions/recOrigemDestinoDocumentoTransporte description: Destino modelo: type: object allOf: – #/definitions/recFacadeModeloDocumentoTransporteOutput description: Modelo Documento Transporte dataEmissao: type: string format: date-time description: Data Emissão chave: type: string maxLength: 255 description: Chave quantidadeVolumes: type: integer format: int64 description: Quantidade Volume pesoFisico: type: number format: double description: Peso Físico pesoCubadoCalculado: type: number format: double description: Peso Cubado Calculado pesoCubadoOperacional: type: number format: double description: Peso Cubado Operacional fatorCubagem: type: number format: double description: Fator Cubagem metrosCubicos: type: number format: double description: Metros Cúbicos valorTotal: type: number format: double description: Valor Total valorLiquido: type: number format: double description: Valor Líquido observacao: type: string maxLength: 255 description: Observação dataPrevisaoEntrega: type: string format: date-time description: Data Previsão Entrega lote: type: object allOf: – #/definitions/recFacadeLoteDocumentoTransporteOutput description: Lote cfop: type: integer format: int64 description: CFOP icmsValor: type: number format: double description: ICMS icmsValorBaseCalculo: type: number format: double description: ICMS Base Cálculo icmsPercentual: type: number format: double description: ICMS Alíquota Cálculo icmsPercentualDestino: type: number format: double description: ICMS Alíqutota Destino icmsPercentualInterestadual: type: number format: double description: ICMS Percentual Interestadual Destino icmsValorCreditoPresumido: type: number format: double description: ICMS Crédito Pesumido icmsTipo: type: string allOf: – #/definitions/enumTipoIcms description: ICMS Tipo cst: type: string maxLength: 4 description: CST icmsPercentualReducaoBaseCalculo: type: number format: double description: Redução Base Percentual icmsPercentualFcpDestino: type: number format: double description: FCP Alíquota icmsValorBaseCalculoDestino: type: number format: double description: ICMS Valor Base Calculo Destino icmsValorUfOrigem: type: number format: double description: ICMS Valor UF Origem icmsValorFcpDestino: type: number format: double description: ICMS Valor FCP Destino icmsValorUfDestino: type: number format: double description: ICMS Valor UF Destino protocolo: type: string maxLength: 255 description: Protocolo dataProtocolo: type: string format: date-time description: Data do protocolo tipoAmbiente: type: string allOf: – #/definitions/enumTipoAmbiente description: Tipo do ambiente operacao: type: object allOf: – #/definitions/recFacadeOperacoesOutput description: Operação createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação tipoDocumentoEmbarqueFacadeInput: description: Tipo Documento Embarque type: object required: – codigo – abreviacao – descricao – modeloDocumentoCarga – exigeChaveAcesso properties: id: type: string format: uuid description: Identificador único codigo: type: string maxLength: 255 description: Código abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string maxLength: 255 description: Descrição modeloDocumentoCarga: type: string allOf: – #/definitions/modeloDocumentoCarga description: Modelo documento carga chaveAcessoTamanho: type: integer format: int64 description: Chave acesso tamanho chaveAcessoExpressao: type: string description: Chave acesso expressão chaveAcessoGrupoEmitente: type: integer format: int64 description: Chave acesso grupo emitente chaveAcessoGrupoNumero: type: integer format: int64 description: Chave acesso grupo número chaveAcessoGrupoSerie: type: integer format: int64 description: Chave acesso grupo série chaveAcessoGrupoEmissao: type: integer format: int64 description: Chave acesso grupo emissão serieNumerica: type: boolean description: Série númerica default: true exigeChaveAcesso: type: boolean description: Exige chave acesso ativo: type: boolean description: Situação default: true padrao: type: boolean description: Padrão default: false tipoDocumentoEmbarqueFacadeOutput: description: Tipo Documento Embarque type: object required: – codigo – abreviacao – descricao – modeloDocumentoCarga – exigeChaveAcesso properties: id: type: string description: Identificador único codigo: type: string maxLength: 255 description: Código abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string maxLength: 255 description: Descrição modeloDocumentoCarga: type: string allOf: – #/definitions/modeloDocumentoCarga description: Modelo documento carga chaveAcessoTamanho: type: integer format: int64 description: Chave acesso tamanho chaveAcessoExpressao: type: string description: Chave acesso expressão chaveAcessoGrupoEmitente: type: integer format: int64 description: Chave acesso grupo emitente chaveAcessoGrupoNumero: type: integer format: int64 description: Chave acesso grupo número chaveAcessoGrupoSerie: type: integer format: int64 description: Chave acesso grupo série chaveAcessoGrupoEmissao: type: integer format: int64 description: Chave acesso grupo emissão serieNumerica: type: boolean description: Série númerica default: true exigeChaveAcesso: type: boolean description: Exige chave acesso ativo: type: boolean description: Situação default: true padrao: type: boolean description: Padrão default: false createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificaç lastModifiedDate: type: string format: date-time description: Data ultima modificação classificacaoOperacaoTransporteFacadeInput: description: Classificação de Operação de Transporte type: object required: – codigo – descricao – abreviacao – tipoOperacao – modalTransporte – tipoServico properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da classificação operação transporte descricao: type: string maxLength: 255 description: Descrição da classificação operação transporte abreviacao: type: string maxLength: 15 description: Abreviação da classificação operação transporte tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo operação modalTransporte: type: string allOf: – #/definitions/enumModalTransporte description: Modal transporte tipoServico: type: string allOf: – #/definitions/enumTipoServico description: Tipo serviço servicoPrestado: type: object allOf: – #/definitions/recEntidadeRelacionada description: Serviço prestado classificacaoOperacaoTransporteFacadeOutput: description: Classificação de Operação de Transporte type: object required: – codigo – descricao – abreviacao – tipoOperacao – modalTransporte – tipoServico – servicoPrestado properties: id: type: string description: Id da entidade codigo: type: integer format: int64 description: Código da classificação operação transporte descricao: type: string maxLength: 255 description: Descrição da classificação operação transporte abreviacao: type: string maxLength: 15 description: Abreviação da classificação operação transporte tipoOperacao: type: string allOf: – #/definitions/enumTipoOperacao description: Tipo operação modalTransporte: type: string allOf: – #/definitions/enumModalTransporte description: Modal transporte tipoServico: type: string allOf: – #/definitions/enumTipoServico description: Tipo serviço servicoPrestado: type: object allOf: – #/definitions/recFacadeServicosOutput description: Serviço prestado createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação componenteFreteFacadeInput: description: Componente Frete type: object required: – nome – abreviacao – descricao properties: id: type: string format: uuid description: Id da entidade nome: type: string maxLength: 255 description: Nome abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true componenteFreteFacadeOutput: description: Componente Frete type: object required: – nome – abreviacao – descricao properties: id: type: string description: Id da entidade nome: type: string maxLength: 255 description: Nome abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação componenteFreteImpostoFacadeInput: description: Componente Frete Imposto type: object required: – nome – abreviacao – descricao properties: id: type: string format: uuid description: Id da entidade nome: type: string maxLength: 255 description: Nome abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true componenteFreteImpostoFacadeOutput: description: Componente Frete Imposto type: object required: – nome – abreviacao – descricao properties: id: type: string description: Id da entidade nome: type: string maxLength: 255 description: Nome abreviacao: type: string maxLength: 15 description: Abreviação descricao: type: string description: Descrição ativo: type: boolean description: Situação default: true createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação gerarNumeracaoDocumentoTransportePorLoteFacade: description: Gerar Numeração Documento Transporte Por Lote type: object required: – idLote properties: idLote: type: string description: Id da entidade eventoDocumentoTransporteFacadeInput: description: Evento documento transporte type: object required: – documentoTransporte – sequencia – evento – situacao properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/recEntidadeRelacionada description: Documento Transporte sequencia: type: integer format: int64 description: Sequência evento: type: string allOf: – #/definitions/enumEvento description: EnumEvento situacao: type: string allOf: – #/definitions/enumEventoSituacao description: EnumEventoSituacao integracaoMensagem: type: string maxLength: 255 description: Mensagem de Integração integracaoCodigo: type: string maxLength: 50 description: Código de Integração eventoDocumentoTransporteFacadeOutput: description: Evento documento transporte type: object required: – documentoTransporte – sequencia – evento – situacao properties: id: type: string description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/recFacadeDocumentoTransporteOutput description: Documento Transporte sequencia: type: integer format: int64 description: Sequência evento: type: string allOf: – #/definitions/enumEvento description: EnumEvento situacao: type: string allOf: – #/definitions/enumEventoSituacao description: EnumEventoSituacao integracaoMensagem: type: string maxLength: 255 description: Mensagem de Integração integracaoCodigo: type: string maxLength: 50 description: Código de Integração createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação historicoDocumentoTransporteFacadeInput: description: Historico documento transporte type: object required: – documentoTransporte – sequencia properties: id: type: string format: uuid description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/recEntidadeRelacionada description: Documento Transporte sequencia: type: integer format: int64 description: Sequência dominioServico: type: string maxLength: 100 description: Domínio Serviço servicoNome: type: string maxLength: 100 description: Serviço Nome primitiva: type: string maxLength: 100 description: Primitiva primitivaInput: type: string maxLength: 255 description: Primitva Input descricao: type: string maxLength: 500 description: Descrição integracaoCodigo: type: string maxLength: 50 description: Integração Código integracaoMensagem: type: string maxLength: 255 description: Integração Mensagem historicoDocumentoTransporteFacadeOutput: description: Historico documento transporte type: object required: – documentoTransporte – sequencia properties: id: type: string description: Id da entidade documentoTransporte: type: object allOf: – #/definitions/recFacadeDocumentoTransporteOutput description: Documento Transporte sequencia: type: integer format: int64 description: Sequência dominioServico: type: string maxLength: 100 description: Domínio Serviço servicoNome: type: string maxLength: 100 description: Serviço Nome primitiva: type: string maxLength: 100 description: Primitiva primitivaInput: type: string maxLength: 255 description: Primitva Input descricao: type: string maxLength: 500 description: Descrição integracaoCodigo: type: string maxLength: 50 description: Integração Código integracaoMensagem: type: string maxLength: 255 description: Integração Mensagem createdBy: type: string description: Usuário de criação createdDate: type: string format: date-time description: Data de criação lastModifiedBy: type: string description: Usuário ultima modificação lastModifiedDate: type: string format: date-time description: Data ultima modificação emitirDocumentoTransporteFacade: description: Emitir Documento Transporte DFI type: object required: – idLote properties: idLote: type: string description: Id da entidade observacoes: type: string maxLength: 255 description: Observacoes variavelFacadeInput: description: Fachada Variavel type: object required: – nome properties: id: type: string format: uuid description: Id da variavel nome: type: string description: Nome da variavel variavelFacadeOutput: description: Fachada Variavel type: object required: – id – nome properties: id: type: string description: Id da variavel nome: type: string description: Nome da variavel componentesFreteDocumentoTransporteFacadeInput: description: Componentes de Frete do Documento de Transporte type: object required: – idDocumentoTransporte properties: idDocumentoTransporte: type: string description: Id do Documento de Transporte componentesFreteDocumentoTransporteFacadeOutput: description: Componentes de Frete do Documento de Transporte type: object required: – documentoTransporte – componenteFrete – valor properties: documentoTransporte: type: object allOf: – #/definitions/recFacadeDocumentoTransporteOutput description: Id do documento de transporte componenteFrete: type: object allOf: – #/definitions/recFacadeComponenteFreteOutput description: Id do componente de frete valor: type: number format: double description: Valor reprocessarLoteFacade: description: Reprocessar as etapas de criação ou emissão do documento type: object required: – idLote properties: idLote: type: string description: Id da entidade cancelarDocumentoTransporteFacade: description: Cancelar Documento Transporte type: object required: – idLote – motivoCancelamento properties: idLote: type: string description: Id do Lote motivoCancelamento: type: string maxLength: 255 description: Motivo do Cancelamento verificarAcoesLoteFacadeInput: description: Verificar ações do lote type: object required: – idLote properties: idLote: type: string description: Id do Lote verificarAcoesLoteFacadeOutput: description: Verificar ações do lote type: object required: – cancelar – reprocessar – emitir properties: cancelar: type: boolean description: Cancelar reprocessar: type: boolean description: Reprocessar emitir: type: boolean description: Emitir impostosDocumentoTransporteFacadeInput: description: Impostos do Documento de Transporte type: object properties: id: type: string format: uuid description: Id do Documento de Transporte impostosDocumentoTransporteFacadeOutput: description: Impostos do Documento de Transporte type: object required: – impostos properties: impostos: type: object allOf: – #/definitions/recImpostos description: Impostos informacoesComplementaresDocumentoTransporteFacadeInput: description: Fachada Informações complementares documento transporte type: object required: – documentoTransporte properties: documentoTransporte: type: string format: uuid description: documentoTransporte informacoesComplementaresDocumentoTransporteFacadeOutput: description: Fachada Informações complementares documento transporte type: object required: – cfop – operacao properties: cfop: type: integer format: int64 description: CFOP operacao: type: object allOf: – #/definitions/recFacadeOperacoesOutput description: Operação genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage