2.0info: 1.2.0 integrador description: Serviço de integração com GKO x-senior-domain: erp_log_gko x-senior-domain-path: erp_log_gko x-senior-service-path: integrador 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/erp_log_gkosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integrador/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/queries/buscarDocumentos: post: description: API responsável pela consulta dos documentos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – pageRequest properties: filtro: type: object allOf: – #/definitions/recEventoDocumentoFiltro description: Filtro dos documentos pageRequest: type: object allOf: – #/definitions/recPaginacao description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – listaDocumentos – totalRegistros properties: listaDocumentos: type: array items: type: object allOf: – #/definitions/recEventoDocumentoOutput minimum: 1 description: Lista de documentos totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/queries/buscarLogs: post: description: API responsável pela consulta das ocorrências vinculadas ao documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – pageRequest properties: id: type: string description: Identificador do evento pageRequest: type: object allOf: – #/definitions/recPaginacao description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – logs – totalRegistros properties: logs: type: array items: type: object allOf: – #/definitions/recLogEventoDocumentoOutput minimum: 1 description: Lista de ocorrências totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/queries/buscarDocumentoItens: post: description: API responsável pela consulta dos itens vinculados ao documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – pageRequest properties: id: type: string description: Identificador do evento pageRequest: type: object allOf: – #/definitions/recPaginacao description: Controle de paginação e ordenação responses: 200: description: Ok schema: type: object required: – listaDocumentoItens – totalRegistros properties: listaDocumentoItens: type: array items: type: object allOf: – #/definitions/recEventoDocumentoItemOutput minimum: 1 description: Lista de itens do documento totalRegistros: type: integer format: int64 description: Total de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/queries/buscarJson: post: description: API responsável pela consulta do payload vinculado ao documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do evento responses: 200: description: Ok schema: type: object required: – json properties: json: type: object allOf: – #/definitions/recEventoDocumentoPayloadOutput description: Payload 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API responsável pela consulta do payload vinculado ao documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do evento in: query required: true type: string responses: 200: description: Ok schema: type: object required: – json properties: json: type: object allOf: – #/definitions/recEventoDocumentoPayloadOutput description: Payload 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/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 /integrador/queries/exportParametroIntegracao: 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 /integrador/queries/exportEventoDocumento: 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 /integrador/queries/exportLogEventoDocumento: 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 /integrador/queries/exportEventoDocumentoItem: 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 /integrador/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 /integrador/actions/migrateSchema: post: description: Migra o schema na base de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/actions/forceMigrateSchema: post: description: Executa o migrateSchema já removendo o tenant atual do cache da migração do schema do banco de dados, sem necessidade de reiniciar o serviço tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/actions/resetSchema: post: description: Realiza a limpeza da base de dados, mantendo somente os dados padrões (conforme carga inicial) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/actions/initialLoadDefaultBase: post: description: Carga inicial de dados da base padrão tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: wizardCall: type: boolean description: Indica se quem está chamando a carga inicial é o Wizard na preparação de ambiente responses: 200: description: Ok schema: type: object properties: migrationVersion: type: string description: Indica a versão do migration migrated: type: boolean description: Indica se já foi migrado ou não 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/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 /integrador/actions/importParametroIntegracao: 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 /integrador/actions/importEventoDocumento: 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 /integrador/actions/importLogEventoDocumento: 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 /integrador/actions/importEventoDocumentoItem: 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 /integrador/signals/reenviarDocumento: post: description: Sinal responsável pelo reenvio do documento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do evento responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/atualizarStatusDocumento: post: description: Sinal responsável pela atualização da situação do documento tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – statusCode properties: id: type: string description: Identificador do documento statusCode: type: integer format: int64 description: Código HTTP mensagem: type: string description: Mensagem de retorno responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/registrarNotaFiscal: post: description: Sinal responsável pela integração de notas fiscais tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – notasFiscais properties: notasFiscais: type: array items: type: object allOf: – #/definitions/recNotaFiscal minimum: 1 description: Lista de notas fiscais responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/registrarParametroIntegracao: post: description: API responsável pelo registro dos parâmetros de integração tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: cnpjFilial: type: string description: CNPJ filial usuario: type: string description: Usuário senha: type: string description: Senha database: type: string description: Database url: type: string description: URL versaoErp: type: string description: Versão ERP tipoFreteEntrada: type: string description: Tipo frete entrada tipoFreteSaida: type: string description: Tipo frete saída codigoEmpresa: type: integer format: int64 description: Código da empresa nomeEmpresa: type: string maxLength: 100 description: Nome da empresa codigoFilial: type: integer format: int64 description: Código da filial nomeFilial: type: string maxLength: 100 description: Nome da filial tipoPrevisao: type: string maxLength: 3 description: Tipo previsão transacaoPrevisao: type: string maxLength: 5 description: Transação para previstos tipoEfetivo: type: string maxLength: 3 description: Tipo para efetivos transacaoEfetivo: type: string maxLength: 5 description: Transação para efetivos exigeCte: type: string maxLength: 1 description: Exige conhecimento de transporte responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/excluirParametroIntegracao: post: description: API responsável pela exclusão dos parâmetros de integração tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/registrarTitulo: post: description: API responsável pelo registro de títulos a pagar no ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id – cnpjFilial properties: id: type: string description: Identificador único cnpjFilial: type: string description: CNPJ da filial fornecedor: type: object allOf: – #/definitions/recParticipante description: Dados do fornecedor detalhes: type: object allOf: – #/definitions/recTituloDetalhe description: Detalhes do título documentosRelacionados: type: array items: type: object allOf: – #/definitions/recTituloDocumentoRelacionado description: Documentos relacionados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/excluirTitulo: post: description: API responsável pela exclusão de títulos a pagar no ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do título responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/confirmarTituloExcluido: post: description: API responsável pela confirmação da exclusão de títulos a pagar no ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do título responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/signals/gravarLogIntegracaoErp: post: description: API responsável pelo registro de ocorrências do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idIntegracao – situacao properties: idIntegracao: type: string description: Identificador único situacao: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Situação da integração mensagem: type: string description: Mensagem de retorno documentosRelacionadosInvalidos: type: array items: type: object allOf: – #/definitions/recTituloDocumentoRelacionado description: Documentos relacionados não encontrados responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /integrador/events/notaFiscalRecebida: post: description: Evento responsável por notificar o recebimento da nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – notaFiscal properties: notaFiscal: type: object allOf: – #/definitions/recNotaFiscal description: Nota fiscal recebida responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integrador/events/importParametroIntegracaoEvent: post: description: 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 /integrador/events/exportParametroIntegracaoEvent: post: description: 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 /integrador/events/importEventoDocumentoEvent: post: description: 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 /integrador/events/exportEventoDocumentoEvent: post: description: 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 /integrador/events/importLogEventoDocumentoEvent: post: description: 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 /integrador/events/exportLogEventoDocumentoEvent: post: description: 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 /integrador/events/importEventoDocumentoItemEvent: post: description: 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 /integrador/events/exportEventoDocumentoItemEvent: post: description: 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 /integrador/entities/parametroIntegracao: 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/parametroIntegracao responses: 200: description: The created resource schema: #/definitions/parametroIntegracao 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/parametroIntegracao responses: 200: description: The created resource schema: #/definitions/parametroIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/parametroIntegracao 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/parametroIntegracao/{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/editParametroIntegracao responses: 200: description: Ok schema: #/definitions/editParametroIntegracao 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/parametroIntegracao responses: 200: description: Ok schema: #/definitions/parametroIntegracao 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/parametroIntegracao 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 /integrador/entities/parametroIntegracao/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/parametroIntegracao responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/eventoDocumento: 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/eventoDocumento responses: 200: description: The created resource schema: #/definitions/eventoDocumento 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/eventoDocumento responses: 200: description: The created resource schema: #/definitions/eventoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/eventoDocumento/{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/editEventoDocumento responses: 200: description: Ok schema: #/definitions/editEventoDocumento 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/eventoDocumento responses: 200: description: Ok schema: #/definitions/eventoDocumento 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/eventoDocumento 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 /integrador/entities/eventoDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventoDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/logEventoDocumento: 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/logEventoDocumento responses: 200: description: The created resource schema: #/definitions/logEventoDocumento 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/logEventoDocumento responses: 200: description: The created resource schema: #/definitions/logEventoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/logEventoDocumento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/logEventoDocumento/{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/editLogEventoDocumento responses: 200: description: Ok schema: #/definitions/editLogEventoDocumento 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/logEventoDocumento responses: 200: description: Ok schema: #/definitions/logEventoDocumento 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/logEventoDocumento 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 /integrador/entities/logEventoDocumento/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/logEventoDocumento responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/eventoDocumentoItem: 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/eventoDocumentoItem responses: 200: description: The created resource schema: #/definitions/eventoDocumentoItem 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/eventoDocumentoItem responses: 200: description: The created resource schema: #/definitions/eventoDocumentoItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/eventoDocumentoItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integrador/entities/eventoDocumentoItem/{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/editEventoDocumentoItem responses: 200: description: Ok schema: #/definitions/editEventoDocumentoItem 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/eventoDocumentoItem responses: 200: description: Ok schema: #/definitions/eventoDocumentoItem 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/eventoDocumentoItem 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 /integrador/entities/eventoDocumentoItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventoDocumentoItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumTipoNota: type: string enum: – ENTRADA – SAIDA description: Define o tipo de nota: * `ENTRADA` – Entrada * `SAIDA` – Saída enumTipoFrete: type: string enum: – CIF – FOB – SEM_FRETE description: Define o tipo de frete: * `CIF` – CIF * `FOB` – FOB * `SEM_FRETE` – Sem frete enumTipoParticipante: type: string enum: – NENHUM – FISICA – JURIDICA description: Define o tipo de participante: * `NENHUM` – Nenhum * `FISICA` – Física * `JURIDICA` – Jurídica enumTipoItem: type: string enum: – PRODUTO – SERVICO description: Define o tipo de item: * `PRODUTO` – Produto * `SERVICO` – Serviço enumTipoDocumento: type: string enum: – FATURA – PREVISAO – NOTA_FISCAL_SAIDA – NOTA_FISCAL_ENTRADA description: Define o tipo de documento: * `FATURA` – Fatura * `PREVISAO` – Previsão * `NOTA_FISCAL_SAIDA` – Nota fiscal de saída * `NOTA_FISCAL_ENTRADA` – Nota fiscal de entrada enumSistemaOrigem: type: string enum: – GKO – ERP description: Define o tipo de origem: * `GKO` – GKO * `ERP` – ERP enumSituacaoIntegracao: type: string enum: – CONCLUIDO – ERRO – EXPORTADO – NAO_INTEGRADO – REENVIADO – AGUARDANDO_EXPORTACAO – EXCLUIDO – AGUARDANDO_CONFIRMACAO description: Define a situação da integração: * `CONCLUIDO` – Concluído * `ERRO` – Erro * `EXPORTADO` – Exportado * `NAO_INTEGRADO` – Não integrado * `REENVIADO` – Reenviado * `AGUARDANDO_EXPORTACAO` – Aguardando exportação * `EXCLUIDO` – Excluído * `AGUARDANDO_CONFIRMACAO` – Aguardando confirmação enumTipoDocumentoValidacao: type: string enum: – NOTA_SERVICO – CONHECIMENTO_TRANSPORTE description: Define o tipo de documento para validação: * `NOTA_SERVICO` – Nota de serviço * `CONHECIMENTO_TRANSPORTE` – Conhecimento de transporte enumSituacaoValidacao: type: string enum: – PENDENTE – ENCONTRADO – NAO_VALIDADO – NAO_ENCONTRADO description: Define a situação da validação: * `PENDENTE` – Pendente * `ENCONTRADO` – Encontrado * `NAO_VALIDADO` – Não validado * `NAO_ENCONTRADO` – Não encontrado enumSortType: type: string enum: – ASC – DESC description: Define o tipo de ordenação: * `ASC` – Crescente * `DESC` – Decrescente userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recNotaFiscal: description: Dados da nota fiscal type: object properties: id: type: string description: Identificador empresa: type: object allOf: – #/definitions/recEmpresa description: Empresa filial: type: object allOf: – #/definitions/recFilial description: Filial tipo: type: string allOf: – #/definitions/enumTipoNota description: Tipo serie: type: string description: Série numero: type: integer format: int64 description: Número dataRegistro: type: string format: date description: Data de registro dataEmissao: type: string format: date description: Data de emissão dataEmbarque: type: string format: date description: Data de embarque transacaoProduto: type: object allOf: – #/definitions/recTransacao description: Transação para produtos transacaoServico: type: object allOf: – #/definitions/recTransacao description: Transação para serviços tipoFrete: type: string allOf: – #/definitions/enumTipoFrete description: Tipo de frete pesoBruto: type: number format: double description: Peso bruto pesoLiquido: type: number format: double description: Peso líquido pesoCubado: type: number format: double description: Peso cubado volumeCubado: type: number format: double description: Volume cubado valorLiquido: type: number format: double description: Valor líquido valorFinanceiro: type: number format: double description: Valor financeiro quantidadeEmbalagens: type: integer format: int64 description: Quantidade de embalagens viaTransporte: type: string description: Via de transporte veiculo: type: object allOf: – #/definitions/recVeiculo description: Veículo motorista: type: object allOf: – #/definitions/recParticipante description: Motorista meioTransporte: type: string description: Meio de transporte numeroRomaneio: type: string description: Número do romaneio representante: type: object allOf: – #/definitions/recParticipante description: Representante documentosVinculados: type: array items: type: string description: Documentos vinculados emitente: type: object allOf: – #/definitions/recParticipante description: Emitente destinatario: type: object allOf: – #/definitions/recParticipante description: Destinatário transportadora: type: object allOf: – #/definitions/recParticipante description: Transportadora transportadoraRedespacho: type: object allOf: – #/definitions/recParticipante description: Transportadora de redespacho rota: type: object allOf: – #/definitions/recRota description: Rota subRota: type: object allOf: – #/definitions/recRota description: Sub-rota embalagens: type: array items: type: object allOf: – #/definitions/recEmbalagem description: Embalagens itens: type: array items: type: object allOf: – #/definitions/recNotaFiscalItem description: Itens informacoesEletronicas: type: object allOf: – #/definitions/recNotaFiscalEletronico description: Informações eletrônicas informacoesAdicionais: type: object allOf: – #/definitions/recNotaFiscalAdicional description: Informações adicionais do frete recEmpresa: description: Dados da empresa type: object properties: codigo: type: integer format: int64 description: Codigo nome: type: string description: Nome fantasia: type: string description: Fantasia recFilial: description: Dados da filial type: object properties: codigo: type: integer format: int64 description: Código cnpj: type: string description: CNPJ nome: type: string description: Nome fantasia: type: string description: Fantasia recTransacao: description: Dados da transação type: object properties: codigo: type: string description: Código descricao: type: string description: Descrição cfop: type: string description: Código fiscal de operações recRota: description: Dados da rota type: object properties: codigo: type: string description: Código descricao: type: string description: Descrição recVeiculo: description: Dados do veículo type: object properties: placa: type: string description: Placa tipo: type: integer format: int64 description: Tipo descricao: type: string description: Descrição recEmbalagem: description: Dados da embalagem type: object properties: codigo: type: integer format: int64 description: Código descricao: type: string description: Descrição abreviatura: type: string description: Abreviatura largura: type: number format: double description: Largura comprimento: type: number format: double description: Comprimento altura: type: number format: double description: Altura peso: type: number format: double description: Peso profundidade: type: number format: double description: Profundidade recParticipante: description: Dados do participante type: object properties: codigo: type: integer format: int64 description: Código nome: type: string description: Nome fantasia: type: string description: Fantasia tipo: type: string allOf: – #/definitions/enumTipoParticipante description: Tipo cnpjCpf: type: string description: CNPJ/CPF contribuinteIcms: type: string description: Contribuinte ICMS inscricaoEstadual: type: string description: Inscrição estadual inscricaoMunicipal: type: string description: Inscrição municipal endereco: type: object allOf: – #/definitions/recParticipanteEndereco description: Endereço enderecoEntrega: type: object allOf: – #/definitions/recParticipanteEndereco description: Endereço de entrega email: type: string description: E-mail informacoesAdicionais: type: object allOf: – #/definitions/recParticipanteAdicional description: Informações adicionais recParticipanteEndereco: description: Dados de endereço do participante type: object properties: cep: type: integer format: int64 description: Código postal logradouro: type: string description: Logradouro numero: type: string description: Número complemento: type: string description: Complemento bairro: type: string description: Bairro cidade: type: string description: Cidade codigoCidade: type: integer format: int64 description: Código da cidade estado: type: string description: Estado recParticipanteAdicional: description: Dados adicionais do participante type: object properties: avisoCobranca: type: string description: Aviso de cobrança avisoAtrasoEntrega: type: string description: Aviso de atraso da entrega avisoConfirmacaoEntrega: type: string description: Aviso de confirmação da entrega recNotaFiscalItem: description: Dados do item da nota fiscal type: object properties: tipo: type: string allOf: – #/definitions/enumTipoItem description: Tipo sequencia: type: integer format: int64 description: Sequência codigo: type: string description: Código descricao: type: string description: Descrição derivacao: type: string description: Derivação cfop: type: string description: Código fiscal de operações deposito: type: string description: Depósito quantidade: type: number format: double description: Quantidade quantidadeVenda: type: number format: double description: Quantidade na unidade de medida de venda quantidadeEstoque: type: number format: double description: Quantidade na unidade de medida de estoque precoUnitario: type: number format: double description: Preço unitário precoUnitarioBruto: type: number format: double description: Preço unitário bruto pesoBruto: type: number format: double description: Peso bruto pesoLiquido: type: number format: double description: Peso líquido pesoCubado: type: number format: double description: Peso cubado volumeCubado: type: number format: double description: Volume cubado valorBruto: type: number format: double description: Valor bruto valorLiquido: type: number format: double description: Valor líquido valorFinanceiro: type: number format: double description: Valor financeiro quantidadeEmbalagens: type: integer format: int64 description: Quantidade de embalagens classificacaoFiscal: type: string description: Classificação fiscal unidadeMedida: type: string description: Unidade de medida unidadeMedidaFiscal: type: string description: Unidade de medida tributável unidadeMedidaVenda: type: string description: Unidade de medida de venda unidadeMedidaEstoque: type: string description: Unidade de medida de estoque codigoBarras: type: string description: Código de barras codigoGtin: type: string description: Código GTIN classificacaoCategoria: type: string description: Classificação da categoria embalagens: type: array items: type: object allOf: – #/definitions/recEmbalagem description: Embalagens recNotaFiscalEletronico: description: Dados eletrônicos da nota fiscal type: object properties: chaveEletronica: type: string description: Chave eletrônica autorizacao: type: object allOf: – #/definitions/recNotaFiscalEletronicoAutorizacao description: Dados de autorização cancelamento: type: object allOf: – #/definitions/recNotaFiscalEletronicoCancelamento description: Dados de cancelamento recNotaFiscalEletronicoAutorizacao: description: Dados de autorização type: object properties: dataAutorizacao: type: string format: date description: Data de autorização protocoloAutorizacao: type: string description: Protocolo de autorização recNotaFiscalEletronicoCancelamento: description: Dados de canelamento type: object properties: dataCancelamento: type: string format: date description: Data de cancelamento protocoloCancelamento: type: string description: Protocolo de cancelamento recNotaFiscalAdicional: description: Dados adicionais da nota fiscal type: object properties: tipoNota: type: string description: Tipo de nota tipoCarga: type: string description: Tipo de carga territorio: type: string description: Territorio freteDiferenciado: type: string description: Frete diferenciado responsavelPagamento: type: string description: Responsável pelo pagamento do frete fatorConversaoPeso: type: integer format: int64 description: Fator de conversão do peso recTituloDetalhe: description: Detalhes do título type: object required: – parcelas properties: idDocumento: type: string description: Identificador do documento numeroDocumento: type: string description: Número do documento parcelas: type: array items: type: object allOf: – #/definitions/recTituloDetalheParcela minimum: 1 description: Lista de parcelas recTituloDetalheParcela: description: Dados da parcela type: object required: – sequencia – dataEmissao – dataEntrada – dataVencimento – valorOriginal properties: sequencia: type: integer format: int64 description: Sequência do título dataEmissao: type: string format: date description: Data de emissão dataEntrada: type: string format: date description: Data de entrada dataVencimento: type: string format: date description: Data de vencimento valorOriginal: type: string description: Valor original dataDesconto: type: string format: date description: Data de vencimento valorDesconto: type: string description: Valor do desconto numero: type: string description: Número do título transacao: type: string description: Transação o título tipoTitulo: type: string description: Tipo de título recTituloDocumentoRelacionado: description: Dados dos documentos relacionados type: object required: – tipo – sequencia properties: tipo: type: string allOf: – #/definitions/enumTipoDocumentoValidacao description: Tipo de documento para validação sequencia: type: integer format: int64 description: Sequência do documento chaveEletronica: type: string description: Chave eletrônica do documento recPaginacao: description: Dados dos parâmetros de paginação type: object properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de registros da página orderBy: type: array items: type: object allOf: – #/definitions/recOrdenacao description: Campos da ordenação dos registros recOrdenacao: description: Dados dos campos para ordenação type: object properties: field: type: string description: Nome do campo a ser ordenado sortType: type: string allOf: – #/definitions/enumSortType description: Tipo de ordenação do campo recEventoDocumentoFiltro: description: Dados dos filtros para consulta dos eventos type: object properties: dataInicial: type: string format: date-time description: Data de geração inicial dataFinal: type: string format: date-time description: Data de geração final tipoDocumento: type: array items: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo de documento situacaoErp: type: array items: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Status do evento ERP situacaoGko: type: array items: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Status do evento GKO numeroDocumento: type: string description: Número do documento idExterno: type: string description: Identificador externo recEventoDocumentoOutput: description: Dados do evento type: object required: – id – tipoDocumento – numeroDocumento – situacaoErp – situacaoGko – dataGeracao – dataAtualizacao properties: id: type: string description: Identificador único tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo do documento numeroDocumento: type: string description: Número do documento situacaoErp: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Status do evento situacaoGko: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Status do evento dataGeracao: type: string format: date-time description: Data de geração dataAtualizacao: type: string format: date-time description: Data de atualização recLogEventoDocumentoOutput: description: Dados das ocorrências vinculadas ao evento type: object required: – id – situacao – origem – dataHoraGeracao – mensagem properties: id: type: string description: Identificador único situacao: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Situação do registro origem: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem da ocorrência dataHoraGeracao: type: string format: date-time description: Data da ocorrência mensagem: type: string description: Mensagem da ocorrência recEventoDocumentoItemOutput: description: Dados dos documentos relacionados vinculados ao evento type: object required: – id – tipoDocumentoValidacao – sequencia – chaveEletronica – situacaoValidacao – eventoId properties: id: type: string description: Identificador único tipoDocumentoValidacao: type: string allOf: – #/definitions/enumTipoDocumentoValidacao description: Tipo de documento para validação sequencia: type: integer format: int64 description: Sequência do item chaveEletronica: type: string maxLength: 100 description: Chave eletrônica do documento situacaoValidacao: type: string allOf: – #/definitions/enumSituacaoValidacao description: Situação da validação do documento eventoId: type: string description: Identificador do evento recEventoDocumentoPayloadOutput: description: Dados do payload vinculado ao evento type: object required: – jsonOriginal – jsonConvertido properties: jsonOriginal: type: string description: JSON original jsonConvertido: type: string description: JSON convertido parametroIntegracao: description: Entidade dos parâmetros de integração type: object required: – id – cnpjFilial – usuario – senha – database – url – tipoFreteEntrada – tipoFreteSaida properties: id: type: string format: uuid description: Identificador único cnpjFilial: type: string description: CNPJ da filial usuario: type: string description: Usuário senha: type: string description: Senha database: type: string description: Database url: type: string description: URL apiKey: type: string description: API key versaoErp: type: string description: Versão do ERP versaoGko: type: string description: Versão do GKO tipoFreteEntrada: type: string description: Tipo frete entrada tipoFreteSaida: type: string description: Tipo frete saída codigoEmpresa: type: integer format: int64 description: Código da empresa nomeEmpresa: type: string maxLength: 100 description: Nome da empresa codigoFilial: type: integer format: int64 description: Código da filial nomeFilial: type: string maxLength: 100 description: Nome da filial tipoPrevisao: type: string maxLength: 3 description: Tipo previsão transacaoPrevisao: type: string maxLength: 5 description: Transação para previstos tipoEfetivo: type: string maxLength: 3 description: Tipo para efetivos transacaoEfetivo: type: string maxLength: 5 description: Transação para efetivos exigeCte: type: string maxLength: 1 description: Exige conhecimento de transporte dataAutenticacao: type: string format: date-time description: Data de autenticação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editParametroIntegracao: type: object required: – id allOf: – #/definitions/parametroIntegracao eventoDocumento: description: Entidade do evento type: object required: – id – cnpjFilial – numeroDocumento – situacaoErp – situacaoGko – tipoDocumento – jsonOriginal – mensagem – eventoId properties: id: type: string format: uuid description: Identificador único cnpjFilial: type: string description: CNPJ da filial numeroDocumento: type: string description: Número do documento situacaoErp: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Situação do registro no ERP situacaoGko: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Situação do registro no GKO tipoDocumento: type: string allOf: – #/definitions/enumTipoDocumento description: Tipo de documento jsonOriginal: type: string description: JSON original jsonConvertido: type: string description: JSON convertido mensagem: type: string description: Mensagem da última ocorrência eventoId: type: string description: Identificador do documento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventoDocumento: type: object required: – id allOf: – #/definitions/eventoDocumento logEventoDocumento: description: Entidade das ocorrências do evento type: object required: – id – situacao – origem – mensagem – eventoId properties: id: type: string format: uuid description: Identificador único situacao: type: string allOf: – #/definitions/enumSituacaoIntegracao description: Situação do registro origem: type: string allOf: – #/definitions/enumSistemaOrigem description: Origem da ocorrência mensagem: type: string description: Mensagem da ocorrência eventoId: type: string format: uuid description: Identificador do evento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editLogEventoDocumento: type: object required: – id allOf: – #/definitions/logEventoDocumento eventoDocumentoItem: description: Entidade dos itens do evento type: object required: – id properties: id: type: string format: uuid description: Identificador único tipoDocumentoValidacao: type: string allOf: – #/definitions/enumTipoDocumentoValidacao description: Tipo de documento para validação sequencia: type: integer format: int64 description: Sequência do documento chaveEletronica: type: string maxLength: 100 description: Chave eletrônica do documento situacaoValidacao: type: string allOf: – #/definitions/enumSituacaoValidacao description: Situação da validação do documento evento: type: object allOf: – #/definitions/eventoDocumento description: Identificador do evento usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editEventoDocumentoItem: type: object required: – id allOf: – #/definitions/eventoDocumentoItem notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage