2.0info: 2.1.0 database description: Serviço responsável pelo database do rateio do ERP X x-senior-domain: Domínio rateio x-senior-domain-path: erpx_fin_rat x-senior-service-path: database 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_fin_ratsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /database/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 /database/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 /database/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 /database/queries/exportE085pes: 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 /database/queries/exportE095pes: 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 /database/queries/exportE001tns: 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 /database/queries/exportE002tpt: 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 /database/queries/exportE012fam: 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 /database/queries/exportE012famFinRat: 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 /database/queries/exportE600cco: 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 /database/queries/exportE600ccoFinRat: 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 /database/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 /database/queries/exportE070empCplCtb: 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 /database/queries/exportE070empFinRat: 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 /database/queries/exportE043mmp: 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 /database/queries/exportE043pcm: 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 /database/queries/exportE043mpc: 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 /database/queries/exportE044ccu: 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 /database/queries/exportE045pca: 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 /database/queries/exportE045pla: 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 /database/queries/exportE091plf: 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 /database/queries/exportTipoFinanceiro: 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 /database/queries/exportGrupoCentroCusto: 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 /database/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 /database/queries/exportE070filCplCtb: 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 /database/queries/exportE023crp: 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 /database/queries/exportE089doc: 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 /database/queries/exportE089docFinRat: 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 /database/queries/exportE039por: 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 /database/queries/exportE039porFinRat: 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 /database/queries/exportE075der: 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 /database/queries/exportE075derFinRat: 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 /database/queries/exportE080ser: 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 /database/queries/exportE080serFinRat: 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 /database/queries/exportE205dep: 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 /database/queries/exportE205depFinRat: 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 /database/queries/exportE030age: 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 /database/queries/exportE030ban: 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 /database/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 /database/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 /database/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 /database/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 /database/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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/actions/resetAccountsPlanModel: post: description: Realiza o reset dos planos de conta 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 /database/actions/resetAccountsPlanModelControladoria: post: description: Realiza o reset do plano contábil das empresas 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 /database/actions/migrateSchemaReport: post: description: Executa a migração de base para o serviço no tenant repassado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenantName properties: tenantName: type: string description: Nome do tenant que deverá ter a base migrada responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: Retorno de sucesso ou falha para a migração da base 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/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 /database/actions/importE085pes: 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 /database/actions/importE095pes: 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 /database/actions/importE001tns: 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 /database/actions/importE002tpt: 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 /database/actions/importE012fam: 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 /database/actions/importE012famFinRat: 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 /database/actions/importE600cco: 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 /database/actions/importE600ccoFinRat: 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 /database/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 /database/actions/importE070empCplCtb: 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 /database/actions/importE070empFinRat: 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 /database/actions/importE043mmp: 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 /database/actions/importE043pcm: 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 /database/actions/importE043mpc: 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 /database/actions/importE044ccu: 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 /database/actions/importE045pca: 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 /database/actions/importE045pla: 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 /database/actions/importE091plf: 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 /database/actions/importTipoFinanceiro: 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 /database/actions/importGrupoCentroCusto: 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 /database/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 /database/actions/importE070filCplCtb: 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 /database/actions/importE023crp: 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 /database/actions/importE089doc: 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 /database/actions/importE089docFinRat: 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 /database/actions/importE039por: 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 /database/actions/importE039porFinRat: 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 /database/actions/importE075der: 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 /database/actions/importE075derFinRat: 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 /database/actions/importE080ser: 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 /database/actions/importE080serFinRat: 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 /database/actions/importE205dep: 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 /database/actions/importE205depFinRat: 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 /database/actions/importE030age: 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 /database/actions/importE030ban: 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 /database/signals/integracaoModeloPlanoAuxiliar: post: description: Cópia das contas do modelo auxiliar – e043pcm – para a entidade e045pca tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – e043mpcId – e070empId properties: e043mpcId: type: string description: Id modelo de plano auxiliar e070empId: type: string description: Id da empresa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /database/signals/integracaoModeloPlanoContabil: post: description: Cópia das contas do modelo contábil – e043pcm – para a entidade e045pla tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – e043mpcId – e070empId properties: e043mpcId: type: string description: Id modelo de plano contábil e070empId: type: string description: Id da empresa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /database/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 /database/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 /database/events/importE085pesEvent: post: description: 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 /database/events/exportE085pesEvent: post: description: 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 /database/events/importE095pesEvent: post: description: 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 /database/events/exportE095pesEvent: post: description: 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 /database/events/importE001tnsEvent: post: description: 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 /database/events/exportE001tnsEvent: post: description: 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 /database/events/importE002tptEvent: post: description: 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 /database/events/exportE002tptEvent: post: description: 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 /database/events/importE012famEvent: post: description: 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 /database/events/exportE012famEvent: post: description: 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 /database/events/importE012famFinRatEvent: post: description: 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 /database/events/exportE012famFinRatEvent: post: description: 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 /database/events/importE600ccoEvent: post: description: 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 /database/events/exportE600ccoEvent: post: description: 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 /database/events/importE600ccoFinRatEvent: post: description: 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 /database/events/exportE600ccoFinRatEvent: post: description: 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 /database/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 /database/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 /database/events/importE070empCplCtbEvent: post: description: 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 /database/events/exportE070empCplCtbEvent: post: description: 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 /database/events/importE070empFinRatEvent: post: description: 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 /database/events/exportE070empFinRatEvent: post: description: 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 /database/events/importE043mmpEvent: post: description: 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 /database/events/exportE043mmpEvent: post: description: 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 /database/events/importE043pcmEvent: post: description: 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 /database/events/exportE043pcmEvent: post: description: 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 /database/events/importE043mpcEvent: post: description: 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 /database/events/exportE043mpcEvent: post: description: 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 /database/events/importE044ccuEvent: post: description: 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 /database/events/exportE044ccuEvent: post: description: 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 /database/events/importE045pcaEvent: post: description: 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 /database/events/exportE045pcaEvent: post: description: 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 /database/events/importE045plaEvent: post: description: 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 /database/events/exportE045plaEvent: post: description: 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 /database/events/importE091plfEvent: post: description: 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 /database/events/exportE091plfEvent: post: description: 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 /database/events/importTipoFinanceiroEvent: post: description: 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 /database/events/exportTipoFinanceiroEvent: post: description: 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 /database/events/importGrupoCentroCustoEvent: post: description: 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 /database/events/exportGrupoCentroCustoEvent: post: description: 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 /database/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 /database/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 /database/events/importE070filCplCtbEvent: post: description: 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 /database/events/exportE070filCplCtbEvent: post: description: 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 /database/events/importE023crpEvent: post: description: 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 /database/events/exportE023crpEvent: post: description: 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 /database/events/importE089docEvent: post: description: 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 /database/events/exportE089docEvent: post: description: 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 /database/events/importE089docFinRatEvent: post: description: 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 /database/events/exportE089docFinRatEvent: post: description: 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 /database/events/importE039porEvent: post: description: 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 /database/events/exportE039porEvent: post: description: 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 /database/events/importE039porFinRatEvent: post: description: 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 /database/events/exportE039porFinRatEvent: post: description: 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 /database/events/importE075derEvent: post: description: 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 /database/events/exportE075derEvent: post: description: 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 /database/events/importE075derFinRatEvent: post: description: 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 /database/events/exportE075derFinRatEvent: post: description: 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 /database/events/importE080serEvent: post: description: 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 /database/events/exportE080serEvent: post: description: 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 /database/events/importE080serFinRatEvent: post: description: 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 /database/events/exportE080serFinRatEvent: post: description: 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 /database/events/importE205depEvent: post: description: 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 /database/events/exportE205depEvent: post: description: 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 /database/events/importE205depFinRatEvent: post: description: 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 /database/events/exportE205depFinRatEvent: post: description: 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 /database/events/importE030ageEvent: post: description: 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 /database/events/exportE030ageEvent: post: description: 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 /database/events/importE030banEvent: post: description: 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 /database/events/exportE030banEvent: post: description: 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 /database/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: 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/e001pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/entities/e085pes: 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/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e085pes/{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/e085pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e095pes: 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/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e095pes/{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/e095pes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e001tns: 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/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e001tns/{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/e001tns 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e002tpt: 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/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e002tpt/{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/e002tpt 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e012fam: 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/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e012fam/{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/e012fam 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e600cco: 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/e600cco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e600cco/{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/e600cco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/entities/e070empCplCtb: 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/e070empCplCtb 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070empCplCtb/{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/e070empCplCtb 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/grupoCentroCusto: 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/grupoCentroCusto responses: 200: description: The created resource schema: #/definitions/grupoCentroCusto 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/grupoCentroCusto responses: 200: description: The created resource schema: #/definitions/grupoCentroCusto 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/grupoCentroCusto 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/grupoCentroCusto/{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/editGrupoCentroCusto responses: 200: description: Ok schema: #/definitions/editGrupoCentroCusto 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/grupoCentroCusto responses: 200: description: Ok schema: #/definitions/grupoCentroCusto 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/grupoCentroCusto 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 /database/entities/grupoCentroCusto/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/grupoCentroCusto responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070fil: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/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 /database/entities/e070filCplCtb: 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/e070filCplCtb 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070filCplCtb/{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/e070filCplCtb 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e023crp: 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/e023crp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e023crp/{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/e023crp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e089doc: 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/e089doc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e089doc/{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/e089doc 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e039por: 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/e039por 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e039por/{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/e039por 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e075der: 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/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e075der/{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/e075der 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e205dep: 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/e205dep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e205dep/{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/e205dep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e030age: 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/e030age 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e030age/{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/e030age 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e030ban: 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/e030ban 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e030ban/{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/e030ban 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down environmentStepStatus: type: string enum: – IN_PROGRESS – DONE – ERROR description: Status do step de duplicação de empresas e filiais: * `IN_PROGRESS` – Em andamento * `DONE` – Finalizado * `ERROR` – Erro enumJurFis: type: string enum: – VJ – VF description: Tipo de pessoa: * `VJ` – Pessoa Jurídica * `VF` – Pessoa Física enumAplGrp: type: string enum: – VA – VR – VP description: Aplicação Grupo: * `VA` – Ambos * `VR` – Contas a Receber * `VP` – Contas a Pagar enumUniCre: type: string enum: – VD – VH – VM – VS description: Unidade de Tempo: * `VD` – Dias * `VH` – Horas * `VM` – Minutos * `VS` – Segundos enumAnaSin: type: string enum: – VA – VS description: Nome da lista na G5: LAnaSin: * `VA` – Analítico(a) * `VS` – Sintético(a) enumGruCta: type: string enum: – VA – VP – VD – VR – VX – VM – VN – VU – VL – VV – VC – VS – VE – VO – VT description: Nome da lista na G5: LGruCta: * `VA` – Ativo (Contábil – Devedora) * `VP` – Passivo (Contábil – Credora) * `VD` – Despesas (Contábil – Devedora) * `VR` – Receitas (Contábil – Credora) * `VX` – Ambas (Contábil – Desp./Rec.) * `VM` – Receitas Financeiras * `VN` – Despesas Financeiras * `VU` – Conta Auxiliar * `VL` – Patrimônio Líquido * `VV` – Custo de Venda * `VC` – Custo de Produção * `VS` – Custo de Ordem Dedutora * `VE` – Custo de Ordem Credora * `VO` – Outros * `VT` – Contas de Compensação enumForRat: type: string enum: – V0 – V1 – V2 – V3 description: Forma de rateio: * `V0` – Sem Rateio * `V1` – Pré-definido c/ Confirmação * `V2` – Pré-definido s/ Confirmação * `V3` – Rateio Manual enumNatCtb: type: string enum: – VD – VC – VA description: Natureza: * `VD` – Devedora * `VC` – Credora * `VA` – Ambas enumClaDes: type: string enum: – VA – VG description: Classificação de despesa: * `VA` – Depreciação do mês apropriado em custos * `VG` – Depreciação no mês acumulado despesas enumTipCfc: type: string enum: – V1 – V2 – V3 description: Tipo de conta financeira: * `V1` – Receitas * `V2` – Despesas * `V3` – Outros enumTipCtc: type: string enum: – V1 – V2 – V3 – V4 – V5 description: Tipo de centro de custo: * `V1` – Produtivo/Operacional Indireto * `V2` – Produtivo/Operacional Direto * `V3` – Administrativo * `V4` – Comercial * `V5` – Financeiro enumMetCon: type: string enum: – V1 – V2 description: Método de conversão: * `V1` – Monetário * `V2` – Não monetário enumLisMod: type: string enum: – VVEP – VVEF – VVES – VESN – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT description: Módulo da transação: * `VVEP` – VEP – Vendas – Pedidos Normais * `VVEF` – VEF – Vendas – NF Saída Produtos * `VVES` – VES – Vendas – NF Saída Serviços * `VESN` – ESN – Estoques – Normais * `VCRE` – CRE – Contas Receber – Entrada de Títulos * `VCRP` – CRP – Contas Receber – Entrada de Previsões * `VCRB` – CRB – Contas Receber – Baixa de Títulos * `VCOO` – COO – Compras – Manutenção de Ordem de Compra * `VCOF` – COF – Compras – NF Entrada Produtos * `VCOS` – COS – Compras – NF Entrada Serviços * `VCPE` – CPE – Contas Pagar – Entrada de Títulos * `VCPP` – CPP – Contas Pagar – Entrada de Previsões * `VCPB` – CPB – Contas Pagar – Baixa de Títulos * `VCPM` – CPM – Contas Pagar – Comissões * `VCBC` – CBC – Tesouraria – Cadastro Contas – Saldos * `VCBM` – CBM – Tesouraria – Movimentos * `VPAT` – PAT – Patrimônio enumCriRat: type: string enum: – V1 – V2 – V3 – V4 – V5 description: Critério de rateio: * `V1` – Receitas – Conta X C. Custos * `V2` – Receitas – C. Custos X Conta * `V3` – Despesas – Conta X C. Custos * `V4` – Despesas – C. Custos X Conta * `V5` – Nenhum enumSitReg: type: string enum: – VA – VI description: Situacoes: * `VA` – Ativo * `VI` – Inativo enumTipEmc: type: string enum: – V1 – V2 description: Tipo do direito de propriedade do cliente: * `V1` – Privada * `V2` – Pública enumTipAce: type: string enum: – V1 – V2 description: Tipo de acerto: * `V1` – Arredonda * `V2` – Trunca enumIndFor: type: string enum: – VM – VP – VA description: Tipo do fornecedor: * `VM` – Matéria prima * `VP` – Prestador de serviços * `VA` – Ambos enumTipPla: type: string enum: – V1 – V2 – V3 – V4 – V5 description: Tipo do modelo de plano: * `V1` – Contábil * `V2` – Financeiro * `V3` – Centro de custos * `V4` – Composição auxiliar * `V5` – Referencial enumCodRef: type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 description: Código Referencial: * `V1` – PJ em Geral – Lucro Real * `V2` – PJ em Geral – Lucro Presumido * `V3` – Financeiras – Lucro Real * `V4` – Seguradoras – Lucro Real * `V5` – Imunes e Isentas em Geral * `V6` – Imunes e Isentas – Financeiras * `V7` – Imunes e Isentas – Seguradoras * `V8` – Entidades Fechadas de Previdência Complementar * `V9` – Partidos Políticos * `V10` – Financeiras – Lucro Presumido enumPerApuRes: type: string enum: – SEM_APURACAO – TRIMESTRAL – ANUAL description: Enumerador com o indicativo de periodicidade da apuração de resultados para a filial: * `SEM_APURACAO` – Sem apuração de resultados * `TRIMESTRAL` – Periodicidade trimestral * `ANUAL` – Periodicidade anual replicacaoModeloStatus: type: string enum: – PENDENTE – PROCESSANDO – FINALIZADO – ERRO description: Situação da integração: * `PENDENTE` – Pendente * `PROCESSANDO` – Em processamento * `FINALIZADO` – Finalizado * `ERRO` – Erro 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 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 tipPes: type: string allOf: – #/definitions/enumJurFis description: Tipo de pessoa sitPes: type: string allOf: – #/definitions/enumSitReg description: Situação extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e085pes: description: Cliente type: object required: – sitCli properties: id: type: string format: uuid description: Id da entidade sitCli: type: string allOf: – #/definitions/enumSitReg description: Situação do cliente obsMot: type: string maxLength: 250 description: Observação do motivo da situação do cliente dthMot: type: string format: date-time description: Data do motivo da situação do cliente usuMot: type: string maxLength: 250 description: Usuário responsável pelo motivo da situação do cliente tipEmc: type: string allOf: – #/definitions/enumTipEmc description: Tipo do direito de propriedade da empresa marCli: type: string maxLength: 20 description: Marca do cliente tipAce: type: string allOf: – #/definitions/enumTipAce description: Tipo de acerto (arredondamento) do cliente extIntSts: type: string maxLength: 100 description: Indica status da replicação extIntMsg: type: string maxLength: 100 description: Indica a mensagem da replicação excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e095pes: description: Fornecedor type: object required: – sitFor properties: id: type: string format: uuid description: Id da entidade marFor: type: string maxLength: 20 description: Marca tipEmc: type: string allOf: – #/definitions/enumTipEmc description: Tipo do direito de propriedade da empresa endNet: type: string maxLength: 200 description: Site arrAbn: type: boolean description: Utilizar a regra de arredondamento da ABNT indFor: type: string allOf: – #/definitions/enumIndFor description: Tipo do fornecedor sitFor: type: string allOf: – #/definitions/enumSitReg description: Situação do fornecedor obsMot: type: string maxLength: 250 description: Observação do motivo da situação do fornecedor dthMot: type: string format: date description: Data do motivo da situação do fornecedor usuMot: type: string maxLength: 250 description: Usuário responsável pelo motivo da situação do fornecedor 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: e001tns: description: Tabelas – Transações type: object required: – codTns – desTns – lisMod – detTns – aceMan properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codTns: type: string maxLength: 5 description: Transação desTns: type: string maxLength: 60 description: Descrição lisMod: type: string allOf: – #/definitions/enumLisMod description: Módulo detTns: type: string maxLength: 599 description: Detalhes Transação aceMan: type: boolean description: Aceita Manual sitTns: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e002tpt: description: Tipos de título type: object properties: id: type: string format: uuid description: Id da entidade codTpt: type: string maxLength: 3 description: Codigo interno do tipo de título desTpt: type: string maxLength: 40 description: Descrição do tipo de título abrTpt: type: string maxLength: 5 description: Abreviatura do tipo de título aplTpt: type: string allOf: – #/definitions/enumAplGrp description: Aplicação do tipo de título sitTpt: type: string allOf: – #/definitions/enumSitReg description: Indicativo da situação do tipo de título extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e012fam: description: Cadastros – Famílias type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa codFam: type: string maxLength: 6 description: Código da família de produto desFam: type: string maxLength: 50 description: Descrição da família de produto sitFam: type: string allOf: – #/definitions/enumSitReg description: Situação excluido: type: boolean description: Indica se o registro foi excluído default: false e012famFinRat: type: object allOf: – #/definitions/e012famFinRat description: Especialização de rateio na Família extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado 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: e012famFinRat: description: Cadastros – Famílias – Parâmetros de rateio type: object properties: id: type: string format: uuid description: ID do registro (igual ao ID da E012fam) e012fam: type: object allOf: – #/definitions/e012fam description: Família e045plaCtaRed: type: object allOf: – #/definitions/e045pla description: Conta Contábil e045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 e045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 e045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 e045plaCtaDcd: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 5 e045plaCtaDci: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 6 e091plfFinCrp: type: object allOf: – #/definitions/e091plf description: Conta Receita Padrão e091plfFinCdp: type: object allOf: – #/definitions/e091plf description: Conta Despesa Padrão excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e600cco: description: Tesouraria – Conta – Cadastro type: object required: – e070emp – numCco – desCco properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa numCco: type: string maxLength: 14 description: Conta Interna desCco: type: string maxLength: 30 description: Descrição e600ccoFinRat: type: object allOf: – #/definitions/e600ccoFinRat description: Parametros rateio extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e600ccoFinRat: description: Tesouraria – Conta – Cadastro – Rateio type: object properties: id: type: string format: uuid description: Id da entidade e600cco: type: object allOf: – #/definitions/e600cco description: Conta Interna e045plaCtaRed: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 1 e045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 e045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 e045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 e045pca: type: object allOf: – #/definitions/e045pca description: Conta Auxiliar – 1 excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Cadastros – Empresas type: object required: – id – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade e070empCplCtb: type: object allOf: – #/definitions/e070empCplCtb description: Especialização Contabilidade – Empresa codEmp: type: integer format: int64 description: Empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome sigEmp: type: string maxLength: 100 description: Nome fantasia usaAgr: type: boolean description: Utiliza agrupamento filial excluido: type: boolean description: Indica se o registro foi excluído default: false e070empFinRat: type: object allOf: – #/definitions/e070empFinRat description: Especialização – Empresa – FinRat extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração duplicando: type: boolean description: Indica se o registro está sendo duplicado default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070empCplCtb: description: Especialização Contabilidade – Empresa type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e043mpcCodMpc: type: object allOf: – #/definitions/e043mpc description: Modelo de plano contábil utilizado e043mpcCodMpx: type: object allOf: – #/definitions/e043mpc description: Modelo de plano auxiliar utilizado statusCodMpc: type: string allOf: – #/definitions/replicacaoModeloStatus description: Status da replicação para o modelo de plano contábil mensagemCodMpc: type: string description: Mensagem de erro da replicação para o modelo de plano contábil statusCodMpx: type: string allOf: – #/definitions/replicacaoModeloStatus description: Status da replicação para o modelo de plano auxiliar mensagemCodMpx: type: string description: Mensagem de erro da replicação para o modelo de plano auxiliar 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: e070empFinRat: description: Especialização – Rateio – Empresa type: object required: – statusCodMpf – statusCodMpu properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e043mpcCodMpf: type: object allOf: – #/definitions/e043mpc description: Código do modelo de plano financeiro utilizado e043mpcCodMpu: type: object allOf: – #/definitions/e043mpc description: Código do modelo de plano de centro de custos utilizado estLef: type: boolean description: Lança movimentos de estoque no plano financeiro default: false recLtp: type: boolean description: Lança títulos de previsão do contas a receber no plano financeiro default: false pagLtp: type: boolean description: Lança títulos de previsão do contas a pagar no plano financeiro default: false sugCtb: type: boolean description: Sugere conta contábil no rateio plano financeiro default: true excluido: type: boolean description: Indica se o registro foi excluído default: false statusCodMpf: type: string allOf: – #/definitions/replicacaoModeloStatus description: Status da replicação para o modelo de plano financeiro mensagemCodMpf: type: string description: Mensagem de erro da replicação para o modelo de plano financeiro statusCodMpu: type: string allOf: – #/definitions/replicacaoModeloStatus description: Status da replicação para o modelo de plano de centro de custo mensagemCodMpu: type: string description: Mensagem de erro da replicação para o modelo de plano de centro de custo usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e043mmp: description: Máscara das classificações dos modelos de plano type: object required: – codGcc – mskGcc – defGru – e043mpc properties: id: type: string format: uuid description: Identificador da entidade codGcc: type: integer format: int64 description: Código do grupo de contas minimum: 1 maximum: 9 mskGcc: type: string maxLength: 45 description: Máscara do grupo de contas defGru: type: string allOf: – #/definitions/enumGruCta description: Definição do grupo de contas forRat: type: string allOf: – #/definitions/enumForRat description: Forma de rateio dos lançamentos e043mpc: type: object allOf: – #/definitions/e043mpc description: Modelo de plano associado excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e043pcm: description: Modelo de centro de custo type: object required: – ctaRed – defGru – claCta – desCta – abrCta – sitCon – anaSin – natCta – nivCta – exiRat – forRat – e043mpc – e043mmp properties: id: type: string format: uuid description: Id da entidade ctaRed: type: integer format: int64 description: Conta Reduzida minimum: 1 maximum: 999999999 mskGcc: type: string maxLength: 40 description: Máscara e043mpcCtb: type: object allOf: – #/definitions/e043mpc description: Modelo Plano Contábil defGru: type: string allOf: – #/definitions/enumGruCta description: Definição claCta: type: string maxLength: 30 description: Classificação/Máscara claMskCta: type: string maxLength: 45 description: Classificação Formatada desCta: type: string maxLength: 250 description: Nomenclatura abrCta: type: string maxLength: 20 description: Abreviatura sitCon: type: string allOf: – #/definitions/enumSitReg description: Situação anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítica/Sintética aceMan: type: boolean description: Aceita lançamento manual default: false natCta: type: string allOf: – #/definitions/enumNatCtb description: Natureza nivCta: type: integer format: int64 description: Nível minimum: 1 maximum: 99 exiRat: type: boolean description: Exige Rateio forRat: type: string allOf: – #/definitions/enumForRat description: Forma de Rateio ctaPar: type: integer format: int64 description: Conta Reduzida Paralela minimum: 0 maximum: 999999999 claPar: type: string maxLength: 30 description: Classificação Paralela desPar: type: string maxLength: 80 description: Descrição Paralela codCcu: type: string maxLength: 9 description: Centro de Custo tipCcu: type: string allOf: – #/definitions/enumTipCtc description: Tipo do Centro Custo exiAux: type: boolean description: Exige Conta Auxiliar default: false metCon: type: string allOf: – #/definitions/enumMetCon description: Método de Conversão valIni: type: string format: date description: Validade Inicial valFin: type: string format: date description: Validade Final e043mpc: type: object allOf: – #/definitions/e043mpc description: Modelo Plano e043mmp: type: object allOf: – #/definitions/e043mmp description: Mascara do Plano e043pcmPai: type: object allOf: – #/definitions/e043pcm description: Conta Reduzida Contábil e043pcmCtbCtaRed: type: object allOf: – #/definitions/e043pcm description: Conta Reduzida Contábil e043pcmCtbCtaRcr: type: object allOf: – #/definitions/e043pcm description: Conta Reduzida Contábil 2 e043pcmCtbCtaFdv: type: object allOf: – #/definitions/e043pcm description: Conta Reduzida Contábil 3 e043pcmCtbCtaFcr: type: object allOf: – #/definitions/e043pcm description: Conta Reduzida Contábil 4 tipCfc: type: string allOf: – #/definitions/enumTipCfc description: Tipo efeito fluxo de caixa excluido: type: boolean description: Indica se o registro foi excluído default: false tipoFinanceiro: type: object allOf: – #/definitions/tipoFinanceiro description: Tipo Financeiro grupoCentroCusto: type: object allOf: – #/definitions/grupoCentroCusto description: Grupo de centro de custo referentialAccountOrdering: type: integer format: int64 description: Número ordenação conta referencial minimum: 1 maximum: 999999999 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e043mpc: description: Modelo de plano financeiro type: object required: – codMpc – desMpc – tipPla – sitMpc – incCta properties: id: type: string format: uuid description: Id da entidade codMpc: type: integer format: int64 description: Código Modelo Plano minimum: 0 maximum: 9999 desMpc: type: string maxLength: 40 description: Descrição tipPla: type: string allOf: – #/definitions/enumTipPla description: Tipo Plano sitMpc: type: string allOf: – #/definitions/enumSitReg description: Situação incCta: type: integer format: int64 description: Valor de incremento minimum: 1 maximum: 9999 mpcRef: type: boolean description: Modelo referencial default: false codRef: type: string allOf: – #/definitions/enumCodRef description: Código do responsável obsMpc: type: string maxLength: 250 description: Observação e043mpc: type: object allOf: – #/definitions/e043mpc description: Modelo de plano contábil associado ao plano financeiro e043mpcPai: type: object allOf: – #/definitions/e043mpc description: Modelo de plano pai excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e044ccu: description: Cadastros – Centros de Custos type: object required: – codCcu – desCcu – abrCcu – tipCcu – anaSin – aceRat – sitCcu – e070emp properties: id: type: string format: uuid description: Id da entidade codCcu: type: string maxLength: 9 description: Código do centro de custos desCcu: type: string maxLength: 250 description: Descrição do centro de custos abrCcu: type: string maxLength: 20 description: Abreviatura do centro de custos tipCcu: type: string allOf: – #/definitions/enumTipCtc description: Tipo claCcu: type: string maxLength: 30 description: Classificação do centro de custo claMskCcu: type: string maxLength: 45 description: Classificação Formatada claDes: type: string allOf: – #/definitions/enumClaDes description: Classificação de despesa taxIcu: type: number format: double description: Taxa de depreciação minimum: 0.00 maximum: 999.99 anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítico ou Sintético aceRat: type: boolean description: AceRat indAgr: type: string allOf: – #/definitions/enumUniCre description: Tempo dos processos agrTax: type: string maxLength: 10 description: Código de agrupamento geração de taxa mskCcu: type: string maxLength: 40 description: Máscara gruCcu: type: integer format: int64 description: Grupo de máscara minimum: 0 maximum: 9999999999999999 nivCcu: type: integer format: int64 description: Nível minimum: 1 maximum: 99 posCcu: type: integer format: int64 description: Total de posições minimum: 0 maximum: 999 criRat: type: string allOf: – #/definitions/enumCriRat description: Critério de rateio sitCcu: type: string allOf: – #/definitions/enumSitReg description: Situação e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e044ccuPai: type: object allOf: – #/definitions/e044ccu description: Centro de custo pai e045plaCtaRed: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 1 e045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 2 e045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 3 e045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 4 e043pcm: type: object allOf: – #/definitions/e043pcm description: Conta do modelo de plano de contas relacionada excluido: type: boolean description: Indica se o registro foi excluído default: false grupoCentroCusto: type: object allOf: – #/definitions/grupoCentroCusto description: Grupo do centro de custo usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e045pca: description: Tabelas – Plano Composição Auxiliar – Contas type: object required: – e070emp – ctaAux – desCta – abrCta – claAux – anaSin – nivAux – sitAux – defGru properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa ctaAux: type: integer format: int64 description: Conta Auxiliar Reduzida minimum: 0 maximum: 999999999 desCta: type: string maxLength: 250 description: Nomenclatura abrCta: type: string maxLength: 20 description: Abreviatura claAux: type: string maxLength: 30 description: Classificação claMskAux: type: string maxLength: 45 description: Classificação Formatada anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítica ou Sintética nivAux: type: integer format: int64 description: Nível minimum: 1 maximum: 99 posAux: type: integer format: int64 description: Posições Nível minimum: 0 maximum: 9 ultMov: type: string format: date description: Data Último Movimento sitAux: type: string allOf: – #/definitions/enumSitReg description: Situação defGru: type: string allOf: – #/definitions/enumGruCta description: Definição Grupo mskAux: type: string maxLength: 40 description: Máscara gruAux: type: integer format: int64 description: Grupo minimum: 0 maximum: 9 e045pcaPai: type: object allOf: – #/definitions/e045pca description: Conta auxiliar – pai e043pcm: type: object allOf: – #/definitions/e043pcm description: Conta do modelo de plano de contas relacionada excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e045pla: description: Tabelas – Plano Contábil – Contas type: object required: – e070emp – ctaRed – claCta – desCta – anaSin – defGru – natCta – sitCta – forRat properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa nivCta: type: integer format: int64 description: Nível da conta contábil minimum: 1 maximum: 99 ctaRed: type: integer format: int64 description: Conta Contábil Reduzida minimum: 0 maximum: 9999999 claCta: type: string maxLength: 30 description: Classificação claMskCta: type: string maxLength: 45 description: Classificação Formatada desCta: type: string maxLength: 250 description: Nomenclatura abrCta: type: string maxLength: 20 description: Abreviatura anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítico ou Sintético defGru: type: string allOf: – #/definitions/enumGruCta description: Definição do grupo natCta: type: string allOf: – #/definitions/enumNatCtb description: Natureza sitCta: type: string allOf: – #/definitions/enumSitReg description: Situação e045plaPai: type: object allOf: – #/definitions/e045pla description: Conta Reduzida Pai aceMan: type: boolean description: Aceita lançamento manual default: false forRat: type: string allOf: – #/definitions/enumForRat description: Forma de Rateio exiAux: type: boolean description: Exige Conta Auxiliar default: false e043pcm: type: object allOf: – #/definitions/e043pcm description: Conta do modelo de plano de contas relacionada excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e091plf: description: Tabelas – Plano Financeiro – Contas type: object required: – ctaFin – desCta – abrCta – claFin – defGru – gruFin – nivFin – posFin – natFin – e091plfPai – sitFin – anaSin – e070emp properties: id: type: string format: uuid description: Id da entidade ctaFin: type: integer format: int64 description: Conta Financeira Reduzida minimum: 0 maximum: 9999999 desCta: type: string maxLength: 250 description: Nomenclatura abrCta: type: string maxLength: 20 description: Abreviatura claFin: type: string maxLength: 30 description: Classificação claMskFin: type: string maxLength: 45 description: Classificação Formatada tipCfc: type: string allOf: – #/definitions/enumTipCfc description: Tipo seqCfc: type: integer format: int64 description: Sequência minimum: 0 maximum: 9999999 defGru: type: string allOf: – #/definitions/enumGruCta description: Definição de grupo mskFin: type: string maxLength: 40 description: Máscara gruFin: type: integer format: int64 description: Grupo a que pertence minimum: 1 maximum: 99 nivFin: type: integer format: int64 description: Nível minimum: 1 maximum: 99 posFin: type: integer format: int64 description: Total de posições minimum: 1 maximum: 9 natFin: type: string allOf: – #/definitions/enumNatCtb description: Natureza forRat: type: string allOf: – #/definitions/enumForRat description: Forma de rateio e091plfPai: type: object allOf: – #/definitions/e091plf description: Plano financeiro pai e045plaCtaRed: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 1 e045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 2 e045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 3 e045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta contábil reduzida 4 sitFin: type: string allOf: – #/definitions/enumSitReg description: Situação anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítico ou Sintético e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e043pcm: type: object allOf: – #/definitions/e043pcm description: Conta do modelo de plano de contas relacionada excluido: type: boolean description: Indica se o registro foi excluído default: false tipoFinanceiro: type: object allOf: – #/definitions/tipoFinanceiro description: Tipo financeiro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: tipoFinanceiro: description: Tipo Financeiro type: object required: – codigo – descricao properties: id: type: string format: uuid description: Identificador do registro codigo: type: integer format: int64 description: Código do tipo financeiro descricao: type: string description: Descrição do tipo financeiro excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: grupoCentroCusto: description: Grupo de centros de custo type: object required: – codigo – descricao properties: id: type: string format: uuid description: Identificador do registro codigo: type: integer format: int64 description: Código do grupo de centro de custo descricao: type: string description: Descrição do grupo de centro de custo excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editGrupoCentroCusto: type: object required: – id allOf: – #/definitions/grupoCentroCusto e070fil: description: Cadastros – Filiais type: object required: – e070emp – codFil – nomFil – numCgc – sigFil properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 99999 nomFil: type: string maxLength: 100 description: Nome numCgc: type: string maxLength: 18 description: CPF/CNPJ da filial sigFil: type: string maxLength: 100 description: Sigla da filial e070filCplCtb: type: object allOf: – #/definitions/e070filCplCtb description: Especialização Contabilidade – Filial excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração duplicando: type: boolean description: Indica se o registro está sendo duplicado default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070filCplCtb: description: Especialização Contabilidade – Filial type: object properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Id da filial ctbExi: type: string format: date description: Data inicial do período contábil permitido para lançamentos ctbExf: type: string format: date description: Data final do período contábil permitido para lançamentos ctbPei: type: string format: date description: Mês e ano inicial do período permitido para lançamentos ctbPef: type: string format: date description: Mês e ano final do período permitido para lançamentos perApuRes: type: string allOf: – #/definitions/enumPerApuRes description: Indicativo de periodicidade da apuração de resultados para a filial datUltApuRes: type: string format: date description: Data da última apuração de resultados realizada na filial e045plaCtaDes: type: string format: uuid description: Conta contábil transitória padrão para o grupo de despesas e045plaCtaRec: type: string format: uuid description: Conta contábil transitória padrão para o grupo de receitas e045plaCtaOut: type: string format: uuid description: Conta contábil transitória padrão para o grupo outros e045plaCtaLuc: type: string format: uuid description: Conta contábil de padrão para lucros e045plaCtaPre: type: string format: uuid description: Conta contábil de padrão para prejuízos 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: e023crp: description: Tabelas – Grupos de Contas a Receber ou Pagar type: object properties: id: type: string format: uuid description: Id da entidade codCrp: type: string maxLength: 3 description: Grupo Receber/Pagar desCrp: type: string maxLength: 30 description: Descrição aplGrp: type: string allOf: – #/definitions/enumAplGrp description: Aplicação Grupo excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e089doc: description: Tabelas – Tipos de Documento type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codDoc: type: string maxLength: 3 description: Código Tipo Documento desDoc: type: string maxLength: 100 description: Descrição excluido: type: boolean description: Indica se o registro foi excluído default: false e089docFinRat: type: object allOf: – #/definitions/e089docFinRat description: Especialização tipo documento extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado 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: e089docFinRat: description: Especialização – Tipos de Documento type: object properties: id: type: string format: uuid description: Id da entidade e089doc: type: object allOf: – #/definitions/e089doc description: Tipo Documento id045plaCtaRdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 1 id045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 id045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 id045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e039por: description: Cadastros – Portadores type: object required: – sitPor properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codPor: type: string maxLength: 4 description: Portador desPor: type: string maxLength: 30 description: Descrição sitPor: type: string allOf: – #/definitions/enumSitReg description: Situacao abrPor: type: string maxLength: 10 description: Abreviatura excluido: type: boolean description: Indica se o registro foi excluído default: false e039porFinRat: type: object allOf: – #/definitions/e039porFinRat description: Especialização do portador extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado 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: e039porFinRat: description: Cadastros – Portadores – Especialização – Rateio type: object properties: id: type: string format: uuid description: Id da entidade e039por: type: object allOf: – #/definitions/e039por description: Histórico e045plaCtaRed: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 1 e045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 e045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 e045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075der: description: Cadastros – Produtos – Derivações type: object required: – codDer – desDer – e012fam – excluido properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codDer: type: string maxLength: 23 description: Derivação desDer: type: string maxLength: 120 description: Descrição e012fam: type: object allOf: – #/definitions/e012fam description: Familia produto e075derFinRat: type: object allOf: – #/definitions/e075derFinRat description: Especialização produto rateio extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e075derFinRat: description: Especialização – Produto rateio type: object properties: id: type: string format: uuid description: Id da entidade e075der: type: object allOf: – #/definitions/e075der description: Produto ctaRed: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 1 ctaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 ctaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 ctaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 ctaDcd: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 5 ctaDci: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 6 finCrp: type: object allOf: – #/definitions/e091plf description: Conta financeira de receita (saída) padrão para efeito de rateio finCdp: type: object allOf: – #/definitions/e091plf description: Conta financeira de despesa (entrada) padrão para efeito de rateio excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e080ser: description: Cadastros – Serviços type: object required: – e070emp – codSer – desSer – e012fam – sitSer properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codSer: type: string maxLength: 14 description: Serviço desSer: type: string maxLength: 70 description: Descrição cplSer: type: string maxLength: 250 description: Complemento e012fam: type: object allOf: – #/definitions/e012fam description: Família qtdPad: type: number format: double description: Quantidade Padrão minimum: 0.00 maximum: 999999999.99999 obsSer: type: string maxLength: 999 description: Observação do Serviço sitSer: type: string allOf: – #/definitions/enumSitReg description: Situação e070fil: type: object allOf: – #/definitions/e070fil description: Filial do Serviço e080serFinRat: type: object allOf: – #/definitions/e080serFinRat description: Especialização cadastro de serviço excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e080serFinRat: description: Especialização cadastro de serviço type: object properties: id: type: string format: uuid description: Id da entidade e080ser: type: object allOf: – #/definitions/e080ser description: Produto ctaRed: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 1 ctaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 ctaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 ctaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 codCcu: type: object allOf: – #/definitions/e044ccu description: Código do Centro de Custo finCrp: type: object allOf: – #/definitions/e091plf description: Conta financeira de receita (saída) padrão para efeito de rateio finCdp: type: object allOf: – #/definitions/e091plf description: Conta financeira de despesa (entrada) padrão para efeito de rateio excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e205dep: description: Estoques – Depósitos – Cadastro 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 Localização codDep: type: string maxLength: 10 description: Depósito desDep: type: string maxLength: 30 description: Descrição abrDep: type: string maxLength: 10 description: Abreviatura sitDep: type: string allOf: – #/definitions/enumSitReg description: Situação e205depFinRat: type: object allOf: – #/definitions/e205depFinRat description: Especialização tipo documento excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e205depFinRat: description: Especialização – Depósitos type: object properties: id: type: string format: uuid description: Id da entidade e205dep: type: object allOf: – #/definitions/e205dep description: Depósito id045plaCtaRed: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 1 id045plaCtaRcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 2 id045plaCtaFdv: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 3 id045plaCtaFcr: type: object allOf: – #/definitions/e045pla description: Conta Contábil – 4 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e030age: description: Cadastros – Bancos – Agências type: object required: – e030ban – codAge – nomAge properties: id: type: string format: uuid description: Id da entidade e030ban: type: object allOf: – #/definitions/e030ban description: Banco codAge: type: string maxLength: 7 description: Agência nomAge: type: string maxLength: 30 description: Nome usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e030ban: description: Cadastros – Bancos type: object required: – codBan – nomBan properties: id: type: string format: uuid description: Id da entidade codBan: type: string maxLength: 3 description: Banco nomBan: type: string maxLength: 100 description: Nome excluido: type: boolean description: Indica se o registro foi excluído default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string 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