2.0info: 1.3.0 importer description: Serviços relacionados a importação de cte x-senior-domain: edocsx_cte x-senior-domain-path: edocsx_cte x-senior-service-path: importer 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/edocsx_ctesecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /importer/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 /importer/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 /importer/queries/exportE007ufs: 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 /importer/queries/exportImportation: 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 /importer/queries/exportImportationDocument: 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 /importer/queries/exportE070emp: 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 /importer/queries/exportE008rai: 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 /importer/queries/exportE070fil: 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 /importer/queries/exportE070empCertificate: 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 /importer/queries/exportE070filCertificate: 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 /importer/queries/exportOutgoingTransportInvoice: 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 /importer/queries/exportOutgoingTransportInvoiceXml: 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 /importer/queries/exportOutgoingTransportInvoiceRejection: 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 /importer/queries/exportOutgoingTransportDocumentHistory: 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 /importer/queries/exportOutgoingTransportHistoryDetails: 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 /importer/queries/exportIncomingTransportInvoice: 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 /importer/queries/exportIncomingTransportInvoiceXml: 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 /importer/queries/exportIncomingTransportInvoiceRejection: 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 /importer/queries/exportEventIncomingTransportInvoice: 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 /importer/queries/exportEventIncomingTransportInvoiceXml: 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 /importer/queries/exportEventIncomingTransportInvoiceRejection: 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 /importer/queries/exportIncomingTransportDocumentHistory: 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 /importer/queries/exportIncomingTransportHistoryDetails: 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 /importer/queries/exportEventIncomingTransportDocumentHistory: 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 /importer/queries/exportEventIncomingTransportHistoryDetails: 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 /importer/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 /importer/actions/prepareDocumentsToImport: post: description: Cria tabela de controle para importação de documentos eletronicos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: fileNames: type: array items: type: string description: Nome do arquivo que será enviado checkStatusDocuments: type: boolean description: Verificar status dos documentos de importação(executa consulta na sefaz) default: false alertDocumentsSituation: type: boolean description: Emitir evento de importação default: false responses: 200: description: Ok schema: type: object required: – response properties: response: type: object allOf: – #/definitions/prepareDocumentsToImportResponse description: Lista de registro com dados da importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/actions/requestUploadUrlToImportDocumentBatchMode: post: description: Retorna upload url (em lote) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: idsImportationDocuments: type: array items: type: string description: Lista de IDs dos documentos de importação responses: 200: description: Ok schema: type: object required: – response properties: response: type: array items: type: object allOf: – #/definitions/requestUploadUrlToImportDocumentResponse minimum: 1 description: Lista de registro com dados da importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/actions/requestUploadUrlToImportDocument: post: description: Retorna upload url tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idImportationDocument properties: idImportationDocument: type: string description: Nome do arquivo que será enviado responses: 200: description: Ok schema: type: object required: – response properties: response: type: object allOf: – #/definitions/requestUploadUrlToImportDocumentResponse description: Registro com dados da importação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/actions/commitDocumentToImport: post: description: Endpoint para fazer o commit do arquivo de importação tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idImportationDocument properties: idImportationDocument: type: string description: Id Importation Document responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/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 /importer/actions/importE007ufs: 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 /importer/actions/importImportation: 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 /importer/actions/importImportationDocument: 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 /importer/actions/importE070emp: 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 /importer/actions/importE008rai: 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 /importer/actions/importE070fil: 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 /importer/actions/importE070empCertificate: 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 /importer/actions/importE070filCertificate: 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 /importer/actions/importOutgoingTransportInvoice: 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 /importer/actions/importOutgoingTransportInvoiceXml: 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 /importer/actions/importOutgoingTransportInvoiceRejection: 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 /importer/actions/importOutgoingTransportDocumentHistory: 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 /importer/actions/importOutgoingTransportHistoryDetails: 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 /importer/actions/importIncomingTransportInvoice: 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 /importer/actions/importIncomingTransportInvoiceXml: 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 /importer/actions/importIncomingTransportInvoiceRejection: 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 /importer/actions/importEventIncomingTransportInvoice: 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 /importer/actions/importEventIncomingTransportInvoiceXml: 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 /importer/actions/importEventIncomingTransportInvoiceRejection: 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 /importer/actions/importIncomingTransportDocumentHistory: 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 /importer/actions/importIncomingTransportHistoryDetails: 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 /importer/actions/importEventIncomingTransportDocumentHistory: 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 /importer/actions/importEventIncomingTransportHistoryDetails: 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 /importer/signals/startImportationDocument: post: description: Endpoint que inicia o processo de importação dos documentos tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idImportation properties: idImportation: type: string description: Id Importation responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /importer/signals/executeImportationDocument: post: description: Endpoint que executa a importação do xml tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idImportationDocument properties: idImportationDocument: type: string description: Id Importation Document checkStatusDocument: type: boolean description: Verificar status do documento de importação default: false alertDocumentSituation: type: boolean description: Emitir evento de importação default: false responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /importer/signals/completeImportationProcess: post: description: Finalizar processo de importação tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idImportationDocument properties: idImportationDocument: type: string description: Id Importation Document responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /importer/signals/registerImportationDocumentError: post: description: Registrar erro de documento de importação tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idImportationDocument – errorMessage properties: idImportationDocument: type: string description: Id Importation Document accessKey: type: string description: Chave de acesso do documento importationDocumentType: type: string allOf: – #/definitions/importationDocumentType description: tipo do documento a ser importado errorMessage: type: string description: Mensagem de erro responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /importer/signals/runImportIncomingTransportInvoice: post: description: Endpoint responsável pelo processo de importação dos conhecimentos de transportes de entrada tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – branchId – xml properties: branchId: type: string description: Identificador da filial xml: type: string description: XML da nota fiscal de entrada nsuId: type: string description: Identificador do nsu responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /importer/events/importationDocumentChanged: post: description: Evento para atualizar a tela de monitoramento dos CT-e – websocket x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – importationDocument properties: importationDocument: type: object allOf: – #/definitions/importationDocumentDTO description: Informações do documento de importação responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /importer/events/notifyStatusImportedIncomingTransportInvoice: post: description: Evento para notificar o status da importação do CTe x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nsuId – accessKey properties: incomingInvoiceId: type: string description: Identificador do CTe nsuId: type: string description: Identificador do nsu accessKey: type: string description: Chave de acesso do CTe situation: type: string allOf: – #/definitions/enumTransportInvoiceSituation description: Situação do CTe processingDate: type: string format: date-time description: Data de processamento do CTe processingFailed: type: boolean description: Houve erro na importação? default: false errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /importer/events/notifyStatusImportedIncomingTransportEvent: post: description: Evento para notificar o status da importação do evento do CTe x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – nsuId – eventAccessKey properties: incomingEventId: type: string description: Identificador do evento do CTe nsuId: type: string description: Identificador do nsu eventAccessKey: type: string description: Chave de acesso do evento do CTe situation: type: string allOf: – #/definitions/enumTransportEventSituation description: Situação do evento processingDate: type: string format: date-time description: Data de processamento do evento processingFailed: type: boolean description: Houve erro na importação? default: false errorMessage: type: string description: Mensagem de erro responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /importer/events/importE007ufsEvent: 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 /importer/events/exportE007ufsEvent: 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 /importer/events/importImportationEvent: 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 /importer/events/exportImportationEvent: 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 /importer/events/importImportationDocumentEvent: 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 /importer/events/exportImportationDocumentEvent: 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 /importer/events/importE070empEvent: 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 /importer/events/exportE070empEvent: 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 /importer/events/importE008raiEvent: 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 /importer/events/exportE008raiEvent: 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 /importer/events/importE070filEvent: 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 /importer/events/exportE070filEvent: 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 /importer/events/importE070empCertificateEvent: 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 /importer/events/exportE070empCertificateEvent: 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 /importer/events/importE070filCertificateEvent: 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 /importer/events/exportE070filCertificateEvent: 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 /importer/events/importOutgoingTransportInvoiceEvent: 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 /importer/events/exportOutgoingTransportInvoiceEvent: 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 /importer/events/importOutgoingTransportInvoiceXmlEvent: 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 /importer/events/exportOutgoingTransportInvoiceXmlEvent: 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 /importer/events/importOutgoingTransportInvoiceRejectionEvent: 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 /importer/events/exportOutgoingTransportInvoiceRejectionEvent: 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 /importer/events/importOutgoingTransportDocumentHistoryEvent: 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 /importer/events/exportOutgoingTransportDocumentHistoryEvent: 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 /importer/events/importOutgoingTransportHistoryDetailsEvent: 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 /importer/events/exportOutgoingTransportHistoryDetailsEvent: 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 /importer/events/importIncomingTransportInvoiceEvent: 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 /importer/events/exportIncomingTransportInvoiceEvent: 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 /importer/events/importIncomingTransportInvoiceXmlEvent: 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 /importer/events/exportIncomingTransportInvoiceXmlEvent: 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 /importer/events/importIncomingTransportInvoiceRejectionEvent: 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 /importer/events/exportIncomingTransportInvoiceRejectionEvent: 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 /importer/events/importEventIncomingTransportInvoiceEvent: 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 /importer/events/exportEventIncomingTransportInvoiceEvent: 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 /importer/events/importEventIncomingTransportInvoiceXmlEvent: 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 /importer/events/exportEventIncomingTransportInvoiceXmlEvent: 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 /importer/events/importEventIncomingTransportInvoiceRejectionEvent: 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 /importer/events/exportEventIncomingTransportInvoiceRejectionEvent: 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 /importer/events/importIncomingTransportDocumentHistoryEvent: 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 /importer/events/exportIncomingTransportDocumentHistoryEvent: 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 /importer/events/importIncomingTransportHistoryDetailsEvent: 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 /importer/events/exportIncomingTransportHistoryDetailsEvent: 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 /importer/events/importEventIncomingTransportDocumentHistoryEvent: 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 /importer/events/exportEventIncomingTransportDocumentHistoryEvent: 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 /importer/events/importEventIncomingTransportHistoryDetailsEvent: 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 /importer/events/exportEventIncomingTransportHistoryDetailsEvent: 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 /importer/entities/e007ufs: 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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e007ufs/{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/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/importation: 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/importation responses: 200: description: The created resource schema: #/definitions/importation 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/importation responses: 200: description: The created resource schema: #/definitions/importation 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/importation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/importation/{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/editImportation responses: 200: description: Ok schema: #/definitions/editImportation 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/importation responses: 200: description: Ok schema: #/definitions/importation 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/importation 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 /importer/entities/importation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/importation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/importationDocument: 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/importationDocument responses: 200: description: The created resource schema: #/definitions/importationDocument 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/importationDocument responses: 200: description: The created resource schema: #/definitions/importationDocument 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/importationDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/importationDocument/{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/editImportationDocument responses: 200: description: Ok schema: #/definitions/editImportationDocument 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/importationDocument responses: 200: description: Ok schema: #/definitions/importationDocument 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/importationDocument 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 /importer/entities/importation/{parentId}/importationDocuments: 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: array items: #/definitions/importationDocument responses: 200: description: The created resources schema: type: array items: #/definitions/importationDocument 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: array items: #/definitions/importationDocument responses: 200: description: The created resources schema: type: array items: #/definitions/importationDocument 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/importationDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/importation/{parentId}/importationDocuments/{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/editImportationDocument responses: 200: description: Ok schema: #/definitions/editImportationDocument 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/importationDocument responses: 200: description: Ok schema: #/definitions/importationDocument 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/importationDocument 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 /importer/entities/importationDocument/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/importationDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070emp: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070emp/{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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e008rai: 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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e008rai/{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/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070fil: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070fil/{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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070empCertificate: 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/e070empCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070empCertificate/{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/e070empCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070filCertificate: 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/e070filCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/e070filCertificate/{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/e070filCertificate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoice: 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/outgoingTransportInvoice responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoice 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/outgoingTransportInvoice responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoice 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/outgoingTransportInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoice/{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/editOutgoingTransportInvoice responses: 200: description: Ok schema: #/definitions/editOutgoingTransportInvoice 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/outgoingTransportInvoice responses: 200: description: Ok schema: #/definitions/outgoingTransportInvoice 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/outgoingTransportInvoice 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 /importer/entities/outgoingTransportInvoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingTransportInvoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoiceXml: 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/outgoingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoiceXml/{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/editOutgoingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/editOutgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/outgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml 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 /importer/entities/outgoingTransportInvoice/{parentId}/invoiceXmls: 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: array items: #/definitions/outgoingTransportInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingTransportInvoiceXml 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: array items: #/definitions/outgoingTransportInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/outgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoice/{parentId}/invoiceXmls/{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/editOutgoingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/editOutgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/outgoingTransportInvoiceXml 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/outgoingTransportInvoiceXml 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 /importer/entities/outgoingTransportInvoiceXml/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingTransportInvoiceXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoiceRejection: 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/outgoingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoiceRejection/{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/editOutgoingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/editOutgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/outgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection 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 /importer/entities/outgoingTransportInvoice/{parentId}/outgoingTransportInvoiceRejection: 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/outgoingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/outgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportInvoice/{parentId}/outgoingTransportInvoiceRejection/{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/editOutgoingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/editOutgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/outgoingTransportInvoiceRejection 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/outgoingTransportInvoiceRejection 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 /importer/entities/outgoingTransportInvoiceRejection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingTransportInvoiceRejection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportDocumentHistory: 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/outgoingTransportDocumentHistory responses: 200: description: The created resource schema: #/definitions/outgoingTransportDocumentHistory 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/outgoingTransportDocumentHistory responses: 200: description: The created resource schema: #/definitions/outgoingTransportDocumentHistory 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/outgoingTransportDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportDocumentHistory/{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/editOutgoingTransportDocumentHistory responses: 200: description: Ok schema: #/definitions/editOutgoingTransportDocumentHistory 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/outgoingTransportDocumentHistory responses: 200: description: Ok schema: #/definitions/outgoingTransportDocumentHistory 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/outgoingTransportDocumentHistory 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 /importer/entities/outgoingTransportDocumentHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingTransportDocumentHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportHistoryDetails: 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/outgoingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportHistoryDetails/{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/editOutgoingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/editOutgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/outgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails 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 /importer/entities/outgoingTransportDocumentHistory/{parentId}/historyDetails: 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/outgoingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/outgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/outgoingTransportDocumentHistory/{parentId}/historyDetails/{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/editOutgoingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/editOutgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/outgoingTransportHistoryDetails 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/outgoingTransportHistoryDetails 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 /importer/entities/outgoingTransportHistoryDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/outgoingTransportHistoryDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoice: 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/incomingTransportInvoice responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoice 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/incomingTransportInvoice responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoice 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/incomingTransportInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoice/{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/editIncomingTransportInvoice responses: 200: description: Ok schema: #/definitions/editIncomingTransportInvoice 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/incomingTransportInvoice responses: 200: description: Ok schema: #/definitions/incomingTransportInvoice 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/incomingTransportInvoice 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 /importer/entities/incomingTransportInvoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/incomingTransportInvoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoiceXml: 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/incomingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceXml 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/incomingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceXml 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/incomingTransportInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoiceXml/{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/editIncomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/editIncomingTransportInvoiceXml 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/incomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/incomingTransportInvoiceXml 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/incomingTransportInvoiceXml 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 /importer/entities/incomingTransportInvoice/{parentId}/transportXml: 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/incomingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceXml 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/incomingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceXml 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/incomingTransportInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoice/{parentId}/transportXml/{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/editIncomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/editIncomingTransportInvoiceXml 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/incomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/incomingTransportInvoiceXml 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/incomingTransportInvoiceXml 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 /importer/entities/incomingTransportInvoiceXml/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/incomingTransportInvoiceXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoiceRejection: 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/incomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoiceRejection/{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/editIncomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/editIncomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/incomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection 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 /importer/entities/incomingTransportInvoice/{parentId}/transportInvoiceRejection: 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/incomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/incomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoice/{parentId}/transportInvoiceRejection/{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/editIncomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/editIncomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/incomingTransportInvoiceRejection 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/incomingTransportInvoiceRejection 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 /importer/entities/incomingTransportInvoiceRejection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/incomingTransportInvoiceRejection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoice: 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/eventIncomingTransportInvoice responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoice 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/eventIncomingTransportInvoice responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoice 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/eventIncomingTransportInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoice/{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/editEventIncomingTransportInvoice responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportInvoice 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/eventIncomingTransportInvoice responses: 200: description: Ok schema: #/definitions/eventIncomingTransportInvoice 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/eventIncomingTransportInvoice 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 /importer/entities/incomingTransportInvoice/{parentId}/eventsTransportInvoice: 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: array items: #/definitions/eventIncomingTransportInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/eventIncomingTransportInvoice 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: array items: #/definitions/eventIncomingTransportInvoice responses: 200: description: The created resources schema: type: array items: #/definitions/eventIncomingTransportInvoice 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/eventIncomingTransportInvoice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportInvoice/{parentId}/eventsTransportInvoice/{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/editEventIncomingTransportInvoice responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportInvoice 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/eventIncomingTransportInvoice responses: 200: description: Ok schema: #/definitions/eventIncomingTransportInvoice 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/eventIncomingTransportInvoice 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 /importer/entities/eventIncomingTransportInvoice/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventIncomingTransportInvoice responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoiceXml: 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/eventIncomingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoiceXml/{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/editEventIncomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/eventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml 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 /importer/entities/eventIncomingTransportInvoice/{parentId}/eventXmls: 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: array items: #/definitions/eventIncomingTransportInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/eventIncomingTransportInvoiceXml 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: array items: #/definitions/eventIncomingTransportInvoiceXml responses: 200: description: The created resources schema: type: array items: #/definitions/eventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoice/{parentId}/eventXmls/{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/editEventIncomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml responses: 200: description: Ok schema: #/definitions/eventIncomingTransportInvoiceXml 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/eventIncomingTransportInvoiceXml 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 /importer/entities/eventIncomingTransportInvoiceXml/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventIncomingTransportInvoiceXml responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoiceRejection: 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/eventIncomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoiceRejection/{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/editEventIncomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/eventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection 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 /importer/entities/eventIncomingTransportInvoice/{parentId}/eventTransportInvoiceRejection: 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/eventIncomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportInvoice/{parentId}/eventTransportInvoiceRejection/{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/editEventIncomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection responses: 200: description: Ok schema: #/definitions/eventIncomingTransportInvoiceRejection 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/eventIncomingTransportInvoiceRejection 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 /importer/entities/eventIncomingTransportInvoiceRejection/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventIncomingTransportInvoiceRejection responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportDocumentHistory: 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/incomingTransportDocumentHistory responses: 200: description: The created resource schema: #/definitions/incomingTransportDocumentHistory 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/incomingTransportDocumentHistory responses: 200: description: The created resource schema: #/definitions/incomingTransportDocumentHistory 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/incomingTransportDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportDocumentHistory/{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/editIncomingTransportDocumentHistory responses: 200: description: Ok schema: #/definitions/editIncomingTransportDocumentHistory 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/incomingTransportDocumentHistory responses: 200: description: Ok schema: #/definitions/incomingTransportDocumentHistory 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/incomingTransportDocumentHistory 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 /importer/entities/incomingTransportDocumentHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/incomingTransportDocumentHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportHistoryDetails: 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/incomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/incomingTransportHistoryDetails 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/incomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/incomingTransportHistoryDetails 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/incomingTransportHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportHistoryDetails/{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/editIncomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/editIncomingTransportHistoryDetails 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/incomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/incomingTransportHistoryDetails 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/incomingTransportHistoryDetails 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 /importer/entities/incomingTransportDocumentHistory/{parentId}/historyDetails: 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/incomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/incomingTransportHistoryDetails 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/incomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/incomingTransportHistoryDetails 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/incomingTransportHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/incomingTransportDocumentHistory/{parentId}/historyDetails/{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/editIncomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/editIncomingTransportHistoryDetails 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/incomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/incomingTransportHistoryDetails 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/incomingTransportHistoryDetails 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 /importer/entities/incomingTransportHistoryDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/incomingTransportHistoryDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportDocumentHistory: 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/eventIncomingTransportDocumentHistory responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportDocumentHistory 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/eventIncomingTransportDocumentHistory responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportDocumentHistory 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/eventIncomingTransportDocumentHistory 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportDocumentHistory/{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/editEventIncomingTransportDocumentHistory responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportDocumentHistory 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/eventIncomingTransportDocumentHistory responses: 200: description: Ok schema: #/definitions/eventIncomingTransportDocumentHistory 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/eventIncomingTransportDocumentHistory 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 /importer/entities/eventIncomingTransportDocumentHistory/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventIncomingTransportDocumentHistory responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportHistoryDetails: 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/eventIncomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportHistoryDetails/{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/editEventIncomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/eventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails 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 /importer/entities/eventIncomingTransportDocumentHistory/{parentId}/historyDetails: 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/eventIncomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails responses: 200: description: The created resource schema: #/definitions/eventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /importer/entities/eventIncomingTransportDocumentHistory/{parentId}/historyDetails/{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/editEventIncomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/editEventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails responses: 200: description: Ok schema: #/definitions/eventIncomingTransportHistoryDetails 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/eventIncomingTransportHistoryDetails 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 /importer/entities/eventIncomingTransportHistoryDetails/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventIncomingTransportHistoryDetails responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down statusImportation: type: string enum: – RECEIVED – IN_PROGRESS – COMPLETED_SUCCESSFULLY – COMPLETED_WITH_ERROR description: Status da importação: * `RECEIVED` – Recebido * `IN_PROGRESS` – Em processamento * `COMPLETED_SUCCESSFULLY` – Finalizado com sucesso * `COMPLETED_WITH_ERROR` – Finalizado com erro statusDocumentImportation: type: string enum: – SUCCESS – ERROR – READY_TO_COMMIT – READY_TO_IMPORT – PARTIAL_SUCCESS description: Status da importação: * `SUCCESS` – Sucesso * `ERROR` – Erro * `READY_TO_COMMIT` – Pronto para consolidar * `READY_TO_IMPORT` – Pronto para importação * `PARTIAL_SUCCESS` – Sucesso Parcial importationDocumentType: type: string enum: – CTE – EVENT_CCE – EVENT_NULLIFICATION – EVENT_CANCELLATION description: Tipo de documento de importação: * `CTE` – CTe * `EVENT_CCE` – Evento de carta de correção * `EVENT_NULLIFICATION` – Evento de inutilização * `EVENT_CANCELLATION` – Evento de cancelamento enumTransportInvoiceType: type: string enum: – CTE_NORMAL – COMPLEMENTARY_VALUES – ANNULMENT – SUBSTITUTE description: Tipo de CTe: * `CTE_NORMAL` – CTe Normal * `COMPLEMENTARY_VALUES` – CTe de Complemento de Valores * `ANNULMENT` – CTe de Anulação * `SUBSTITUTE` – CTe Substituto enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física environmentType: type: string enum: – PROD – HOMOLOG – DISABLED description: Tipo de aplicação do ambiente: * `PROD` – Produção * `HOMOLOG` – Homolog * `DISABLED` – Desativado enumInvoiceType: type: string enum: – INCOMING – OUTGOING description: Tipo da CTe: * `INCOMING` – CTe de entrada * `OUTGOING` – CTe de saída enumTransportInvoiceSituation: type: string enum: – AUTHORIZED – CANCELED – REJECTED – RECEIVED – IN_PROGRESS – NULLIFIED – SEFAZ_CONNECTION_FAILURE – WAITING_FOR_SEFAZ – DISCARDED – EPEC_REGISTERED – ARCHIVED – WAITING_FOR_EPEC_CONCILIATION – REJECTED_EPEC_NOT_FOUND – XML_NOT_RECEIVED – XML_NOT_RECEIVED_CANCELED description: Situação do CTe: * `AUTHORIZED` – CTe autorizado * `CANCELED` – CTe cancelado * `REJECTED` – CTe rejeitado * `RECEIVED` – CTe recebido * `IN_PROGRESS` – CTe em processamento * `NULLIFIED` – CTe inutilizado * `SEFAZ_CONNECTION_FAILURE` – Falha de Conexão com a SEFAZ * `WAITING_FOR_SEFAZ` – CTe aguardando sefaz * `DISCARDED` – CTe descartado * `EPEC_REGISTERED` – Registrado EPEC * `ARCHIVED` – CTe arquivado * `WAITING_FOR_EPEC_CONCILIATION` – Aguardando conciliação EPEC * `REJECTED_EPEC_NOT_FOUND` – CTe rejeitado. Sem EPEC correspondente * `XML_NOT_RECEIVED` – XML não recebido * `XML_NOT_RECEIVED_CANCELED` – XML não recebido – Cancelado enumTransportInvoicePurpose: type: string enum: – REGULAR – COMPLEMENTARY – ADJUSTMENT – RETURN – SUBSTITUTION – ANNULMENT description: Finalidade do CTe: * `REGULAR` – CTe normal * `COMPLEMENTARY` – CTe complementar * `ADJUSTMENT` – CTe de ajuste * `RETURN` – CTe de devolução * `SUBSTITUTION` – CTe de substituição * `ANNULMENT` – CTe de anulação enumTransportInvoiceServiceType: type: string enum: – REGULAR – SUBCONTRACTING – REDISPATCH – REDISPATCH_INTERMEDIATE – MULTIMODAL_LINKED description: Tipo de serviço do CT-e: * `REGULAR` – Serviço normal * `SUBCONTRACTING` – Subcontratação * `REDISPATCH` – Redespacho * `REDISPATCH_INTERMEDIATE` – Redespacho intermediário * `MULTIMODAL_LINKED` – Multimodal vinculado enumTransportModal: type: string enum: – ROAD – AIR – WATER – RAIL – PIPELINE – MULTIMODAL description: Modal de transporte: * `ROAD` – Rodoviário * `AIR` – Aéreo * `WATER` – Aquaviário * `RAIL` – Ferroviário * `PIPELINE` – Dutoviário * `MULTIMODAL` – Multimodal enumTakerType: type: string enum: – SENDER – SHIPPER – RECEIVER – RECIPIENT – OTHERS description: Tipo do tomador do CT-e: * `SENDER` – Remetente * `SHIPPER` – Expedidor * `RECEIVER` – Recebedor * `RECIPIENT` – Destinatário * `OTHERS` – Outros enumTransportEventSituation: type: string enum: – AUTHORIZED – CANCELED – REJECTED – RECEIVED – IN_PROGRESS – SEFAZ_CONNECTION_FAILURE description: Situação do evento de transporte: * `AUTHORIZED` – Evento autorizado * `CANCELED` – Evento cancelado * `REJECTED` – Evento rejeitado * `RECEIVED` – Evento recebido * `IN_PROGRESS` – Evento em processamento * `SEFAZ_CONNECTION_FAILURE` – Falha de conexão com a SEFAZ enumXmlType: type: string enum: – AUTHORIZED – INTEGRATED – EPEC_INTEGRATED – EPEC_AUTHORIZED description: Tipo do XML: * `AUTHORIZED` – Autorizado * `INTEGRATED` – Integrado * `EPEC_INTEGRATED` – EPEC integrado * `EPEC_AUTHORIZED` – EPEC Autorizado enumEventAuthor: type: string enum: – ISSUER – TAKER enumEventType: type: string enum: – E110110 – E110111 – E110113 – E110160 – E110170 – E110180 – E110181 – E310620 – E510620 – E310610 – E310611 – E240130 – E240131 – E240140 – E240160 – E240170 – E240180 – E240181 – E440130 – E440140 – E440150 – E440160 – E610110 – E610111 description: Tipo do evento do CT-e: * `E110110` – Carta de Correcao * `E110111` – Cancelamento * `E110113` – EPEC * `E110160` – Registros do Multimodal * `E110170` – Informacoes da GTV * `E110180` – Comprovante de Entrega * `E110181` – Cancelamento do Comprovante de Entrega * `E310620` – Registro de Passagem * `E510620` – Registro de Passagem Automatico * `E310610` – MDFe Autorizado * `E310611` – MDFe Cancelado * `E240130` – Autorizado CTe complementar * `E240131` – Cancelado CTe complementar * `E240140` – CTe de Substituicao * `E240160` – Liberacao de EPEC * `E240170` – Liberacao Prazo Cancelamento * `E240180` – Autorizado CTe OS * `E240181` – Cancelado CTe OS * `E440130` – Autorizado Redespacho * `E440140` – Autorizado Redespacho intermediario * `E440150` – Autorizado Subcontratacao * `E440160` – Autorizado Servico Vinculado Multimodal * `E610110` – Prestacao do Servico em Desacordo * `E610111` – Cancelamento da Prestacao do Servico em Desacordo enumIssuanceType: type: string enum: – REGULAR – CONTINGENCY_FS_IA – CONTINGENCY_SCAN – CONTINGENCY_EPEC – CONTINGENCY_FS_DA – CONTINGENCY_SVC_AN – CONTINGENCY_SVC_RS – CONTINGENCY_OFFLINE description: Tipo de emissão do CTe: * `REGULAR` – Emissão normal * `CONTINGENCY_FS_IA` – Contingência FS-IA * `CONTINGENCY_SCAN` – Contingência SCAN * `CONTINGENCY_EPEC` – Contingência EPEC * `CONTINGENCY_FS_DA` – Contingência FS-DA * `CONTINGENCY_SVC_AN` – Contingência SVC-AN * `CONTINGENCY_SVC_RS` – Contingência SVC-RS * `CONTINGENCY_OFFLINE` – Contingência off-line documentType: type: string enum: – CNPJ – CPF description: Tipo de documento: * `CNPJ` – CNPJ * `CPF` – CPF enumTransportInvoiceCreationType: type: string enum: – INTEGRATION – IMPORTATION – MIGRATION description: Enum tipo de origem da criação do documento: * `INTEGRATION` – Origem de integração * `IMPORTATION` – Origem de importação * `MIGRATION` – Origem de migração enumTransportInvoiceLayout: type: string enum: – CTE – CTE_OS – CTE_SIMP enumBranchRoleTransportInvoice: type: string enum: – SENDER – SHIPPER – RECEIVER – RECIPIENT – TAKER – UNDEFINED description: Enum do papel da filial em uma CT-e de entrada: * `SENDER` – Filial é remetente da carga * `SHIPPER` – Filial é expedidora * `RECEIVER` – Filial é recebedora * `RECIPIENT` – Filial é destinatária * `TAKER` – Filial é tomadora do serviço * `UNDEFINED` – Filial não tem papel definido userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck prepareDocumentsToImportResponse: description: Record de resposta da criação das tabelas de controle de importação type: object required: – idImportation – importationsDocuments properties: idImportation: type: string description: Id da importação importationsDocuments: type: array items: type: object allOf: – #/definitions/importationsDocumentsResponse minimum: 1 description: Lista de documentos de importação importationsDocumentsResponse: description: Record de resposta com os dados do documento de importação type: object required: – importationDocument – fileName properties: importationDocument: type: string description: Id da importação do documento fileName: type: string description: Nome do arquivo que será enviado requestUploadUrlToImportDocumentResponse: description: Record de resposta com os dados do blobservice type: object required: – idImportation – idImportationDocument – fileName – targetObjectId – version – url properties: idImportation: type: string description: Id da importação idImportationDocument: type: string description: Id da importação do documento fileName: type: string description: Nome do arquivo targetObjectId: type: string description: ID do arquivo no blobService type: string description: Versão do arquivo url: type: string description: Url completa do arquivo importationDocumentDTO: description: Record do documento de importação type: object required: – id – status – dthalt properties: id: type: string description: ID do documento de importação fileName: type: string description: Nome do arquivo importado status: type: string allOf: – #/definitions/statusDocumentImportation description: Status da importação generatedKey: type: string description: Chave gerada generatedDocumentType: type: string allOf: – #/definitions/importationDocumentType description: Tipo do documento gerado errorMessage: type: string description: Mensagem de erro dthalt: type: string format: date-time description: Horario da última atualização importation: type: object allOf: – #/definitions/importationDTO description: Importação importationDTO: description: Record da importação type: object required: – id – status properties: id: type: string description: id da importaçao status: type: string allOf: – #/definitions/statusImportation description: Status da importação e007ufs: description: Estado type: object properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome code: type: integer format: int64 description: Código estado minimum: 0 maximum: 9999999 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: importation: description: Entidade que armazana as importações de CTe type: object required: – requestDate – status – batchSeq properties: id: type: string format: uuid description: ID da importação requestDate: type: string format: date-time description: Data da requisição completionDate: type: string format: date-time description: Data da finalização checkStatusDocuments: type: boolean description: Verificar status do documento de importação default: false alertDocumentsSituation: type: boolean description: Emitir evento de importação default: false numberOfDocuments: type: integer format: int64 description: Numero de documentos de importação default: 0 status: type: string allOf: – #/definitions/statusImportation description: Status da importação batchSeq: type: integer format: int64 description: Sequencia do lote de importação importationDocuments: type: array items: type: object allOf: – #/definitions/importationDocument description: Documentos de importação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editImportation: type: object required: – id allOf: – #/definitions/importation importationDocument: description: Entidade que armazana as importações de CTe type: object required: – status properties: id: type: string format: uuid description: ID do documento de importação name: type: string description: Nome do documento de importação status: type: string allOf: – #/definitions/statusDocumentImportation description: Status da importação generatedKey: type: string description: Chave gerada generatedDocumentType: type: string allOf: – #/definitions/importationDocumentType description: Tipo do documento gerado fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo importation: type: object allOf: – #/definitions/importation description: Importação errorMessage: type: string description: Mensagem de erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editImportationDocument: type: object required: – id allOf: – #/definitions/importationDocument e070emp: description: Empresa type: object properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome 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 e070empCertificate: type: object allOf: – #/definitions/e070empCertificate description: Certificado eDocs X usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e008rai: description: Cidade type: object properties: id: type: string format: uuid description: Id da entidade nomCid: type: string maxLength: 60 description: Nome cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado codIbg: type: integer format: int64 description: Código IBGE município minimum: 0 maximum: 9999999 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa e008rai: type: object allOf: – #/definitions/e008rai description: Código cidade ISS numCgc: type: string maxLength: 18 description: CPF/CNPJ 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 e070filCertificate: type: object allOf: – #/definitions/e070filCertificate description: Certificado eDocs X usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070empCertificate: description: Certificado de eDocs X para Empresa type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo expirationDate: type: string format: date-time description: Data de validade subject: type: string description: Nome do certificado issuedBy: type: string description: Certificado emitido por issuedTo: type: string description: Certificado emitido para privateKey: type: boolean description: Chave privada password: type: string description: Senha do certificado validCertificateChain: type: boolean description: Cadeia de certificados válida extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false fileNameExt: type: string description: Nome do arquivo extendido targetObjectIdExt: type: string description: Id do arquivo extendido versionExt: type: string description: Versão do arquivo extendido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filCertificate: description: Certificado de eDocs X para Filial type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial fileName: type: string description: Nome do arquivo targetObjectId: type: string description: Id do arquivo type: string description: Versão do arquivo expirationDate: type: string format: date-time description: Data de validade subject: type: string description: Nome do certificado issuedBy: type: string description: Certificado emitido por issuedTo: type: string description: Certificado emitido para privateKey: type: boolean description: Chave privada password: type: string description: Senha do certificado validCertificateChain: type: boolean description: Cadeia de certificados válida extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false fileNameExt: type: string description: Nome do arquivo extendido targetObjectIdExt: type: string description: Id do arquivo extendido versionExt: type: string description: Versão do arquivo extendido usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: outgoingTransportInvoice: description: CT-e de saída type: object required: – accessKey – situation – series – number – version – issueDateTime – serviceType – modal – issuerCorporateName – issuerDocument – issuerStateRegistration – recipientDocument – takerType – totalServiceValue – processingDate – finalProcessDate – environmentType – creationType properties: id: type: string format: uuid description: ID do CT-e e070fil: type: object allOf: – #/definitions/e070fil description: Filial accessKey: type: string description: Chave de acesso do CT-e situation: type: string allOf: – #/definitions/enumTransportInvoiceSituation description: Situação do CT-e series: type: integer format: int64 description: Série do CT-e number: type: integer format: int64 description: Número do CT-e type: string description: Versão do CT-e issueDateTime: type: string format: date-time description: Data de emissão do CT-e transportInvoiceType: type: string allOf: – #/definitions/enumTransportInvoiceType description: Tipo de CTe serviceType: type: string description: Tipo de serviço modal: type: string description: Modal issuerCorporateName: type: string description: Razão Social do Emissor issuerDocument: type: string description: Documento do Emissor issuerDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Emissor issuerStateRegistration: type: string description: Inscrição Estadual do Emissor senderCorporateName: type: string description: Razão Social do Remetente senderDocument: type: string description: Documento do Remetente senderDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do Documento do Remetente senderStateRegistration: type: string description: Inscrição Estadual do Remetente recipientCorporateName: type: string description: Razão Social do Destinatário recipientDocument: type: string description: CNPJ do Destinatário recipientDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do Documento do Destinatário recipientStateRegistration: type: string description: Inscrição Estadual do Destinatário shipperCorporateName: type: string description: Razão Social do Expedidor shipperDocument: type: string description: Documento do Expedidor shipperDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Expedidor shipperStateRegistration: type: string description: Inscrição Estadual do Expedidor receiverCorporateName: type: string description: Razão Social do Recebedor receiverDocument: type: string description: Documento do Recebedor receiverDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do Documento do Recebedor receiverStateRegistration: type: string description: Inscrição Estadual do Recebedor takerCorporateName: type: string description: Razão Social do Tomador takerDocument: type: string description: Documento do Tomador takerDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do Documento do Tomador takerStateRegistration: type: string description: Inscrição Estadual do Tomador takerType: type: string description: Tipo de Tomador totalServiceValue: type: string description: Valor Total do Serviço totalToReceive: type: string description: Valor Total a Receber authorizationDate: type: string format: date description: Data de autorização authorizationProtocol: type: string description: Protocolo de autorização digestValue: type: string description: Digest value processingDate: type: string format: date-time description: Data de processamento finalProcessDate: type: string format: date-time description: Data final do processamento processingAttempts: type: integer format: int64 description: Numero de tentativas de processamento default: 0 issuanceType: type: string allOf: – #/definitions/enumIssuanceType description: Tipo de emissão do CT-e environmentType: type: string description: Tipo de ambiente da emissão naturalKey: type: string description: Chave natural situationDate: type: string format: date-time description: Data da situação creationType: type: string allOf: – #/definitions/enumTransportInvoiceCreationType description: Origem da criação do CT-e invoiceXmls: type: array items: type: object allOf: – #/definitions/outgoingTransportInvoiceXml description: XML do CT-e outgoingTransportInvoiceRejection: type: object allOf: – #/definitions/outgoingTransportInvoiceRejection description: Rejeição do CT-e usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingTransportInvoice: type: object required: – id allOf: – #/definitions/outgoingTransportInvoice outgoingTransportInvoiceXml: description: XML do CT-e type: object required: – invoiceAccessKey – fileName – targetObjectId – version – xmlType properties: id: type: string format: uuid description: ID do XML outgoingTransportInvoice: type: object allOf: – #/definitions/outgoingTransportInvoice description: CT-e de saída invoiceAccessKey: type: string description: Chave de acesso do CT-e fileName: type: string description: Nome do arquivo do CT-e targetObjectId: type: string description: ID do arquivo no blobService type: string description: Versão do arquivo xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingTransportInvoiceXml: type: object required: – id allOf: – #/definitions/outgoingTransportInvoiceXml outgoingTransportInvoiceRejection: description: Rejeição do CT-e type: object required: – rejectionMessage – rejectionCode properties: id: type: string format: uuid description: ID da rejeição outgoingTransportInvoice: type: object allOf: – #/definitions/outgoingTransportInvoice description: ID do CT-e rejectionMessage: type: string description: Mensagem de rejeição rejectionCode: type: string maxLength: 20 description: Código de rejeição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingTransportInvoiceRejection: type: object required: – id allOf: – #/definitions/outgoingTransportInvoiceRejection outgoingTransportDocumentHistory: description: Histórico das movimentações do CT-e type: object required: – transportInvoiceStatus – historyDateTime – firedBy properties: id: type: string format: uuid description: Id da entidade transportInvoiceStatus: type: string allOf: – #/definitions/enumTransportInvoiceSituation description: Situação do CT-e historyDateTime: type: string format: date-time description: Data e hora da movimentação do histórico firedBy: type: string description: Usuário que disparou o evento transportInvoiceId: type: string format: uuid description: ID do CT-e historyOccurrence: type: string description: Ocorrência do histórico historyDetails: type: object allOf: – #/definitions/outgoingTransportHistoryDetails description: Detalhes do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingTransportDocumentHistory: type: object required: – id allOf: – #/definitions/outgoingTransportDocumentHistory outgoingTransportHistoryDetails: description: Detalhes do histórico type: object required: – message – code properties: id: type: string format: uuid description: Id da entidade documentHistory: type: object allOf: – #/definitions/outgoingTransportDocumentHistory description: Identificador do documento message: type: string maxLength: 255 description: Mensagem do histórico code: type: string maxLength: 5 description: Código do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editOutgoingTransportHistoryDetails: type: object required: – id allOf: – #/definitions/outgoingTransportHistoryDetails incomingTransportInvoice: description: CT-e de entrada type: object required: – accessKey – situation – series – number – version – issueDateTime – transportInvoiceType – serviceType – modal – issuerCorporateName – issuerDocument – issuerStateRegistration – takerType – totalServiceValue – processingDate – finalProcessDate – issuanceType – environmentType – creationType – transportInvoiceLayout properties: id: type: string format: uuid description: ID do CT-e e070fil: type: object allOf: – #/definitions/e070fil description: Filial accessKey: type: string description: Chave de acesso do CT-e situation: type: string allOf: – #/definitions/enumTransportInvoiceSituation description: Situação do CT-e series: type: integer format: int64 description: Série do CT-e number: type: integer format: int64 description: Número do CT-e type: string description: Versão do CT-e issueDateTime: type: string format: date-time description: Data de emissão transportInvoiceType: type: string allOf: – #/definitions/enumTransportInvoiceType description: Tipo do CT-e serviceType: type: string allOf: – #/definitions/enumTransportInvoiceServiceType description: Tipo de serviço modal: type: string allOf: – #/definitions/enumTransportModal description: Modal de transporte issuerCorporateName: type: string description: Razão Social do Emitente issuerDocument: type: string description: Documento do Emitente issuerDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Emitente issuerStateRegistration: type: string description: Inscrição Estadual do Emitente senderCorporateName: type: string description: Razão Social do Remetente senderDocument: type: string description: Documento do Remetente senderDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Remetente senderStateRegistration: type: string description: Inscrição Estadual do Remetente recipientCorporateName: type: string description: Razão Social do Destinatário recipientDocument: type: string description: Documento do Destinatário recipientDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Destinatário recipientStateRegistration: type: string description: Inscrição Estadual do Destinatário shipperCorporateName: type: string description: Razão Social do Expedidor shipperDocument: type: string description: Documento do Expedidor shipperDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Expedidor shipperStateRegistration: type: string description: Inscrição Estadual do Expedidor receiverCorporateName: type: string description: Razão Social do Recebedor receiverDocument: type: string description: Documento do Recebedor receiverDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Recebedor receiverStateRegistration: type: string description: Inscrição Estadual do Recebedor takerCorporateName: type: string description: Razão Social do Tomador takerDocument: type: string description: Documento do Tomador takerDocumentType: type: string allOf: – #/definitions/documentType description: Tipo do documento do Tomador takerStateRegistration: type: string description: Inscrição Estadual do Tomador takerType: type: string allOf: – #/definitions/enumTakerType description: Tipo do Tomador totalServiceValue: type: string description: Valor total da prestação totalToReceive: type: string description: Valor total a receber authorizationDate: type: string format: date description: Data de autorização authorizationProtocol: type: string description: Protocolo de autorização digestValue: type: string description: Digest value processingDate: type: string format: date-time description: Data de processamento finalProcessDate: type: string format: date-time description: Data de finalização do processamento processingAttempts: type: integer format: int64 description: Número de tentativas de processamento default: 0 issuanceType: type: string allOf: – #/definitions/enumIssuanceType description: Tipo de emissão environmentType: type: string allOf: – #/definitions/environmentType description: Tipo de ambiente naturalKey: type: string description: Chave natural issueUF: type: object allOf: – #/definitions/e007ufs description: UF de emissão recipientUF: type: string maxLength: 2 description: UF do destinatário transportXml: type: object allOf: – #/definitions/incomingTransportInvoiceXml description: XML do CT-e transportInvoiceRejection: type: object allOf: – #/definitions/incomingTransportInvoiceRejection description: Rejeição do CT-e eventsTransportInvoice: type: array items: type: object allOf: – #/definitions/eventIncomingTransportInvoice description: Eventos do CT-e situationDate: type: string format: date-time description: Data de alteração da situação creationType: type: string allOf: – #/definitions/enumTransportInvoiceCreationType description: Tipo de criação transportInvoiceLayout: type: string allOf: – #/definitions/enumTransportInvoiceLayout description: Modelo do CT-e incomingBranchRole: type: string allOf: – #/definitions/enumBranchRoleTransportInvoice description: Papel específico da filial no CT-e usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editIncomingTransportInvoice: type: object required: – id allOf: – #/definitions/incomingTransportInvoice incomingTransportInvoiceXml: description: XML do CT-e de entrada type: object required: – invoiceAccessKey – fileName – targetObjectId – version – xmlType properties: id: type: string format: uuid description: ID do XML incomingTransportInvoice: type: object allOf: – #/definitions/incomingTransportInvoice description: CT-e de entrada invoiceAccessKey: type: string description: Chave de acesso do CT-e fileName: type: string description: Nome do arquivo targetObjectId: type: string description: ID do arquivo no blobService type: string description: Versão do arquivo xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editIncomingTransportInvoiceXml: type: object required: – id allOf: – #/definitions/incomingTransportInvoiceXml incomingTransportInvoiceRejection: description: Rejeição do CT-e de entrada type: object required: – rejectionMessage – rejectionCode properties: id: type: string format: uuid description: ID da rejeição incomingTransportInvoice: type: object allOf: – #/definitions/incomingTransportInvoice description: CT-e de entrada rejectionMessage: type: string description: Mensagem de rejeição rejectionCode: type: string maxLength: 20 description: Código de rejeição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editIncomingTransportInvoiceRejection: type: object required: – id allOf: – #/definitions/incomingTransportInvoiceRejection eventIncomingTransportInvoice: description: Evento do CT-e de entrada type: object required: – accessKey – transportInvoiceAccessKey – situation – series – number – issuerCorporateName – version – issueDateTime – processingDate – eventSequence properties: id: type: string format: uuid description: ID do Evento e070fil: type: object allOf: – #/definitions/e070fil description: Filial accessKey: type: string description: Chave de acesso do evento transportInvoiceAccessKey: type: string description: Chave de acesso do CT-e transportInvoice: type: object allOf: – #/definitions/incomingTransportInvoice description: CT-e de entrada situation: type: string allOf: – #/definitions/enumTransportEventSituation description: Situação do evento series: type: integer format: int64 description: Série do CT-e number: type: integer format: int64 description: Número do CT-e issuerCorporateName: type: string description: Razão Social do Emitente do CT-e type: string description: Versão do evento issueDateTime: type: string format: date-time description: Data do evento registrationDate: type: string format: date-time description: Data de registro do evento na SEFAZ authorizationProtocol: type: string description: Protocolo de autorização eventXmls: type: array items: type: object allOf: – #/definitions/eventIncomingTransportInvoiceXml description: XML do evento processingDate: type: string format: date-time description: Data de processamento eventSequence: type: integer format: int64 description: Sequência do evento eventType: type: string allOf: – #/definitions/enumEventType description: Tipo do evento eventAuthor: type: string allOf: – #/definitions/enumEventAuthor description: Autor do evento eventTransportInvoiceRejection: type: object allOf: – #/definitions/eventIncomingTransportInvoiceRejection description: Rejeição do evento processingAttempts: type: integer format: int64 description: Número de tentativas de processamento default: 0 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventIncomingTransportInvoice: type: object required: – id allOf: – #/definitions/eventIncomingTransportInvoice eventIncomingTransportInvoiceXml: description: XML do evento do CT-e de entrada type: object required: – eventAccessKey – fileName – targetObjectId – version – xmlType properties: id: type: string format: uuid description: ID do XML eventTransportInvoice: type: object allOf: – #/definitions/eventIncomingTransportInvoice description: Evento do CT-e de entrada eventAccessKey: type: string description: Chave de acesso do evento fileName: type: string description: Nome do arquivo do evento targetObjectId: type: string description: ID do arquivo no blobService type: string description: Versão do arquivo xmlType: type: string allOf: – #/definitions/enumXmlType description: Tipo do XML usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventIncomingTransportInvoiceXml: type: object required: – id allOf: – #/definitions/eventIncomingTransportInvoiceXml eventIncomingTransportInvoiceRejection: description: Rejeição do evento do CT-e de entrada type: object required: – rejectionMessage – rejectionCode properties: id: type: string format: uuid description: ID da rejeição eventTransportInvoice: type: object allOf: – #/definitions/eventIncomingTransportInvoice description: Evento do CT-e de entrada rejectionMessage: type: string description: Mensagem de rejeição rejectionCode: type: string maxLength: 20 description: Código de rejeição usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventIncomingTransportInvoiceRejection: type: object required: – id allOf: – #/definitions/eventIncomingTransportInvoiceRejection incomingTransportDocumentHistory: description: Histórico das movimentações do CT-e de entrada type: object required: – transportInvoiceStatus – historyDateTime – firedBy properties: id: type: string format: uuid description: Id da entidade transportInvoiceStatus: type: string allOf: – #/definitions/enumTransportInvoiceSituation description: Situação do CT-e historyDateTime: type: string format: date-time description: Data e hora da movimentação do histórico firedBy: type: string description: Usuário que disparou o evento historyOccurrence: type: string description: Ocorrência do histórico transportInvoice: type: object allOf: – #/definitions/incomingTransportInvoice description: CT-e de entrada historyDetails: type: object allOf: – #/definitions/incomingTransportHistoryDetails description: Detalhes do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editIncomingTransportDocumentHistory: type: object required: – id allOf: – #/definitions/incomingTransportDocumentHistory incomingTransportHistoryDetails: description: Detalhes do histórico do CT-e de entrada type: object required: – message – code properties: id: type: string format: uuid description: Id da entidade documentHistory: type: object allOf: – #/definitions/incomingTransportDocumentHistory description: Histórico do documento message: type: string maxLength: 255 description: Mensagem do histórico code: type: string maxLength: 5 description: Código do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editIncomingTransportHistoryDetails: type: object required: – id allOf: – #/definitions/incomingTransportHistoryDetails eventIncomingTransportDocumentHistory: description: Histórico das movimentações do evento do CT-e de entrada type: object required: – eventStatus – historyDateTime – firedBy properties: id: type: string format: uuid description: Id da entidade eventStatus: type: string allOf: – #/definitions/enumTransportEventSituation description: Situação do evento historyDateTime: type: string format: date-time description: Data e hora da movimentação do histórico firedBy: type: string description: Usuário que disparou o evento historyOccurrence: type: string description: Ocorrência do histórico eventTransportInvoice: type: object allOf: – #/definitions/eventIncomingTransportInvoice description: Evento do CT-e de entrada historyDetails: type: object allOf: – #/definitions/eventIncomingTransportHistoryDetails description: Detalhes do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventIncomingTransportDocumentHistory: type: object required: – id allOf: – #/definitions/eventIncomingTransportDocumentHistory eventIncomingTransportHistoryDetails: description: Detalhes do histórico do evento do CT-e de entrada type: object required: – message – code properties: id: type: string format: uuid description: Id da entidade documentHistory: type: object allOf: – #/definitions/eventIncomingTransportDocumentHistory description: Histórico do documento message: type: string maxLength: 255 description: Mensagem do histórico code: type: string maxLength: 5 description: Código do histórico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventIncomingTransportHistoryDetails: type: object required: – id allOf: – #/definitions/eventIncomingTransportHistoryDetails notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage