integration

2.0info: 5.0.0 integration description: Serviço de integração com o XT x-senior-domain: Domínio de integração com XT x-senior-domain-path: erpx_cpl_xt x-senior-service-path: integration 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/erpx_cpl_xtsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integration/queries/healthcheck: post: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/integrationProcessList: post: description: Lista todas as integrações com a G5 tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – typeKey – pageRequest properties: recEntityFacadeId: type: string description: Id da entidade auxiliar da integração typeKey: type: string allOf: – #/definitions/enumTypeKey description: Enum do tipo de integração lastIntegrationStatus: type: string allOf: – #/definitions/enumStatusIntegration description: Situação da última integração lastIntegrationDate: type: string description: Última data de integração pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – searchIntegration – total – totalElements properties: searchIntegration: type: array items: type: object allOf: – #/definitions/recSearchIntegration minimum: 1 description: Integrações do Compliance Fiscal total: type: integer format: int64 description: Quantidade de registros encontradas por página totalElements: type: integer format: int64 description: Todos os registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/integrationProcessDetailPersonList: post: description: Lista com os detalhes do processo de integração da Pessoa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationProcessId – pageRequest properties: integrationProcessId: type: string description: Identificador da integração – Pessoa pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – detailPersonIntegration – total – totalElements properties: detailPersonIntegration: type: array items: type: object allOf: – #/definitions/recDetailPersonIntegration minimum: 1 description: Informações dos detalhes do Produto total: type: integer format: int64 description: Quantidade de registros encontrados por página totalElements: type: integer format: int64 description: Todos os registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/integrationProcessDetailProductList: post: description: Lista com os detalhes do processo de integração dos Produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – keyId – pageRequest properties: keyId: type: string description: Identificador da integração – Produto pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – detailProductIntegration – total – totalElements properties: detailProductIntegration: type: array items: type: object allOf: – #/definitions/recDetailProductIntegration minimum: 1 description: Informações dos detalhes do Produto total: type: integer format: int64 description: Quantidade de registros encontrados por página totalElements: type: integer format: int64 description: Todos os registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/invoiceHeaderList: post: description: Busca todas as integrações de notas fiscais (entrada e saída) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – invoiceType – pageRequest properties: invoices: type: array items: type: string description: Ids das notas fiscais(filtro usado pelo link da tela de integrações) companies: type: array items: type: string description: Ids das empresas branchs: type: array items: type: string description: Ids das filiais person: type: array items: type: string description: Id do destinarário series: type: array items: type: string description: Ids da série initialIssueDate: type: string format: date description: Data de emissão inicial finalIssueDate: type: string format: date description: Data de emissão final initialIntegrationDate: type: string format: date description: Data da integração inicial finalIntegrationDate: type: string format: date description: Data da integração final integrationStatus: type: array items: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração netValue: type: string description: Valor líquido eletronicKey: type: string description: Chave eletrônica invoiceNumber: type: integer format: int64 description: Número da nota fiscal invoiceType: type: string allOf: – #/definitions/enumTipoNotaFiscal description: Tipo da nota fiscal pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – integrationInvoices – total – totalElements properties: integrationInvoices: type: array items: type: object allOf: – #/definitions/recInvoiceHeaderIntegration minimum: 1 description: total: type: integer format: int64 description: Quantidade de registros encontrados por página totalElements: type: integer format: int64 description: Todos os registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/queries/invoiceHeaderIntegrationProcessList: post: description: Query de busca do historico/detalhamento das integrações de notas fiscais na tela de monitoramento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – invoiceId – pageRequest properties: invoiceId: type: string description: Id da nota pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object required: – invoiceIntegration – total – totalElements properties: invoiceIntegration: type: array items: type: object allOf: – #/definitions/recInvoiceHeaderIntegrationProcess minimum: 1 description: Integrações da nota buscada total: type: integer format: int64 description: Quantidade de registros encontrados por página totalElements: type: integer format: int64 description: Todos os registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/queries/exportIntegrationProcess: 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 /integration/queries/exportIntegrationProcessDetail: 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 /integration/queries/exportCarrierIntegrationProcess: 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 /integration/queries/exportEntityFacade: 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 /integration/queries/exportE015medErpxt: 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 /integration/queries/exportE001endErpxt: 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 /integration/queries/exportCallbackResponse: 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 /integration/queries/exportCallbackResponseBatch: 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 /integration/queries/exportSendController: 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 /integration/queries/exportSendControllerDetail: 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 /integration/queries/exportProdSerErpxt: 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 /integration/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 /integration/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 /integration/queries/exportE001pes: 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 /integration/queries/exportE032edc: 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 /integration/queries/exportE020snf: 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 /integration/queries/exportInvoiceHeader: 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 /integration/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 /integration/actions/processIntegrationResponse: post: description: Processar resposta de Integração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – itemsToProcess properties: itemsToProcess: type: array items: type: object allOf: – #/definitions/processIntegrationResponsePayload minimum: 1 description: Item de resposta responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/processIntegrationInventory: post: description: Processar a integração do inventário de estoque tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – inventory properties: inventory: type: object allOf: – #/definitions/recSaldoFisicoEstoqueXt description: Inventário de estoque inventoryDetail: type: array items: type: object allOf: – #/definitions/recDetalhamentoSaldoFisicoEstoque description: Detalhamento do inventário de estoque idWork: type: string description: Id do work de integração responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/processIntegrationArInvoice: post: description: Processo de integração da nota fiscal de saída para escrituração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – arInvoice properties: idWork: type: string description: Id do work de integração arInvoice: type: object allOf: – #/definitions/recIntegrationArInvoice description: Dados da nota fiscal de saída para escritracão responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/processIntegrationApInvoice: post: description: Processo de integração da nota fiscal de entrada para escrituração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – apInvoice properties: idWork: type: string description: Id do work de integração apInvoice: type: object allOf: – #/definitions/nfEntradaIntegracao description: Dados da nota fiscal de saída para escritracão responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/resultSaleInvoiceExclusionIntegration: post: description: Informar o resultado da exclusão da integração tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nfSaidaId – resultado properties: nfSaidaId: type: array items: type: string minimum: 1 description: Item da nota resultado: type: string allOf: – #/definitions/enumResultadoIntegracao description: Resultado da integração mensagemErro: type: string description: Mensagem de erro ocorrido no processo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/actions/importIntegrationProcess: 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 /integration/actions/importIntegrationProcessDetail: 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 /integration/actions/importCarrierIntegrationProcess: 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 /integration/actions/importEntityFacade: 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 /integration/actions/importE015medErpxt: 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 /integration/actions/importE001endErpxt: 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 /integration/actions/importCallbackResponse: 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 /integration/actions/importCallbackResponseBatch: 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 /integration/actions/importSendController: 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 /integration/actions/importSendControllerDetail: 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 /integration/actions/importProdSerErpxt: 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 /integration/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 /integration/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 /integration/actions/importE001pes: 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 /integration/actions/importE032edc: 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 /integration/actions/importE020snf: 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 /integration/actions/importInvoiceHeader: 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 /integration/signals/processJournalEntriesIntegrationXt: post: description: Integração dos lançamentos contábeis com XT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationType – accountingEntries properties: integrationType: type: string allOf: – #/definitions/enumTypeAccountingIntegration description: Tipo de integração accountingEntries: type: array items: type: object allOf: – #/definitions/recIntegrationAccountingEntries minimum: 1 description: Informações do lançamento contábil responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/processGenerateAccountingBatchIntegrationXt: post: description: Integração dos lotes contábeis com XT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationType – journalEntriesBatch properties: integrationType: type: string allOf: – #/definitions/enumTypeAccountingIntegration description: Tipo de integração journalEntriesBatch: type: object allOf: – #/definitions/recIntegrationBatch description: Informações do lote contábil responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/atualizarEntidadeG5: post: description: Atualizar entidade da integração com G5 tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idEntidade – nomeEntidade properties: idEntidade: type: string description: Id da entidade nomeEntidade: type: string description: Entidade Name responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/processAccountingBatchIntegrationXt: post: description: Integração de processamento do lote com o XT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationType – journalEntriesBatch properties: integrationType: type: string allOf: – #/definitions/enumTypeAccountingIntegration description: Tipo de integração journalEntriesBatch: type: object allOf: – #/definitions/recProcessLoteCtb description: Informações do lote contábil responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/startResponseBatchProcessing: post: description: Inicia o processamento do lote de respostas devolvidas pelo ERPXT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: id da tabela de processamente em lote CallbackResponseBatch responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/processSaleOrderExclusion: post: description: Processo de exclusão único ou em lotes da nota fiscal de saída no XT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – invoiceIds properties: invoiceIds: type: array items: type: string minimum: 1 description: Ids das notas a serem excluidas na g5 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/signals/processPurchaseOrderExclusion: post: description: Processo de exclusão único ou em lotes da nota fiscal de entrada no XT tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – invoiceIds properties: invoiceIds: type: array items: type: string minimum: 1 description: Ids das notas a serem excluidas na g5 responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integration/events/processProductCallback: post: description: Evento para processamento da callback de produto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processServiceCallback: post: description: Evento para processamento da callback de serviço x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processClientsCallback: post: description: Evento para processamento da callback de clientes x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processSuppliersCallback: post: description: Evento para processamento da callback de fornecedores x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processCarriersCallback: post: description: Evento para processamento da callback de transportadora x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processPurchaseOrderCallback: post: description: Evento para processamento da callback de nota de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processSalesOrderCallback: post: description: Evento para processamento da callback de nota de venda x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processInventoryCallback: post: description: Evento para processamento da callback de inventario x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processAccountingBatchCallback: post: description: Evento para processamento da callback do processamento do lote contábil x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processGenerateAccountingEntryCallback: post: description: Evento para processamento da callback da geração do lançamento contábil x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – ids properties: ids: type: array items: type: string minimum: 1 description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processGenerateAccountingBatchCallback: post: description: Evento para processamento da callback da geração do lote contábil x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processSaleOrderExclusionCallback: post: description: Evento para processamento da callback da exclusão da nota fiscal de saída x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/processPurchaseOrderExclusionCallback: post: description: Evento para processamento da callback da exclusão da nota fiscal de entrada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da callback responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/invoiceHeaderChanged: post: description: Evento para atualizar a tela de monitoramento das notas fiscais – websocket x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – id – statusIntegration – dthalt properties: id: type: string description: Id da entidade invoiceHeader statusIntegration: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração da nota fiscal dthalt: type: string format: date-time description: Ultima data de alteração do registro(invoiceHeader) responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/importIntegrationProcessEvent: post: description: 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 /integration/events/exportIntegrationProcessEvent: post: description: 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 /integration/events/importIntegrationProcessDetailEvent: post: description: 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 /integration/events/exportIntegrationProcessDetailEvent: post: description: 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 /integration/events/importCarrierIntegrationProcessEvent: post: description: 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 /integration/events/exportCarrierIntegrationProcessEvent: post: description: 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 /integration/events/importEntityFacadeEvent: post: description: 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 /integration/events/exportEntityFacadeEvent: post: description: 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 /integration/events/importE015medErpxtEvent: post: description: 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 /integration/events/exportE015medErpxtEvent: post: description: 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 /integration/events/importE001endErpxtEvent: post: description: 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 /integration/events/exportE001endErpxtEvent: post: description: 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 /integration/events/importCallbackResponseEvent: post: description: 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 /integration/events/exportCallbackResponseEvent: post: description: 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 /integration/events/importCallbackResponseBatchEvent: post: description: 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 /integration/events/exportCallbackResponseBatchEvent: post: description: 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 /integration/events/importSendControllerEvent: post: description: 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 /integration/events/exportSendControllerEvent: post: description: 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 /integration/events/importSendControllerDetailEvent: post: description: 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 /integration/events/exportSendControllerDetailEvent: post: description: 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 /integration/events/importProdSerErpxtEvent: post: description: 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 /integration/events/exportProdSerErpxtEvent: post: description: 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 /integration/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 /integration/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 /integration/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 /integration/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 /integration/events/importE001pesEvent: post: description: 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 /integration/events/exportE001pesEvent: post: description: 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 /integration/events/importE032edcEvent: post: description: 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 /integration/events/exportE032edcEvent: post: description: 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 /integration/events/importE020snfEvent: post: description: 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 /integration/events/exportE020snfEvent: post: description: 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 /integration/events/importInvoiceHeaderEvent: post: description: 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 /integration/events/exportInvoiceHeaderEvent: post: description: 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 /integration/entities/integrationProcess: 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/integrationProcess responses: 200: description: The created resource schema: #/definitions/integrationProcess 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/integrationProcess responses: 200: description: The created resource schema: #/definitions/integrationProcess 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: array items: #/definitions/integrationProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/integrationProcess/{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/integrationProcess responses: 200: description: Ok schema: #/definitions/integrationProcess 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/integrationProcess responses: 200: description: Ok schema: #/definitions/integrationProcess 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/integrationProcess 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 /integration/entities/integrationProcess/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationProcess responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/integrationProcessDetail: 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/integrationProcessDetail responses: 200: description: The created resource schema: #/definitions/integrationProcessDetail 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/integrationProcessDetail responses: 200: description: The created resource schema: #/definitions/integrationProcessDetail 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: array items: #/definitions/integrationProcessDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/integrationProcessDetail/{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/integrationProcessDetail responses: 200: description: Ok schema: #/definitions/integrationProcessDetail 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/integrationProcessDetail responses: 200: description: Ok schema: #/definitions/integrationProcessDetail 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/integrationProcessDetail 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 /integration/entities/integrationProcessDetail/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/integrationProcessDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/carrierIntegrationProcess: 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/carrierIntegrationProcess responses: 200: description: The created resource schema: #/definitions/carrierIntegrationProcess 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/carrierIntegrationProcess responses: 200: description: The created resource schema: #/definitions/carrierIntegrationProcess 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: array items: #/definitions/carrierIntegrationProcess 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/carrierIntegrationProcess/{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/carrierIntegrationProcess responses: 200: description: Ok schema: #/definitions/carrierIntegrationProcess 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/carrierIntegrationProcess responses: 200: description: Ok schema: #/definitions/carrierIntegrationProcess 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/carrierIntegrationProcess 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 /integration/entities/carrierIntegrationProcess/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/carrierIntegrationProcess responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/entityFacade: 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/entityFacade responses: 200: description: The created resource schema: #/definitions/entityFacade 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/entityFacade responses: 200: description: The created resource schema: #/definitions/entityFacade 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: array items: #/definitions/entityFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/entityFacade/{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/entityFacade responses: 200: description: Ok schema: #/definitions/entityFacade 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/entityFacade responses: 200: description: Ok schema: #/definitions/entityFacade 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/entityFacade 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 /integration/entities/entityFacade/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entityFacade responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e015medErpxt: 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/e015medErpxt responses: 200: description: The created resource schema: #/definitions/e015medErpxt 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/e015medErpxt responses: 200: description: The created resource schema: #/definitions/e015medErpxt 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: array items: #/definitions/e015medErpxt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e015medErpxt/{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/e015medErpxt responses: 200: description: Ok schema: #/definitions/e015medErpxt 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/e015medErpxt responses: 200: description: Ok schema: #/definitions/e015medErpxt 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/e015medErpxt 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 /integration/entities/e015medErpxt/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e015medErpxt responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e001endErpxt: 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/e001endErpxt responses: 200: description: The created resource schema: #/definitions/e001endErpxt 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/e001endErpxt responses: 200: description: The created resource schema: #/definitions/e001endErpxt 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: array items: #/definitions/e001endErpxt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e001endErpxt/{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/e001endErpxt responses: 200: description: Ok schema: #/definitions/e001endErpxt 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/e001endErpxt responses: 200: description: Ok schema: #/definitions/e001endErpxt 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/e001endErpxt 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 /integration/entities/e001endErpxt/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001endErpxt responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/callbackResponse: 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/callbackResponse responses: 200: description: The created resource schema: #/definitions/callbackResponse 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/callbackResponse responses: 200: description: The created resource schema: #/definitions/callbackResponse 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: array items: #/definitions/callbackResponse 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/callbackResponse/{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/callbackResponse responses: 200: description: Ok schema: #/definitions/callbackResponse 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/callbackResponse responses: 200: description: Ok schema: #/definitions/callbackResponse 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/callbackResponse 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 /integration/entities/callbackResponse/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/callbackResponse responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/callbackResponseBatch: 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/callbackResponseBatch responses: 200: description: The created resource schema: #/definitions/callbackResponseBatch 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/callbackResponseBatch responses: 200: description: The created resource schema: #/definitions/callbackResponseBatch 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: array items: #/definitions/callbackResponseBatch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/callbackResponseBatch/{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/callbackResponseBatch responses: 200: description: Ok schema: #/definitions/callbackResponseBatch 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/callbackResponseBatch responses: 200: description: Ok schema: #/definitions/callbackResponseBatch 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/callbackResponseBatch 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 /integration/entities/callbackResponseBatch/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/callbackResponseBatch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/sendController: 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/sendController responses: 200: description: The created resource schema: #/definitions/sendController 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/sendController responses: 200: description: The created resource schema: #/definitions/sendController 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: array items: #/definitions/sendController 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/sendController/{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/sendController responses: 200: description: Ok schema: #/definitions/sendController 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/sendController responses: 200: description: Ok schema: #/definitions/sendController 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/sendController 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 /integration/entities/sendController/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sendController responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/sendControllerDetail: 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/sendControllerDetail responses: 200: description: The created resource schema: #/definitions/sendControllerDetail 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/sendControllerDetail responses: 200: description: The created resource schema: #/definitions/sendControllerDetail 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: array items: #/definitions/sendControllerDetail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/sendControllerDetail/{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/sendControllerDetail responses: 200: description: Ok schema: #/definitions/sendControllerDetail 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/sendControllerDetail responses: 200: description: Ok schema: #/definitions/sendControllerDetail 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/sendControllerDetail 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 /integration/entities/sendControllerDetail/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/sendControllerDetail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/prodSerErpxt: 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/prodSerErpxt responses: 200: description: The created resource schema: #/definitions/prodSerErpxt 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/prodSerErpxt responses: 200: description: The created resource schema: #/definitions/prodSerErpxt 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: array items: #/definitions/prodSerErpxt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/prodSerErpxt/{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/prodSerErpxt responses: 200: description: Ok schema: #/definitions/prodSerErpxt 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/prodSerErpxt responses: 200: description: Ok schema: #/definitions/prodSerErpxt 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/prodSerErpxt 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 /integration/entities/prodSerErpxt/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/prodSerErpxt responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/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: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/entities/e001pes: 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: array items: #/definitions/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e001pes/{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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e032edc: 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: array items: #/definitions/e032edc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e032edc/{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/e032edc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e020snf: 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: array items: #/definitions/e020snf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e020snf/{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/e020snf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/invoiceHeader: 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/invoiceHeader responses: 200: description: The created resource schema: #/definitions/invoiceHeader 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/invoiceHeader responses: 200: description: The created resource schema: #/definitions/invoiceHeader 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: array items: #/definitions/invoiceHeader 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/invoiceHeader/{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/invoiceHeader responses: 200: description: Ok schema: #/definitions/invoiceHeader 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/invoiceHeader responses: 200: description: Ok schema: #/definitions/invoiceHeader 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/invoiceHeader 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 /integration/entities/invoiceHeader/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/invoiceHeader responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumStatusInitialLoadXt: description: Indicativo de integração do initial load xt type: string enum: – PENDENTE – INTEGRADO – EXECUTANDO – ERRO enumTypeKey: description: Enum do tipo de integração com a G5 type: string enum: – PERSON – CLIENTS – SUPPLIERS – CARRIER – PRODUCT – SERVICE – PURCHASE_ORDER – SALES_ORDER – INVENTORY enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumSaldoFisicoEstoqueProcesso: description: Estado do processo do saldo físico de estoque type: string enum: – LIBERADO – EM_EXCLUSAO – ERRO_EXCLUSAO_INTEGRACAO enumOrigemDocumento: description: Origem do documento type: string enum: – NOTA_ENTRADA – NOTA_SAIDA – ESTOQUE enumTypeStatusIntegration: description: Enum de status callbackResponse type: string enum: – SUCCESS – ERROR enumChangeAction: description: Enum da ação gerado pela alteração type: string enum: – CREATE – UPDATE – DELETE enumStatusIntegration: description: Enum generico de status da integração type: string enum: – STARTED – DATACENTER_LOADED – REQUIRED_DATA_VALIDATED – PAYLOAD_PREPARED – SENT – ERROR_TO_SEND – INTEGRATED – ERROR – ERPXT_PROCESSING_ERROR – PROCESSING – ENTITY_ASSIST_CREATED – PROCESSING_INVOICE_EXCLUSION – INVOICE_EXCLUSION_SUCCESSFUL – INVOICE_EXCLUSION_ERROR – INVOICE_EXCLUSION_PROCESS_VALIDATION_ERROR – INVOICE_ERPX_EXCLUDE_PROCESSING enumTypeIntegration: description: Enum generico de tipo de integração type: string enum: – MANUAL – AUTOMATICA – AGENDADA enumDefinitionPerson: description: Enum generico de definição da pessoa type: string enum: – CLIENTE – FORNECEDOR – TRANSPORTADORA enumTypeAccountingIntegration: description: Enum integração contábil type: string enum: – BATCH – ACCOUNTING_ENTRY – PROCESS_BATCH enumSitNfs: description: Situacao da nota fiscal type: string enum: – V0 – V1 – V2 – V3 – V4 – V7 – V8 – V9 – V10 – V11 – V12 – V13 enumSitNfsEntrada: description: Situacao da nota fiscal de entrada type: string enum: – V0 – V2 – V3 – V4 – V5 – InutilizacaoProcessamento – Inutilizada – Estornada – ProcessandoCalculo – Inconsistente enumTipNfs: description: Tipo da nota fiscal type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V20 – V21 – V22 – V23 – V24 – V99 enumCifFob: description: Tipo de frete type: string enum: – V0 – V1 – V2 – V3 – V4 – V9 enumTipCtg: description: Tipo da contingência NF-e type: string enum: – V1 – V2 – V4 – V5 – V6 – V7 enumTipFpg: description: Tipo pagamento type: string enum: – V01 – V02 – V03 – V04 – V05 – V10 – V11 – V12 – V13 – V15 – V16 – V17 – V18 – V19 – V90 – V99 enumTipImpDoc: description: Tipo de imposto documento type: string enum: – IPI – IPI_PRESUMIDO – IPI_DEVOLVIDO – IPI_CREDITADO – ICMS – ICMS_SIMPLES – ICMS_FUTURO – ICMS_DIFERIDO – ICMS_DESONERADO – ICMS_ST – ICMS_UF_DESTINO – ICMS_ISENTAS_OUTRAS – ICMS_CREDITADO – ICMS_EFETIVO – ICMS_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_SOLIDARIO – ICMS_IMPORTACAO – ICMS_DESTINO – FCP – FCP_ST – FCP_UF_DESTINO – FCP_ST_RETIDO_ANT – ISS – COFINS – COFINS_RETIDO – COFINS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS – PIS_RETIDO – PIS_RECUPERAR_IMPORTACAO – PIS_RECUPERAR – PIS_DEVOLVIDO – CSLL – ISS_RETIDO – IRRF – INSS – INSS_PATRONAL – IMPOSTO_IMPORTACAO – DIFAL – DIFAL_DEVOLVIDO – CIDE_TECNOLOGIA – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR – FUNRURAL_TOTAL – SUM_FUNRURAL_RAT_FUNRURAL_INSS enumJurFis: description: Tipo Pessoa type: string enum: – VJ – VF enumCriRat: description: Enum CriRat type: string enum: – V1 – V2 – V3 – V4 – V5 enumTipEmp: description: Tipo de empresa type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumTipMer: description: Tipo de mercado type: string enum: – VI – VE enumZonFra: description: Zona franca type: string enum: – V0 – V1 – V2 – V3 – V4 enumSitReg: description: Situação do registro type: string enum: – VA – VI enumIndOba: description: Indicativo de prestação de serviços em obra de construção civil type: string enum: – V0 – V1 – V2 enumIndNif: description: Tipo do número de identificação fiscal type: string enum: – V1 – V2 – V3 enumTipEmc: description: Tipo do direito de propriedade do cliente type: string enum: – V1 – V2 enumCodCrt: description: Código do Regime Tributário type: string enum: – V1 – V2 – V3 enumRegEst: description: Regime Especial de Tributação type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 enumOrigemMercadoria: description: Origem fiscal da mercadoria type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 enumNfSaidaSituacao: description: Situação da nota fiscal de saída type: string enum: – EM_ESCRITURACAO – ESCRITURADA – CANCELADA – CONTABILIZADA enumSitDoe: description: Tipo de documento – eDocs type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V08 – V09 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 enumAplLiq: description: Enumeração do tipo de aplicação do valor do imposto type: string enum: – VA – VS – VN enumTipoNotaFiscal: description: Enum para dizer se é nota fiscal de entrada ou saída type: string enum: – NotaEntrada – NotaSaida enumDisAut: description: Dispositivo autorizado type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 enumTipNfe: description: Tipos de nota fiscal de entrada type: string enum: – V1 – V2 – V4 – V8 – V9 – V10 – V12 enumTipNdi: description: Tipo de documento de importação type: string enum: – VI – VS enumViaTransp: description: Tipo de vias de transporte type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 enumTipoCreditoRecuperado: description: Tipo de crédito recuperado type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 enumTipoItemNota: description: type: string enum: – VP – VS enumTipImpDocEntrada: description: Tipo de imposto documento para nf de entrada type: string enum: – IPI – IPI_CREDITADO – ISS – ISS_RETIDO – PIS_RECUPERAR – PIS_DEVOLVIDO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS_RETIDO – COFINS_RETIDO – CSLL – IRRF – INSS – IMPOSTO_IMPORTACAO – PIS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR_IMPORTACAO – ICMS – ICMS_CREDITADO – FCP – ICMS_DIFERIDO – ICMS_DESONERADO – DIFAL – ICMS_ST – FCP_ST – ICMS_COBRADO_ANTERIORMENTE_ST – FCP_COBRADO_ANTERIORMENTE_ST – ICMS_FUTURO – ICMS_SIMPLES – FCP_UF_DESTINO – PIS – COFINS – IPI_PRESUMIDO – CIDE_TECNOLOGIA – INSS_PATRONAL – ICMS_ST_SOLIDARIO – FCP_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_RETIDO_ANT – ICMS_UF_DESTINO_DEVOLVIDO – FCP_UF_DESTINO_DEVOLVIDO – ICMS_EFETIVO – ICMS_ISENTAS_OUTRAS – FUNRURAL_INSS – FUNRURAL_RAT – FUNRURAL_SENAR – FUNRURAL_TOTAL – SUM_FUNRURAL_RAT_FUNRURAL_INSS enumDescontaICMSSTEntrada: description: Desconta ICMS ST – EFD ICMS IPI type: string enum: – NAO – SOMENTE_FINANCEIRO – SOMENTE_DO_VALOR_LIQUIDO enumTipLct: description: Tipo lançamento type: string enum: – V1 – V5 – V6 enumOriLct: description: Origem lançamento type: string enum: – VMAN – VEST – VVEN – VCPR – VREC – VPAG – VTES – VEXT – VIPT enumAplNop: description: Aplicação da natureza da operação type: string enum: – VN – VS – VI – VR – VO – VT – VD – VA – VB – VE – VC – VF – VG – VV – VX enumAplSnf: description: Aplicação type: string enum: – VS – VM – VE – VF – VD enumResultadoIntegracao: description: Tipo de integração da controladoria type: string enum: – SUCESSO – ERRO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR integrationProcess: description: Entidade responsável pelo registro dos logs referente à integração type: object required: – id – integrationId – keyId – serviceName – status – payloadProcess – typeIntegration properties: id: type: string format: uuid description: Id integrationId: type: string format: uuid description: Id da entidade keyId: type: string format: uuid description: Id da chave serviceName: type: string description: Nome do serviço status: type: string allOf: – #/definitions/enumStatusIntegration description: Tipo do status detail: type: string description: Detalhe do status payloadProcess: type: string description: Payload typeIntegration: type: string allOf: – #/definitions/enumTypeIntegration description: Tipo de integração idWork: type: string format: uuid description: Identificador trabalhos de integração logs: type: string description: Logs da integração errorMsg: type: string description: Erros que ocorreram durante a integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: integrationProcessDetail: description: Detalhe do processo de integração type: object required: – integrationIdDetail – status – integrationProcess – serviceName – typeIntegration – definitionPerson properties: id: type: string format: uuid description: Id da entidade integrationIdDetail: type: string description: Id da integração status: type: string allOf: – #/definitions/enumStatusIntegration description: Status do controle da integração detail: type: string description: Detalhe do controle da integração integrationProcess: type: object allOf: – #/definitions/integrationProcess description: Id do integration process (tabela pai) payloadProcess: type: string description: Payload serviceName: type: string description: Nome do serviço idWork: type: string format: uuid description: Identificador trabalhos de integração typeIntegration: type: string allOf: – #/definitions/enumTypeIntegration description: Tipo de integração definitionPerson: type: string allOf: – #/definitions/enumDefinitionPerson description: Definição da Pessoa logs: type: string description: Logs da integração errorMsg: type: string description: Erros que ocorreram durante a integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: carrierIntegrationProcess: description: Processo de integração da transportadora type: object required: – id – e070empCod – e070filCod – taxIdentificationNumber – e001pesId – status – integrationId – integrationProcessDetail properties: id: type: string format: uuid description: Id e070empCod: type: string description: Codigo da empresa e070filCod: type: string description: Codigo da filial taxIdentificationNumber: type: string description: Cnpj e001pesId: type: string format: uuid description: Id da pessoa status: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração da transportadora detail: type: string description: Detalhe da integração da transportadora integrationId: type: string format: uuid description: Id da integração integrationProcessDetail: type: object allOf: – #/definitions/integrationProcessDetail description: Id do detalhe da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: entityFacade: description: Dados auxiliares para o monitoramento do Compliance Fiscal type: object required: – id – e070empCod – e070empDes – e070filCod – e070filDes – movementDate – entityCode – entityDesc – competenceDate – typeKey properties: id: type: string format: uuid description: Id da entidade do cadastro e070empCod: type: string description: Código da Empresa e070empDes: type: string description: Descrição da Empresa e070filCod: type: string description: Código da Filial e070filDes: type: string description: Descrição da Filial movementDate: type: string description: Data de entrada entityCode: type: string description: Código da entidade integrada entityDesc: type: string description: Descrição da entidade integrada competenceDate: type: string description: Competência typeKey: type: string allOf: – #/definitions/enumTypeKey description: Enum do tipo de integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e015medErpxt: description: Unidade de medida relacionada com o erp xt type: object required: – idErpxt properties: id: type: string format: uuid description: Id da entidade idErpxt: type: string maxLength: 3 description: Codigo da unidade de medida do erp xt usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001endErpxt: description: Endereços relacionados com o erp xt type: object required: – e001endId – e001pesId – seqEnt properties: e001endId: type: string format: uuid description: Id da tabela de endereço e001pesId: type: string format: uuid description: Id da pessoa seqEnt: type: string description: Sequencial usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: callbackResponse: description: Tabela genericia responsavel por armazenar os retornos via callback type: object required: – integrationId – serviceName – statusType properties: id: type: string format: uuid description: Id da entidade integrationId: type: string description: Id da integração serviceName: type: string description: Nome do serviço statusType: type: string description: Tipo do status de integração fornecido pelo xt statusDetail: type: string description: Detalhes do status fornecido pelo xt numLot: type: integer format: int64 description: Número do lote minimum: 0 maximum: 999999999 numLct: type: integer format: int64 description: Número do lançamento minimum: 0 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: callbackResponseBatch: description: type: object properties: id: type: string format: uuid description: Id da entidade payloadContent: type: string format: byte description: Conteudo do payload processed: type: boolean description: Flag para identificar se lote de resposta ja foi processado default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: sendController: description: Tabela que ira controlar o status da integração type: object required: – id – integrationId – serviceName – status properties: id: type: string format: uuid description: Id da entidade integrationId: type: string description: Id da integração serviceName: type: string description: Nome do serviço status: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração detail: type: string description: Detalhe da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: sendControllerDetail: description: Detalhe do controle de status da integração type: object required: – id – integrationId – status – sendController properties: id: type: string format: uuid description: Id da entidade integrationId: type: string description: Id da integração status: type: string description: Status do controle da integração detail: type: string description: Detalhe do controle da integração sendController: type: object allOf: – #/definitions/sendController description: Id do controle da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: prodSerErpxt: description: Tabela de controle do sequencial de produto e serviço da nota type: object required: – prodSerId – seqProdSer properties: prodSerId: type: string format: uuid description: Id do produto/serviço seqProdSer: type: integer format: int64 description: Sequencial usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: 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 sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa 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: Código da filial minimum: 0 maximum: 9999 sigFil: type: string maxLength: 100 description: Nome fantasia 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: e001pes: description: Pessoa type: object properties: id: type: string format: uuid description: Id da entidade codPes: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome cnpCpf: type: string maxLength: 14 description: CNPJ/CPF 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: e032edc: description: Modelo de documento type: object required: – codEdc properties: id: type: string format: uuid description: Id da entidade codEdc: type: string maxLength: 3 description: Mod. documento desEdc: type: string maxLength: 30 description: Descrição 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: e020snf: description: Tabelas – séries de notas fiscais type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial e032edc: type: object allOf: – #/definitions/e032edc description: Modelo do documento abrSnf: type: string maxLength: 10 description: Abreviatura aplSnf: type: string allOf: – #/definitions/enumAplSnf description: Aplicação codSnf: type: string maxLength: 3 description: Código desSnf: type: string maxLength: 30 description: Descrição codSel: type: string maxLength: 3 description: Série codSsl: type: string maxLength: 2 description: Subsérie 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: invoiceHeader: description: Entidade usada no monitoramento da integração das notas fiscais type: object required: – e070empId – e070filId – e001pesId – e020snfId – numNf – issueDate – netValue – invoiceType – status – integrationDate properties: id: type: string format: uuid description: Identificador da nota fiscal e070empId: type: string format: uuid description: Identificador da empresa utilizada pela nota fiscal e070filId: type: string format: uuid description: Identificador da filial utilizada pela nota fiscal e001pesId: type: string format: uuid description: Identificador da pessoa utilizada(rementente ou destinatário) e020snfId: type: string format: uuid description: Identificador da série utilizada numNf: type: integer format: int64 description: Número da nota fiscal issueDate: type: string format: date description: Data de emissão movementDate: type: string format: date description: Data de entrada(nf de entrada) ou data de saída(nf de saida) netValue: type: string description: Valor líquido minimum: 0.00 maximum: 9999999999999.99 invoiceType: type: string allOf: – #/definitions/enumTipoNotaFiscal description: Tipo da nota fiscal(entrada ou saida) status: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração integrationDate: type: string format: date-time description: Data da integração eletronicKey: type: string description: Chava eletrônica da nota fiscal errorMsg: 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: recInvoiceData: description: Dados da nota fiscal para exclusão type: object required: – invoiceId – codSnf properties: invoiceId: type: string description: Id da nota fiscal codEmp: type: integer format: int64 description: Código da empresa utilizada pela nota fiscal minimum: 0 maximum: 999999999 codFil: type: integer format: int64 description: Código da filial utilizada pela nota fiscal minimum: 0 maximum: 999999999 codCli: type: integer format: int64 description: Código do cliente da nota fiscal minimum: 0 maximum: 999999999 codSnf: type: string description: Código da série da nota fiscal numNfi: type: integer format: int64 description: Número da nota fiscal minimum: 0 maximum: 999999999 recIntegrationArInvoice: description: Record dos dados gerais da nf type: object properties: idOrigem: type: string maxLength: 40 description: id do documento de origem e070empId: type: string description: Id da empresa codEmp: type: string maxLength: 40 description: Código da empresa e070filId: type: string description: Id da filial codFil: type: string maxLength: 40 description: Código da filial numCgc: type: string maxLength: 18 description: CGC e001pesId: type: string description: Id da pessoa(destinatario) codPes: type: integer format: int64 description: Destinatário minimum: 0 maximum: 999999999 codEdc: type: string maxLength: 40 description: Código do modelo de documento e020snfId: type: string description: Id da série fiscal codSel: type: string maxLength: 3 description: Código da série fiscal codSsl: type: string maxLength: 2 description: Código ssl numero: type: integer format: int64 description: Número da nota fiscal minimum: 0 maximum: 999999999 dataEmissao: type: string format: date description: Data de emissão dataSaida: type: string format: date description: Data de saída dataPre: type: string format: date description: Data de previsão sigUfs: type: string maxLength: 2 description: Estado de cálculo do ICMS codRai: type: integer format: int64 description: Cidade de tributação do ISS minimum: 0 obsNfv: type: string maxLength: 255 description: Observação Nfv obsIpi: type: string maxLength: 255 description: Observação Nfv seqTra: type: integer format: int64 description: Seq transporte minimum: 0 maximum: 999999999 codVia: type: string maxLength: 3 description: Código da via de transporte ufsVei: type: string maxLength: 2 description: Uf veículo plaVei: type: string maxLength: 10 description: Placa do veículo sitNfv: type: string allOf: – #/definitions/enumSitNfs description: Situação nfv tipoNotaFiscal: type: string allOf: – #/definitions/enumTipNfs description: Tipo da nota fiscal cifFob: type: string allOf: – #/definitions/enumCifFob description: Tipo de frete seqEnt: type: integer format: int64 description: Sequência do endereço de entrega dataExecucaoServico: type: string format: date description: Data de execução do serviço dataIngressoZonaFranca: type: string format: date description: Data de ingresso Zona Franca de Manaus qtdVol: type: integer format: int64 description: Quantidade do volume pesBru: type: number format: double description: Peso bruto dos volumes da nota fiscal de saída minimum: 0.00 maximum: 999999.99999 pesLiq: type: number format: double description: Peso líquido dos volumes da nota fiscal de saída minimum: 0.00 maximum: 999999.99999 emiTer: type: string maxLength: 3 description: Emitente terceiro hashId: type: string maxLength: 40 description: Hash de acompanhamento do processo pessoas: type: object allOf: – #/definitions/recDadosPessoa description: Informações de pessoas chaveEletronica: type: string maxLength: 50 description: Chave eletrônica da nota fiscal itens: type: array items: type: object allOf: – #/definitions/recArIntegrationItem description: Itens parcelas: type: array items: type: object allOf: – #/definitions/recNfSaidaFinanceiroIntegracao description: Financeiro documentoEletronico: type: object allOf: – #/definitions/recDocEletronico description: Documento eletrônico sitDoe: type: string allOf: – #/definitions/enumSitDoe description: Situação edocs – USO APENAS PARA REGRAS DE NEGOCIO fcpSomaIcms: type: boolean description: FCP Próprio incluso ao ICMS – USO APENAS PARA REGRAS DE NEGOCIO default: false fcpSomaIcmsSt: type: boolean description: FCP Próprio incluso ao ICMS ST – USO APENAS PARA REGRAS DE NEGOCIO default: false mensagensNotaFiscal: type: array items: type: object allOf: – #/definitions/recMensagemNotaFiscal description: Mensagens da nota fiscal e001endSeqEntId: type: string description: Id do endereço para busca do sequencial vlrLiq: type: string description: Valor liquido da nota fiscal minimum: 0.00 maximum: 9999999999999.99 recArIntegrationDocRefItem: description: Record para documentos fiscais referenciados type: object required: – invRlc – seqFor – numNfc properties: codEdc: type: string maxLength: 3 description: Código do modelo do documento codSel: type: string maxLength: 3 description: Código da série fiscal codSsl: type: string maxLength: 2 description: Subsérie Legal da nota fiscal de Remessa nfvRlc: type: integer format: int64 description: Número do documento referenciado invRlc: type: integer format: int64 description: Sequência do item da nota fiscal minimum: 0 maximum: 999 seqFor: type: integer format: int64 description: Código da pessoa minimum: 0 maximum: 999999999 numNfc: type: integer format: int64 description: Número da Nota minimum: 0 maximum: 9999999 tipNfsSaida: type: string allOf: – #/definitions/enumTipNfs description: Tipo da nota de saida recDocFiscaisReferenciados: description: Record para documentos fiscais referenciados type: object properties: chvNel: type: string maxLength: 44 description: Chave documento fiscal referenciado datEmi: type: string format: date-time description: Data emissão recDocEletronico: description: Record com dados do documento eletrônico type: object properties: sitDoe: type: string maxLength: 3 description: Situação do documento fiscal sitDea: type: string maxLength: 3 description: Situação anterior do documento eletrônico chvDoe: type: string maxLength: 50 description: Chave do documento eletrônico numDfs: type: integer format: int64 description: Número da nota fiscal de serviço na prefeitura numPrt: type: string maxLength: 100 description: Número do protocolo de autorização do documento eletrônico dthAut: type: string format: date-time description: Data de autorização do documento eletrônico horAut: type: string description: Hora de autorização do documento eletrônico numPrc: type: string maxLength: 15 description: Número do protocolo de cancelamento do documento eletrônico dthCan: type: string format: date-time description: Data de cancelamento do documento eletrônico horCan: type: string description: Hora de cancelamento do documento eletrônico numPri: type: string maxLength: 15 description: Número do protocolo de inutilização do documento eletrônico dthInu: type: string format: date-time description: Data de inutilização do documento eletrônico horInu: type: string description: Hora de inutilização do documento eletrônico tipCtg: type: string allOf: – #/definitions/enumTipCtg description: Tipo de contingência em que o documento foi autorizado obsCtg: type: string maxLength: 250 description: Observação do motivo da entrada em contingência chvCtg: type: string description: Chave de contingência recNfSaidaFinanceiroIntegracao: description: Record de informações financeiras type: object properties: numTit: type: string maxLength: 15 description: Número do título codTpt: type: string maxLength: 3 description: Codigo interno do tipo de título vctPar: type: string format: date description: Data de vencimento do título valorParcela: type: string description: Valor da parcela minimum: 0.00 maximum: 9999999999999.99 default: 0 obsPar: type: string maxLength: 255 description: Observação codFpg: type: integer format: int64 description: Código Forma Pagamento minimum: 0 maximum: 99 tipCar: type: string allOf: – #/definitions/enumTipFpg description: Tipo forma de pagamento recArIntegrationItem: description: Record de item da nota fiscal type: object properties: id: type: string description: Id – USO APENAS PARA REGRAS DE NEGOCIO seqNfi: type: integer format: int64 description: Sequência minimum: 0 maximum: 999 codTns: type: string maxLength: 5 description: Transação nopOpe: type: string maxLength: 5 description: CFOP seqPro: type: integer format: int64 description: Sequencial gerado do grupo de produto minimum: 0 maximum: 999 seqSer: type: integer format: int64 description: Sequencial gerado do grupo de serviço minimum: 0 maximum: 999 cplPro: type: string maxLength: 250 description: Complemento do item desImp: type: string maxLength: 255 description: Descrição do item para impressão claFis: type: string maxLength: 40 description: Nomenclatura comum do Mercosul (NCM) codIpi: type: string maxLength: 3 description: Código interno da ipi codPis: type: string maxLength: 3 description: Código interno da ipi codCof: type: string maxLength: 3 description: Código interno da ipi qtdEnt: type: number format: double description: Quantidade minimum: 0.00 maximum: 999999999.99999 uniMed: type: string maxLength: 6 description: Unidade de medida preUni: type: string description: Preço unitário minimum: 0.00 maximum: 99999999999.9999999999 vlrCtb: type: string description: Valor da mercadoria minimum: 0.00 maximum: 9999999999999.99 vlrDsc: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 vlrDac: type: string description: Valor outras despesas minimum: 0.00 maximum: 9999999999999.99 vlrSeg: type: string description: Valor de seguro minimum: 0.00 maximum: 9999999999999.99 vlrFre: type: string description: Valor de frete minimum: 0.00 maximum: 9999999999999.99 vlrBru: type: string description: Valor bru minimum: 0.00 maximum: 9999999999999.99 ctaRed: type: integer format: int64 description: Conta contábil codCcu: type: string maxLength: 9 description: Centro de custo codCes: type: string description: Código cest proSer: type: string description: Indicador se é produto ou serviço loteSerie: type: array items: type: object allOf: – #/definitions/recLotSerieArItem description: Lotes/séries dadosDocRef: type: array items: type: object allOf: – #/definitions/recArIntegrationDocRefItem description: Dados do documento referenciado do item detalheProdSer: type: object allOf: – #/definitions/recItemProdutoServico description: Detalhe produto ou serviço rateioItem: type: object allOf: – #/definitions/recRateioItem description: Rateio do item da nf impostos: type: array items: type: object allOf: – #/definitions/recItemImposto description: Impostos somRct: type: boolean description: Indicador se o valor de retenção deve ser somado ao valor contábil e não tributadas – USO APENAS PARA REGRAS DE NEGOCIO default: false zerarValorMercadoriaContabil: type: boolean description: Indicador se o valor contabil e o valor da mercadoria devem ser zerados – USO APENAS PARA REGRAS DE NEGOCIO default: false descontaIcms: type: string description: Desconta ICMS ST – EFD ICMS IPI | – USO APENAS PARA REGRAS DE NEGOCIO itemNotaEntrada: type: string description: Item nota entrada – USO APENAS PARA REGRAS DE NEGOCIO vlrImpIPICreditadoEntrada: type: string description: Valor imp IPI creditado entrada – USO APENAS PARA REGRAS DE NEGOCIO valorDespesasAcessorias: type: string description: Valor de despesas acessórias – USO APENAS PARA REGRAS DE NEGOCIO ligacaoItemDocRef: type: object allOf: – #/definitions/recArIntegrationDocRefItem description: Documento fiscal referenciado mensagensItem: type: array items: type: object allOf: – #/definitions/recMensagemNotaFiscal description: Mensagens do item e015medId: type: string description: Id da unidade de medida recItemImposto: description: Record de imposto do item da nf type: object properties: hidden: type: boolean description: Flag indicando se o imposto esta oculto, ou seja, deve ou não ser integrado default: false tipImp: type: string allOf: – #/definitions/enumTipImpDoc description: Tipo de imposto basImp: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0 aliImp: type: number format: double description: Alíquota do imposto minimum: 0.00 maximum: 99999999999.9999 vlrImp: type: string description: Valor Imposto minimum: 0.00 maximum: 9999999999999.99 default: 0 vlrOut: type: string description: Valor Outras minimum: 0.00 maximum: 9999999999999.99 default: 0 vlrIse: type: string description: Valor Isentas minimum: 0.00 maximum: 9999999999999.99 default: 0 codStr: type: string maxLength: 3 description: Código interno da situação oriMer: type: string allOf: – #/definitions/enumOrigemMercadoria description: Origem mercadoria perRed: type: number format: double description: Percentual de redução da base do imposto minimum: 0.00 maximum: 999.99999 valorDeducao: type: string description: Valor de dedução aplLiq: type: string allOf: – #/definitions/enumAplLiq description: Aplicação do imposto – USO APENAS PARA REGRAS DE NEGÓCIO natPis: type: integer format: int64 description: Natureza receita PIS minimum: 0 maximum: 9999 natCof: type: integer format: int64 description: Natureza receita COFINS minimum: 0 maximum: 9999 codEnq: type: integer format: int64 description: Código de enquadramento do IPI minimum: 0 maximum: 9999 vlrDed: type: string description: Valor de dedução minimum: 0.00 maximum: 9999999999999.99 default: 0 recRateioItem: description: Record dos dados de rateio do item type: object properties: datBas: type: string format: date description: Data movimento rateio criRat: type: string allOf: – #/definitions/enumCriRat description: Critério de rateio ctaRed: type: integer format: int64 description: Conta contábil minimum: 0 maximum: 9999999 vlrCta: type: string description: Valor conta contábil minimum: 0.00 maximum: 9999999999999.99 codCcu: type: string maxLength: 9 description: Código centro de custo vlrRat: type: string description: Valor do rateio minimum: 0.00 maximum: 9999999999999.99 obsRat: type: string maxLength: 255 description: Observação recItemProdutoServico: description: Record dos dados de detalhamento de produto ou serviço type: object properties: id: type: string description: Id do produto/servico seqPro: type: integer format: int64 description: Sequencial unico para cadastro de produto/serviço iteFis: type: string maxLength: 23 description: Código de derivação de produto/serviço desFis: type: string maxLength: 120 description: Descrição de serviço codFam: type: string maxLength: 6 description: Código da família do serviço serImp: type: string maxLength: 10 description: Código lei complementar 116/2003 recItemNotaDevolucao: description: Record dos dados para notas de devolução type: object required: – numNfc properties: seqFor: type: integer format: int64 description: Código da pessoa minimum: 0 maximum: 999999999 codEdc: type: string maxLength: 3 description: Código do modelo do documento codSel: type: string maxLength: 3 description: Série Legal da nota fiscal de Remessa codSsl: type: string maxLength: 2 description: Subsérie Legal da nota fiscal de Remessa numNfc: type: integer format: int64 description: Numero da nota fiscal minimum: 0 maximum: 999999999 seqIpc: type: integer format: int64 description: Sequencia do item recLotSerieArItem: description: Lotes e séries do item da nota type: object properties: datVlt: type: string format: date description: Data de validade datFab: type: string format: date description: Data de fabricação codLot: type: string maxLength: 50 description: Número do lote numSep: type: string maxLength: 50 description: Número da série qtdEst: type: number format: double description: Quantidade de movimento minimum: 0.00 maximum: 999999999.99999 recMensagemNotaFiscal: description: Mensagens do item e da nota fiscal type: object properties: codMsg: type: string description: Código da mensagem desMsg: type: string description: Descrição da mensagem recDadosPessoa: description: Record de dados do cliente e da da nf type: object properties: seqCliente: type: integer format: int64 description: Sequencial do cliente minimum: 0 maximum: 999999999 codCliente: type: integer format: int64 description: Código do cliente minimum: 0 maximum: 999999999 seqTransportadora: type: integer format: int64 description: Sequencial da transportadora minimum: 0 maximum: 999999999 codTransportadora: type: integer format: int64 description: Código da transportadora minimum: 0 maximum: 999999999 seqFornecedor: type: integer format: int64 description: Sequencial do fornecedor minimum: 0 maximum: 999999999 codFornecedor: type: integer format: int64 description: Código do fornecedor minimum: 0 maximum: 999999999 processIntegrationResponsePayload: description: Payload da resposta de integração type: object required: – integrationId – serviceName – status properties: integrationId: type: string description: id de integração serviceName: type: string description: Nome do serviço status: type: object allOf: – #/definitions/statusIntegrationResponse description: Status da integração statusIntegrationResponse: description: Status da resposta de integração type: object required: – type – detail properties: type: type: string description: Tipo do status detail: type: string description: Detalhes do status 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 signalChangePayload: description: Payload de alteração de entidade type: object required: – id – changeAction properties: id: type: string description: Id da entidade principal da integração changeAction: type: string allOf: – #/definitions/enumChangeAction description: Ação da mudança signalChangeIntegrationStatus: description: Payload de alteração do status das integrações type: object required: – status – integrationType – keyId properties: status: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração integrationType: type: string description: Tipo da integração a alterar o status keyId: type: string description: Id da entidade que está sendo integrada errorMsg: type: string description: Mensagem de erro (em caso de erros) recEntityFacade: description: Payload com as informações das entidades integradas type: object required: – competenceDate – movementDate properties: e070emp: type: object allOf: – #/definitions/recGenerico description: Empresa e070fil: type: object allOf: – #/definitions/recGenerico description: Filial entityIntegrated: type: object allOf: – #/definitions/recGenerico description: Entidade integrada competenceDate: type: string description: Competência movementDate: type: string description: Data de entrada recGenerico: description: Dados consultas genericas type: object properties: codigo: type: string description: Código descricao: type: string description: Descrição recSearchIntegration: description: Payload com todas as informações da integração type: object required: – id – keyId – typeKey – lastIntegrationDate – integrationStatus – detail – errorMsg – recEntityFacade properties: id: type: string description: Identificador das integrações keyId: type: string description: Identificador item de integração typeKey: type: string allOf: – #/definitions/enumTypeKey description: Enum do tipo de integração lastIntegrationDate: type: string description: Última data de integração integrationStatus: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração detail: type: string description: Log do processo de integração errorMsg: type: string description: Mensagem de erro para o Usuario recEntityFacade: type: object allOf: – #/definitions/recEntityFacade description: Lista das integrações recInvoiceHeaderIntegrationProcess: description: Payload com os dados do integration process das notas fiscais type: object required: – id – lastIntegrationDate – errorMsg – integrationStatus – user properties: id: type: string description: Id da entidade(integrationProcess) lastIntegrationDate: type: string format: date-time description: Ultima data de integração errorMsg: type: string description: Mensagem de erro da integração integrationStatus: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração user: type: string description: Usuário recDetailPersonIntegration: description: Payload com os detalhes da integração da Pessoa type: object required: – id – integrationDate – user – definitionPerson – statusIntegration – typeIntegration – detail – errorMsg properties: id: type: string description: Identificador dos detalhes da integração integrationDate: type: string description: Data de Integração user: type: string description: Usuário definitionPerson: type: string allOf: – #/definitions/enumDefinitionPerson description: Definição da Pessoa statusIntegration: type: string allOf: – #/definitions/enumStatusIntegration description: Status Integração typeIntegration: type: string allOf: – #/definitions/enumTypeIntegration description: Tipo Integração detail: type: string description: Log do processo de integração errorMsg: type: string description: Mensagem de erro para o Usuario recDetailProductIntegration: description: Payload com os detalhes da integração do Produto type: object required: – id – integrationDate – user – statusIntegration – typeIntegration – detail – errorMsg properties: id: type: string description: Identificador dos detalhes da integração integrationDate: type: string description: Data de integração user: type: string description: Usuário statusIntegration: type: string allOf: – #/definitions/enumStatusIntegration description: Status da integração typeIntegration: type: string allOf: – #/definitions/enumTypeIntegration description: Tipo de integração detail: type: string description: Log do processo de integração errorMsg: type: string description: Mensagem de erro para o Usuario recSaldoFisicoEstoqueXt: description: Dto Registro Saldo Fisico Estoque XT type: object properties: e070emp_id: type: string maxLength: 40 description: Id da empresa codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 codFil: type: integer format: int64 description: Código da filial minimum: 0 maximum: 9999 e070fil_id: type: string maxLength: 40 description: Id da filial competencia: type: string format: date description: Competência e075der_id: type: string maxLength: 40 description: Produto codDer: type: string description: Código do produto desDer: type: string description: Descrição do produto e045pla_id: type: string maxLength: 40 description: Código da conta contábil e015med_id: type: string maxLength: 40 description: Unidade de medida valorUnitarioItem: type: string description: Valor unitário do item minimum: 0.0 maximum: 999999999.99999 default: 0.0 quantidadeTotal: type: string description: Quantidade total em estoque valorTotal: type: string description: Valor total em estoque quantidadeEstoqueProprio: type: string description: Quantidade em estoque próprio minimum: 0.0 default: 0.0 valorEstoqueProprio: type: string description: Valor de estoque próprio minimum: 0.0 default: 0.0 precoMedio: type: string description: Preço médio quantidadeElaboracao: type: string description: Quantidade em elaboração minimum: 0.0 default: 0.0 valorElaboracao: type: string description: Valor de estoque em elaboração minimum: 0.0 default: 0.0 quantidadeDeTerceiro: type: string description: Quantidade de estoque de terceiro em poder da empresa minimum: 0.0 default: 0.0 valorDeTerceiro: type: string description: Valor de estoque de terceiro em poder da empresa minimum: 0.0 default: 0.0 quantidadeEmTerceiro: type: string description: Quantidade de estoque da empresa em poder de terceiro minimum: 0.0 default: 0.0 valorEmTerceiro: type: string description: Valor de estoque da empresa em poder de terceiro minimum: 0.0 default: 0.0 origem: type: string allOf: – #/definitions/enumOrigemDocumento description: Origem do documento processo: type: string allOf: – #/definitions/enumSaldoFisicoEstoqueProcesso description: Status do processo de exclusão recDetalhamentoSaldoFisicoEstoque: description: Dto Detalhamento Saldo Fisico Estoque type: object properties: id: type: string maxLength: 40 description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 codFil: type: integer format: int64 description: Código da filial minimum: 0 maximum: 9999 codDer: type: string description: Código do produto e001pes_id: type: string maxLength: 40 description: Id da pessoa codPes: type: integer format: int64 description: Código da pessoa minimum: 0 maximum: 999999999 competencia: type: string format: date description: Competência quantidadeDeTerceiro: type: string description: Quantidade de estoque de terceiro em poder da empresa minimum: 0.0 default: 0.0 valorDeTerceiro: type: string description: Valor de estoque de terceiro em poder da empresa minimum: 0.0 default: 0.0 quantidadeEmTerceiro: type: string description: Quantidade de estoque da empresa em poder de terceiro minimum: 0.0 default: 0.0 valorEmTerceiro: type: string description: Valor de estoque da empresa em poder de terceiro minimum: 0.0 default: 0.0 tipMov: type: string description: Tipo de movimento recPageRequest: description: Record de paginação e ordenação de registros type: object required: – offset – size – orderBy properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de páginas orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy minimum: 1 description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Definição de campo a ser ordenado type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) nfEntradaIntegracao: description: Record para integração nota de entrada type: object properties: idOrigem: type: string description: Id do documento de origem e070empId: type: string description: Id da empresa e070filId: type: string description: Id da filial e001pesId: type: string description: Id da pessoa(remetente) e020snfId: type: string description: Id da série codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 codFil: type: integer format: int64 description: Código da filial minimum: 0 maximum: 9999 numCgc: type: string maxLength: 18 description: CGC filial seqFor: type: integer format: int64 description: Código da pessoa minimum: 0 maximum: 999999999 codEdc: type: string maxLength: 3 description: Código do modelo do documento codSel: type: string maxLength: 3 description: Série legal da nota fiscal de remessa codSsl: type: string maxLength: 2 description: Subsérie legal da nota fiscal de remessa numNfi: type: integer format: int64 description: Número da nota minimum: 0 maximum: 999999999 datEmi: type: string format: date description: Data emissão datEnt: type: string format: date description: Data entrada datEx: type: string format: date description: Data exs (ver com o Lucas) obsNfc: type: string maxLength: 1000 description: Observação nota de entrada obsIpi: type: string description: Observação IPI numDoi: type: string maxLength: 20 description: Número DI tipNdi: type: string allOf: – #/definitions/enumTipNdi description: Documento Importação datDoi: type: string format: date description: Data Registro DI locDes: type: string maxLength: 60 description: Local de desembaraço datDes: type: string format: date description: Data do desembaraço aduaneiro ufsDes: type: string maxLength: 2 description: Estado desembaraço codExp: type: integer format: int64 description: Código do exportador minimum: 0 maximum: 999999999 codCpg: type: string maxLength: 6 description: Código da condição de pagamento seqOrm: type: integer format: int64 description: Sequência do endereço de coleta do fornecedor e001endSeqEntId: type: string description: Id do endereço para busca do sequencial e074via: type: string description: Via de transporte ufsVei: type: string maxLength: 2 description: UF do veículo plaVei: type: string maxLength: 10 description: Placa do veículo sitNfc: type: string allOf: – #/definitions/enumSitNfsEntrada description: Situação cifFob: type: string allOf: – #/definitions/enumCifFob description: Tipo de frete ufsCic: type: string maxLength: 2 description: UF do endereço de coleta do fornecedor numDfs: type: string maxLength: 15 description: Número do documento fiscal de serviço chvNel: type: string maxLength: 51 description: Chave de acesso à nota na sefaz tipNfe: type: string allOf: – #/definitions/enumTipNfe description: Tipo de nota fiscal disAut: type: string allOf: – #/definitions/enumDisAut description: Dispositivo autorizado tipoNotaFrete: type: string allOf: – #/definitions/enumTipoNotaFiscal description: Indicativo de tipo de nota de entrada ou saída codRai: type: integer format: int64 description: Código Cidade minimum: 0 maximum: 9999999 raiRem: type: integer format: int64 description: Cidade do remetente minimum: 0 maximum: 9999999 raiDes: type: integer format: int64 description: Cidade do destinatário minimum: 0 maximum: 9999999 pesBru: type: number format: double description: Peso bruto dos itens minimum: 0.00 maximum: 99999999.99999 pesLiq: type: number format: double description: Peso líquido minimum: 0.00 maximum: 99999999.99999 vlrTer: type: string description: Valor em nome de terceiros minimum: 0.00 maximum: 9999999999999.99 vlrLiq: type: string description: Valor liquido da nota minimum: -9999999999999.99 maximum: 9999999999999.99 default: 0.00 hash: type: string description: ID de acompanhamento do processo assincrono seqTra: type: string description: Codigo da pessoa transportadora codVia: type: string description: Via de transporte mesesCiap: type: integer format: int64 description: Meses ciap difCiap: type: boolean description: Dif ciap default: false codRtr: type: string allOf: – #/definitions/enumCodCrt description: Cod rtr cnpcpf: type: string description: Emitente cliTra: type: object allOf: – #/definitions/recDadosCliTra description: Informações de cliente e transportadora forn: type: object allOf: – #/definitions/recDadosFornecedor description: Informações de fornecedor itens: type: array items: type: object allOf: – #/definitions/recItemIntegracao description: Itens da nota parcelas: type: array items: type: object allOf: – #/definitions/recParcelaIntegracao description: Parcelas cte: type: array items: type: object allOf: – #/definitions/recCte description: Conhecimento de transporte mensagens: type: array items: type: object allOf: – #/definitions/recMensagemIntegracao description: Mensagens de documentos fiscais recItemIntegracao: description: record item da integração type: object properties: id: type: string description: Id do item somaRetencoes: type: boolean description: Indicador se o valor de retenção deve ser somado ao valor contábil e não tributadas default: false descontaIcmsSt: type: string allOf: – #/definitions/enumDescontaICMSSTEntrada description: Desconta ICMS ST zerarValorMercCont: type: boolean description: Zerar valor contábil e mercadoria das notas fiscais na integração para tributos default: false seqNfi: type: integer format: int64 description: Sequencia do item da nota fiscal codTns: type: string maxLength: 5 description: Código da transação nopOpe: type: string maxLength: 5 description: Natureza de operação seqPro: type: integer format: int64 description: Sequencia do produto seqSer: type: integer format: int64 description: Sequencia do serviço cplPro: type: string maxLength: 200 description: Complemento claFis: type: string maxLength: 8 description: Código ncm qtdEnt: type: number format: double description: Quantidade recebida minimum: 0.00 maximum: 999999999.99999 e015medId: type: string description: Id da unidade de medida uniMed: type: string maxLength: 6 description: Unidade de medida preUni: type: number format: double description: Preço unitário minimum: 0.00 maximum: 99999999999.9999999999 vlrCtb: type: string description: Valor contábil minimum: 0.00 maximum: 9999999999999.99 vlrFei: type: string description: Valor Frete Importação minimum: 0.00 maximum: 9999999999999.99 vlrSei: type: string description: Valor Seguro Importação minimum: 0.00 maximum: 9999999999999.99 vlrOui: type: string description: Valor Outras Despesas Importação minimum: 0.00 maximum: 9999999999999.99 vlrDsc: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 vlrDac: type: string description: Valor dos encargos minimum: 0.00 maximum: 9999999999999.99 vlrSeg: type: string description: Valor seguro minimum: 0.00 maximum: 9999999999999.99 vlrFre: type: string description: Valor do Frete minimum: 0.00 maximum: 9999999999999.99 vlrCip: type: string description: Valor proporção ciap minimum: 0.00 maximum: 9999999999999.99 vlrIop: type: string description: Valor icms creditado minimum: 0.00 maximum: 9999999999999.99 vlrIst: type: string description: Valor icms st minimum: 0.00 maximum: 9999999999999.99 vlrIdf: type: string description: Valor difal minimum: 0.00 maximum: 9999999999999.99 ctaRed: type: integer format: int64 description: Código conta contábil minimum: 0 maximum: 9999999 codCcu: type: string maxLength: 9 description: Código do centro de custos codEdc: type: string maxLength: 3 description: Código do modelo do documento codSel: type: string maxLength: 3 description: Série legal da nota fiscal de remessa codSsl: type: string maxLength: 2 description: Subsérie legal da nota fiscal de remessa seqCli: type: integer format: int64 description: Sequencia cliente minimum: 0 maximum: 999999999 numNfv: type: integer format: int64 description: Número da nota fiscal de saída minimum: 0 maximum: 99999999 seqIpv: type: integer format: int64 description: Sequencia do item da nota de saída minimum: 0 maximum: 999 vlrMrc: type: string description: Valor da mercadoria minimum: 0.00 maximum: 9999999999999.99 vlrAfm: type: string description: Valor da AFRMM minimum: 0.00 maximum: 9999999999999.99 numDrb: type: string maxLength: 11 description: Numero ato drawback numAdi: type: integer format: int64 description: Número da adição minimum: 0 maximum: 999 seqAdi: type: integer format: int64 description: Número seq. item adição minimum: 0 maximum: 999 dscAdi: type: string description: Valor desconto item DI minimum: 0.00 maximum: 9999999999999.99 codCes: type: string maxLength: 7 description: Código especificador da substituição tributária tipo: type: string description: Indicativo se é produto ou serviço valorICMSOperacaoPropria: type: string description: Valor ICMS operação própria minimum: 0.0 default: 0.0 valorICMSOperacaoST: type: string description: Valor ICMS operação ST minimum: 0.0 default: 0.0 valorICMSDifal: type: string description: Valor ICMS – DIFAL minimum: 0.0 default: 0.0 valorProporcaoCiap: type: string description: Valor Proporção Ciap minimum: 0.0 default: 0.0 valorICMSNaoCreditado: type: string description: Valor ICMS não creditado minimum: 0.0 default: 0.0 recupSitCiap: type: boolean description: Flag para indicar se recupera ou não ciap default: false ciap: type: array items: type: object allOf: – #/definitions/recItemNotaFiscalCiapIntegracao description: Informações de ciap cprTcf: type: string allOf: – #/definitions/enumAplNop description: Aplicação da natureza da operação recupDifCiap: type: boolean description: Flag que indica se recupera diferenca de ciap default: false impostos: type: array items: type: object allOf: – #/definitions/recEntradaItemImpostos description: Impostos loteSerie: type: array items: type: object allOf: – #/definitions/recNfEntradaLoteSerie description: Lote e Série detalheProdSer: type: object allOf: – #/definitions/recItemEntradaProdSer description: Detalher produto ou serviço rateio: type: object allOf: – #/definitions/recRateioItemNotaEntrada description: Rateio do item da nota de entrada importacao: type: object allOf: – #/definitions/recItemEntradaImportacao description: Informações de importação do item docRefItem: type: object allOf: – #/definitions/recDocRefItemIntegracao description: Documento fiscal referenciado recItemNotaFiscalCiapIntegracao: description: Record das informações de ciap type: object properties: itemNfTrasportadaOrigemId: type: string description: Item nota fiscal transportada origem id valorIcmsCreditado: type: string description: Valor do Icms Creditado minimum: 0.00 maximum: 9999999999999.99 valorIcmsSt: type: string description: Valor do Icms ST minimum: 0.00 maximum: 9999999999999.99 valorDifal: type: string description: Valor do Difal minimum: 0.00 maximum: 9999999999999.99 valorProporcaoCiap: type: string description: Proporção do cálculo do ciap minimum: 0.00 maximum: 9999999999999.99 recItemEntradaImportacao: description: Record de informações de importação do item type: object properties: numDrb: type: string description: Num. Ato Drawback numAdi: type: integer format: int64 description: Número da adição seqAdi: type: integer format: int64 description: Número seq. item adição dscAdi: type: string description: Valor desconto item DI vlrAfm: type: string description: Valor de AFRMM vlrFei: type: string description: Valor fei vlrSei: type: string description: Valor sei vlrOui: type: string description: Valor oui recRateioItemNotaEntrada: description: Record Rateio item da nota de entrada type: object properties: datBas: type: string format: date description: Data movimento rateio criRat: type: string allOf: – #/definitions/enumCriRat description: Critério de rateio ctaRed: type: integer format: int64 description: Conta contábil minimum: 0 maximum: 9999999 vlrCta: type: string description: Valor conta contábil minimum: 0.00 maximum: 9999999999999.99 codCcu: type: string maxLength: 9 description: Código centro de custo vlrRat: type: string description: Valor do rateio minimum: 0.00 maximum: 9999999999999.99 obsRat: type: string maxLength: 255 description: Observação recItemEntradaProdSer: description: Record item nota entrada de produto e servico type: object required: – tipo properties: id: type: string description: Id do produto/serviço para geração do sequencial seqPro: type: integer format: int64 description: Sequencial unico para cadastro de produto/serviço iteFis: type: string maxLength: 23 description: Código de derivação de produto/serviço desFis: type: string maxLength: 120 description: Descrição de serviço codFam: type: string maxLength: 6 description: Código da família do serviço serImp: type: string maxLength: 10 description: Código lei complementar 116/2003 tipo: type: string allOf: – #/definitions/enumTipoItemNota description: Tipo do item recDocRefItemIntegracao: description: Record referente as informações de documento fiscal referenciado type: object properties: codPes: type: integer format: int64 description: Código pessoa minimum: 0 maximum: 999999999 codEdc: type: string maxLength: 3 description: Código do modelo de documento codSel: type: string maxLength: 3 description: Série codSsl: type: string maxLength: 2 description: Subsérie numNfs: type: integer format: int64 description: Número da nota fiscal minimum: 0 maximum: 999999999999999 seqItem: type: integer format: int64 description: Sequencia do item tipNfeEntrada: type: string allOf: – #/definitions/enumTipNfe description: Tipo da nota fiscal de entrada recNfEntradaLoteSerie: description: record nota fiscal de entrada lote/serie type: object properties: codDep: type: string maxLength: 10 description: Código do depósito datEnt: type: string format: date description: Data entrada datFab: type: string format: date description: Data fabricação datVlt: type: string format: date description: Data de validade codLot: type: string maxLength: 50 description: Código do lote numSep: type: string maxLength: 50 description: Número de série qtdEst: type: number format: double description: Quantidade recebida minimum: 0.00 maximum: 999999999.99999 obsDls: type: string maxLength: 250 description: Observação recEntradaItemImpostos: description: record item de impostos nota de entrada type: object properties: hidden: type: boolean description: Flag indicando se o imposto esta oculto, ou seja, deve ou não ser integrado default: false tipImp: type: string allOf: – #/definitions/enumTipImpDocEntrada description: Tipo de imposto basImp: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0.0 aliImp: type: number format: double description: Alíquota do imposto minimum: 0.00 maximum: 99999999999.9999 default: 0.0 aliDes: type: number format: double description: Alíquota de ICMS interestadual da UF de destino minimum: 0.00 maximum: 99999999999.9999 default: 0.0 vlrImp: type: string description: Valor Imposto minimum: 0.00 maximum: 9999999999999.99 default: 0.0 vlrOut: type: string description: Valor Outras minimum: 0.00 maximum: 9999999999999.99 default: 0.0 vlrIse: type: string description: Valor Isentas minimum: 0.00 maximum: 9999999999999.99 default: 0.0 vlrIpn: type: string description: Valor imposto não recuperado minimum: 0.00 maximum: 9999999999999.99 default: 0.0 vlrRet: type: string description: Valor Icms St retido minimum: 0.00 maximum: 99999999999.9999 default: 0.0 perRed: type: number format: double description: Percentual de redução da base do imposto minimum: 0.00 maximum: 999.99999 default: 0.0 valorDeducao: type: string description: Valor de dedução minimum: 0.0 default: 0.0 codStr: type: string maxLength: 3 description: Código interno da situação basCre: type: string allOf: – #/definitions/enumTipoCreditoRecuperado description: Tipo de base de cálculo de crédito codEnq: type: integer format: int64 description: Código de enquadramento do IPI minimum: 0 maximum: 9999 vlrDed: type: string description: Valor de dedução minimum: 0.00 maximum: 9999999999999.99 default: 0 obsIpi: type: string description: Observação do ipi oriMer: type: string allOf: – #/definitions/enumOrigemMercadoria description: Origem fiscal da mercadoria recDadosCliTra: description: record dados cliTra type: object properties: seqCliente: type: integer format: int64 description: Sequencial do cliente minimum: 0 maximum: 999999999 codCliente: type: integer format: int64 description: Código do cliente minimum: 0 maximum: 999999999 seqTransportadora: type: integer format: int64 description: Sequencial da transportadora minimum: 0 maximum: 999999999 codTransportadora: type: integer format: int64 description: Código da transportadora minimum: 0 maximum: 999999999 recDadosFornecedor: description: Record dados do fornecedor type: object properties: seqFornecedor: type: integer format: int64 description: Sequencial do fornecedor minimum: 0 maximum: 999999999 codFornecedor: type: integer format: int64 description: Código do fornecedor minimum: 0 maximum: 999999999 oriMer: type: object allOf: – #/definitions/recOrigemMercadoria description: Origem mercadoria recOrigemMercadoria: description: Record origem de mercadoria type: object properties: endId: type: string description: Id do endereço para busca do sequencial seqOrm: type: integer format: int64 description: Sequencial de origem da mercadoria minimum: 0 maximum: 999999999 endOrm: type: string maxLength: 100 description: Endereço de origem da mercadoria cplOrm: type: string maxLength: 200 description: Complemento prxOrm: type: string maxLength: 200 description: Ponto de referência codRai: type: integer format: int64 description: Código Cidade minimum: 0 maximum: 9999999 cepOrm: type: string maxLength: 20 description: Código Postal cidOrm: type: string maxLength: 60 description: Cidade estOrm: type: string maxLength: 2 description: UF de origem da mercadoria baiOrm: type: string maxLength: 75 description: Bairro insOrm: type: string maxLength: 25 description: Inscrição estadual cgcOrm: type: string maxLength: 14 description: CNPJ/CPF nenEnd: type: string maxLength: 60 description: Número paiOrm: type: string maxLength: 4 description: Código do país de origem da mercadoria tipOrm: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa de origem da mercadoria recParcelaIntegracao: description: Record parcela da integração type: object properties: numTit: type: string maxLength: 15 description: Número do título/parcela codTpt: type: string maxLength: 3 description: Tipo de título vctPar: type: string format: date description: Data de vencimento vlrPar: type: string description: Valor da parcela minimum: 0.00 maximum: 9999999999999.99 default: 0.0 obsPar: type: string maxLength: 250 description: Observação da parcela recCte: description: Record recCte type: object required: – idNotaOrigem properties: idNotaOrigem: type: string description: Identificador da nota fiscal seqFor: type: integer format: int64 description: Código do fornecedor minimum: 0 maximum: 999999999 numRlc: type: integer format: int64 description: Número da nota fiscal de saída minimum: 0 maximum: 9999999 codEdc: type: string maxLength: 3 description: Código do modelo do documento codSel: type: string maxLength: 3 description: Série legal da nota fiscal de remessa codSsl: type: string maxLength: 2 description: Subsérie legal da nota fiscal de remessa recMensagemIntegracao: description: Recors mensagem de integração type: object properties: codMsg: type: integer format: int64 description: Código mensagem minimum: 0 maximum: 9999 desMsg: type: string maxLength: 1000 description: Descrição mensagem recIntegrationBatch: description: Record dos lotes contábeis type: object required: – id properties: id: type: string description: Identificador dos lotes contábeis integrationId: type: string maxLength: 40 description: Hash de acompanhamento do processo codEmp: type: string maxLength: 40 description: Código da empresa codFil: type: string maxLength: 40 description: Código da filial oriLot: type: string allOf: – #/definitions/enumOriLct description: Origem desLot: type: string description: Descrição do lote totLote: type: string description: Valor total do lote minimum: 0.00 maximum: 9999999999999.99 datLot: type: string format: date description: Data do lote tipLot: type: string allOf: – #/definitions/enumTipLct description: Tipo do lote numLot: type: integer format: int64 description: Número do lote recIntegrationAccountingEntries: description: Record lançamentos contábeis type: object required: – id properties: id: type: string description: Identificador dos lançamentos contábeis integrationId: type: string maxLength: 40 description: Hash de acompanhamento do processo lote (e640lotErpxt) codEmp: type: string maxLength: 40 description: Código da empresa codFil: type: string maxLength: 40 description: Código da filial numLote: type: integer format: int64 description: Número do lote contábil numFtc: type: integer format: int64 description: Número fato contábil datLct: type: string format: date description: Data do lançamento ctaCre: type: string description: Conta reduzida crédito ctaDeb: type: string description: Conta reduzida débito vlrLct: type: string description: Valor do lançamento contábil minimum: 0.00 maximum: 9999999999999.99 codHpd: type: integer format: int64 description: Código do histórico padrão oriLct: type: string allOf: – #/definitions/enumOriLct description: Origem do lançamento cplLct: type: string description: Complemento do lançamento docLct: type: string description: Documento desLot: type: string allOf: – #/definitions/enumOriLct description: Descrição da origem lote cgcCpf: type: string description: CNPJ/CPG codFor: type: integer format: int64 description: Código do fornecedor minimum: 0 maximum: 999999999 cgcCre: type: string description: CGC pessoa forCre: type: integer format: int64 description: Código pessoa minimum: 0 maximum: 999999999 obsCpl: type: string description: Observação complementar do lançamento rateio: type: array items: type: object allOf: – #/definitions/recRateioLct description: Informações de rateio infAuxiliar: type: array items: type: object allOf: – #/definitions/recInfoAuxiliares description: Informações auxiliares datExt: type: string format: date description: Data do lançamento extemporâneo tipRet: type: string description: Tipo de retorno recebido tipLct: type: string allOf: – #/definitions/enumTipLct description: Tipo do lançamento ignorarRatAux: type: string description: Indicador para ignorar rateios idE640Lot: type: string description: Identificador do lote contábil geraAux: type: boolean description: Inidicativo se deve ser feito o preenchimento das informações auxiliares geraRat: type: boolean description: Inidicativo se deve ser feito o preenchimento do rateio recRateioLct: description: Rateio dos lançamentos contábeis type: object required: – id – perRat properties: id: type: string description: Identificador rateio dos lançamentos contábeis ctaRed: type: string description: Conta contábil reduzida codCcu: type: string description: Centro de custo perRat: type: number format: double description: Percentual de rateio para centro de custo minimum: 0 maximum: 100 vlrRat: type: string description: Valor do rateio para centro de custo minimum: 0.00 maximum: 9999999999999.99 ctaFin: type: string description: Conta financeira reduzida recInfoAuxiliares: description: Composição auxiliar do lançamento contábil type: object required: – id properties: id: type: string description: Identificador único ctaRed: type: string description: Conta contábil reduzida ctaAux: type: string description: Conta reduzida auxiliar vlrAux: type: string description: Valor do lançamento auxiliar minimum: 0.00 maximum: 9999999999999.99 codHpd: type: integer format: int64 description: Código do histórico padrão cplLct: type: string description: Descrição complementar do lançamento auxiliar docLct: type: string description: Documento do lançamento auxiliar recProcessLoteCtb: description: Dados para processamento do lote contábil type: object required: – id – numLot properties: id: type: string description: Identificador processo do lote contábil integrationId: type: string maxLength: 40 description: Hash de acompanhamento do processo codEmp: type: string maxLength: 40 description: Código da empresa numLot: type: string description: Número do lote datIni: type: string format: date description: Data inicial datFim: type: string format: date description: Data final codAfi: type: integer format: int64 description: Código do agrupamento de filiais codFil: type: string maxLength: 40 description: Código da filial oriLct: type: string allOf: – #/definitions/enumOriLct description: Origem do lote indMod: type: integer format: int64 description: Situação do lote indOp: type: integer format: int64 description: Opção de processamento indClas: type: integer format: int64 description: Classificação dos registros processados recInvoiceHeaderIntegration: description: Record com os dados principais das notas fiscais para monitoramento da integração type: object required: – id – codemp – sigemp – codfil – sigfil – codpes – nompes – codsnf – numnf – datemi – vlrliq – integrationDate – dthalt – integrationStatus properties: id: type: string description: Id da nota fiscal codemp: type: integer format: int64 description: Código da empresa emitente sigemp: type: string description: Nome fantasia da empresa emitente codfil: type: integer format: int64 description: Código da filial emitente sigfil: type: string description: Nome fantasia da filial emitente codpes: type: integer format: int64 description: Código do destinarário(pessoa) nompes: type: string description: Nome do destinatário codsnf: type: string description: Código da série codssl: type: integer format: int64 description: Código da série legal numnf: type: integer format: int64 description: Número da nota fiscal datemi: type: string format: date description: Data de emissão da nota fiscal vlrliq: type: string description: Valor líquido integrationDate: type: string format: date-time description: Data da integração dthalt: type: string format: date-time description: Ultima data de alteração do registro integrationStatus: type: string allOf: – #/definitions/enumStatusIntegration description: Situação da integração errorMsg: type: string description: Mensagem de erro notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE