erpx_sup

database

10 views 04/08/2020 14/12/2020 integrador 0

2.0info: 3.25.0 database description: Serviço de migração da base de impostos x-senior-domain: erpx_sup x-senior-domain-path: erpx_sup 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_supsecurityDefinitions: 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/exportE070emp: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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: PUBLIC 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/exportE083ori: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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/exportE015med: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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/exportE069gre: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE007ufs: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE070afi: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE008rai: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE008cep: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE006pai: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE021mot: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE001pes: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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/exportE070ent: post: description: tags: – Queries x-senior-visibility: PUBLIC 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/exportE020snf: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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/exportE031moe: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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: PUBLIC 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: PUBLIC 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/exportE026ram: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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: PUBLIC 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: Realiza a migração do schema do banco 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/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/importE070emp: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: PUBLIC 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: PUBLIC 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/importE083ori: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: PUBLIC 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/importE015med: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: PUBLIC 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/importE069gre: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE007ufs: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE070afi: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE008rai: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE008cep: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE006pai: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE021mot: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE001pes: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: PUBLIC 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/importE070ent: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/importE020snf: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: PUBLIC 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/importE031moe: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: PUBLIC 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: PUBLIC 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: PUBLIC 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/importE026ram: post: description: tags: – Actions x-senior-visibility: PUBLIC 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/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 responses: 200: description: Ok schema: 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/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 responses: 200: description: Ok schema: 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/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 responses: 200: description: Ok schema: 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/e083ori: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e083ori 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e083ori/{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/e083ori 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 responses: 200: description: Ok schema: 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/e015med: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e015med 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e015med/{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/e015med 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 responses: 200: description: Ok schema: 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/e069gre: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e069gre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e069gre/{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/e069gre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e007ufs: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e007ufs/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e007ufs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070afi: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e070afi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070afi/{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/e070afi 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e008rai: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e008rai/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e008rai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e008cep: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e008cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e008cep/{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/e008cep 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e006pai: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e006pai/{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/e006pai 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e021mot: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e021mot 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e021mot/{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/e021mot 401: description: Invalid Credentials 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 responses: 200: description: Ok schema: 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/e080ser: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e080ser/{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/e080ser 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e070ent: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e070ent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e020snf: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/e020snf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e020snf/{id}: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e020snf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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 responses: 200: description: Ok schema: 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/e031moe: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e031moe/{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/e031moe 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e044ccu: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e044ccu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e044ccu/{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/e044ccu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e045pla: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e045pla 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e045pla/{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/e045pla 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e091plf: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e091plf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e091plf/{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/e091plf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e026ram: 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 responses: 200: description: Ok schema: type: array items: #/definitions/e026ram 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /database/entities/e026ram/{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/e026ram 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumAplGrp: description: Tipo de aplicação type: string enum: – VA – VR – VP enumAplSnf: description: Aplicação type: string enum: – VS – VM – VE – VF – VD enumAplMot: description: Aplicação do motivo da situação type: string enum: – V5 – V9 – V10 – V11 – V14 – V17 – V18 – V19 – V25 – V28 – V30 – V36 – V42 – V43 – V44 – V45 – V46 – V47 – V51 – V52 – V99 enumClaPro: description: Enumeração da Classe de Produto type: string enum: – V1 – V2 – V3 – V4 enumTipPro: description: Enumeração tipo de produto type: string enum: – VP – VC – VM – VS enumSitReg: description: Enumeração da Situação Registro type: string enum: – VA – VI enumLisMod: description: Módulo da transação type: string enum: – VVEP – VVEF – VVES – VESN – VESR – VESB – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT – VESC – VESF upDown: description: Up or down type: string enum: – UP – DOWN enumTipEmp: description: Tipo de empresa type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V99 enumAnaSin: description: Nome da lista na G5: LAnaSin type: string enum: – VA – VS enumNatCtb: description: Natureza type: string enum: – VD – VC userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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 e070emp: description: Cadastros – Empresas type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade 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 da empresa e069gre: type: object allOf: – #/definitions/e069gre description: Grupo Empresas 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: e070fil: description: Cadastros – Filiais type: object required: – e070emp – codFil – nomFil – sigFil – insEst – insMun – filMat – endFil – cplEnd – baiFil 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 sigFil: type: string maxLength: 100 description: Nome Fantasia da Filial da Empresa numCgc: type: string maxLength: 18 description: Número do CPNJ/CPF da Filial da Empresa numIdf: type: string maxLength: 40 description: Número de identificação Fiscal insEst: type: string maxLength: 25 description: Inscrição estadual da filial da empresa insMun: type: string maxLength: 16 description: Inscrição municipal da filial da empresa filMat: type: boolean description: Indicativo que a filial é matriz cepFil: type: object allOf: – #/definitions/e008cep description: CEP da Filial da Empresa endFil: type: string maxLength: 100 description: Endereço da Filial da Empresa cplEnd: type: string maxLength: 200 description: Complemento do Endereço da Filial da Empresa (Sala, Andar, etc.) baiFil: type: string maxLength: 75 description: Bairro da Filial da Empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração 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: – e070emp – codTns – desTns – lisMod – 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 excluido: type: boolean description: Indica se o registro foi excluído default: false aceMan: type: boolean description: Aceita Manual sitTns: 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 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e083ori: description: Cadastros – Origens de Produto type: object required: – e070emp – codOri – desOri properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codOri: type: string maxLength: 3 description: Código Origem desOri: type: string maxLength: 40 description: Descriçã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: e012fam: description: Cadastros – Famílias type: object required: – id – e070emp – codFam – desFam – tipPro – e083ori 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 tipPro: type: string allOf: – #/definitions/enumTipPro description: Tipo de produto (C=Comprado, P=Produzido, S=Serviço) e083ori: type: object allOf: – #/definitions/e083ori description: Origem da família sitFam: 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: e015med: description: Cadastros – Unidades de Medida type: object required: – uniMed – desMed properties: id: type: string format: uuid description: Id da entidade uniMed: type: string maxLength: 6 description: Unidade Medida desMed: type: string maxLength: 100 description: Descrição qtdDec: type: integer format: int64 description: Quantidade Decimais minimum: 0 maximum: 5 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: e075der: description: Cadastros – Produtos – Derivações type: object required: – codDer – e070emp – sitDer – e012fam – claPro properties: id: type: string format: uuid description: Id da entidade codDer: type: string maxLength: 23 description: Derivação e070emp: type: object allOf: – #/definitions/e070emp description: Empresa desDer: type: string maxLength: 100 description: Descrição sitDer: type: string allOf: – #/definitions/enumSitReg description: Situação e012fam: type: object allOf: – #/definitions/e012fam description: Família excluido: type: boolean description: Indica se o registro foi excluído default: false claPro: type: string allOf: – #/definitions/enumClaPro description: Classe de Produto desCpl: type: string maxLength: 90 description: Descrição complementar 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: e069gre: description: Cadastros – Grupos de Empresas type: object required: – codGre – nomGre properties: id: type: string format: uuid description: Id da entidade codGre: type: integer format: int64 description: Grupo Empresa minimum: 0 maximum: 999999999 nomGre: type: string maxLength: 100 description: Nome 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: e007ufs: description: Tabelas – Estados type: object required: – sigUfs – nomUfs – e006pai properties: id: type: string format: uuid description: Id da entidade sigUfs: type: string maxLength: 2 description: Sigla nomUfs: type: string maxLength: 20 description: Nome e006pai: type: object allOf: – #/definitions/e006pai description: País excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070afi: description: Cadastros – Filiais – Agrupamento de Filiais type: object required: – e070emp – codAfi – desAfi properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codAfi: type: integer format: int64 description: Agrupamento Filiais minimum: 0 maximum: 9999 desAfi: type: string maxLength: 30 description: Descrição e070fil: type: object allOf: – #/definitions/e070fil description: Filial Matriz 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: e008rai: description: Tabelas – Cidades para RAIS – SIG type: object required: – codRai – nomCid – e007ufs properties: id: type: string format: uuid description: Id da entidade codRai: type: integer format: int64 description: Código Cidade minimum: 0 maximum: 9999999 nomCid: type: string maxLength: 60 description: Nome Cidade e007ufs: type: object allOf: – #/definitions/e007ufs description: Estado popCid: type: integer format: int64 description: População minimum: 0 maximum: 999999999 potAlf: type: number format: double description: Potencial Consumo minimum: 0.00 maximum: 99.999 locGeo: type: string maxLength: 6 description: Localização Geográfica cepMin: type: integer format: int64 description: CEP Inicial minimum: 0 maximum: 99999999 cepMax: type: integer format: int64 description: CEP final minimum: 0 maximum: 99999999 codFis: type: integer format: int64 description: Código Fiscal Município minimum: 0 maximum: 9999999 codIbg: type: integer format: int64 description: Código IBGE Município minimum: 0 maximum: 9999999 e008cep: type: array items: type: object allOf: – #/definitions/e008cep description: Lista de CEPs da cidade 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: e008cep: description: Tabelas – Cep type: object required: – cepIni properties: id: type: string format: uuid description: Id da entidade cepIni: type: integer format: int64 description: CEP Endereço minimum: 0 maximum: 99999999 baiEnd: type: string maxLength: 75 description: Bairro logEnd: type: string maxLength: 255 description: Logradouro e008rai: type: object allOf: – #/definitions/e008rai description: Cidade 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: e006pai: description: Tabelas – Países type: object required: – codPai – nomPai – merSul – visEnt properties: id: type: string format: uuid description: Id da entidade codPai: type: string maxLength: 4 description: Código nomPai: type: string maxLength: 150 description: Nome merSul: type: boolean description: Mercosul visEnt: type: boolean description: Visto Entrada 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: e021mot: description: Tabelas – Motivos das Situações das Tabelas type: object required: – codMot – desMot properties: id: type: string format: uuid description: Id da entidade codMot: type: integer format: int64 description: Código do motivo da observação ou situação maximum: 999999 desMot: type: string maxLength: 30 description: Descrição do motivo da observação ou situação aplMot: type: string allOf: – #/definitions/enumAplMot description: Aplicação dos motivos das situações das tabelas 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: e001pes: description: Pessoa type: object required: – codPes – nomPes – apePes – sitPes properties: id: type: string format: uuid description: Id da entidade codPes: type: integer format: int64 description: Pessoa minimum: 0 maximum: 999999999 nomPes: type: string maxLength: 100 description: Nome apePes: type: string maxLength: 50 description: Nome fantasia cnpCpf: type: string maxLength: 14 description: CNPJ/CPF numRge: type: string maxLength: 13 description: Número do RG datRge: type: string format: date description: Data de emissão do RG orgRge: type: string maxLength: 6 description: Órgão emissor do RG insEst: type: string maxLength: 25 description: Inscrição estadual insMun: type: string maxLength: 16 description: Inscrição municipal numIdf: type: string maxLength: 40 description: Número de identificação fiscal (NIF) codSuf: type: string maxLength: 10 description: Código do SUFRAMA datSuf: type: string format: date description: Validade do registro do SUFRAMA endPes: type: string maxLength: 100 description: Endereço numEnd: type: string maxLength: 60 description: Número cplEnd: type: string maxLength: 200 description: Complemento nomBai: type: string maxLength: 75 description: Bairro cxaPst: type: integer format: int64 description: Caixa postal minimum: 0 maximum: 999999 zipCod: type: string maxLength: 20 description: Zip code fonPes: type: string maxLength: 20 description: Telefone fonPe2: type: string maxLength: 20 description: Telefone 2 faxPes: type: string maxLength: 20 description: Fax intNet: type: string maxLength: 100 description: E-mail emaNfe: type: string maxLength: 100 description: E-mail para envio de documentos eletrônicos datNas: type: string format: date description: Data de nascimento datVct: type: string format: date description: Vencimento do cadastro do cliente qtdAtu: type: integer format: int64 description: Quantidade de renovações cadastrais minimum: 0 maximum: 9999 numNis: type: string maxLength: 11 description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) qtdDep: type: integer format: int64 description: Quantidade de dependentes minimum: 0 maximum: 9999 codCae: type: string maxLength: 17 description: Cadastro da atividade econômica da pessoa física (CAEPF) e026ram: type: object allOf: – #/definitions/e026ram description: Ramo de atividade sitPes: 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: e080ser: description: Cadastros – serviços type: object required: – e070emp – e012fam – codSer – desSer – e015med – sitSer properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e012fam: type: object allOf: – #/definitions/e012fam description: Família codSer: type: string maxLength: 14 description: Serviço desSer: type: string maxLength: 70 description: Descrição e015med: type: object allOf: – #/definitions/e015med description: Unidade de medida cplSer: type: string maxLength: 250 description: Complemento obsSer: type: string maxLength: 999 description: Observação do serviço sitSer: 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: e070ent: description: Endereço de entrega type: object required: – e007ufsEstEnt – endEnt – cidEnt – sitReg properties: id: type: string format: uuid description: Id da entidade indEnt: type: boolean description: Indicativo se o endereço é utilizado para entrega default: true indCob: type: boolean description: Indicativo se o endereço é utilizado para cobrança default: false e070fil: type: object allOf: – #/definitions/e070fil description: Filial e008cep: type: object allOf: – #/definitions/e008cep description: CEP e007ufsEstEnt: type: object allOf: – #/definitions/e007ufs description: Estado endEnt: type: string maxLength: 100 description: Endereço cidEnt: type: string maxLength: 60 description: Cidade baiEnt: type: string maxLength: 75 description: Bairro sitReg: type: string allOf: – #/definitions/enumSitReg description: Situação cplEnt: type: string maxLength: 200 description: Complemento 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: e020snf: description: Séries de notas fiscais type: object required: – codSnf – desSnf – abrSnf – aplSnf – qtdPar – qtdPos 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 codSnf: type: string maxLength: 3 description: Código desSnf: type: string maxLength: 30 description: Descrição abrSnf: type: string maxLength: 10 description: Abreviatura aplSnf: type: string allOf: – #/definitions/enumAplSnf description: Aplicação codSel: type: string maxLength: 3 description: Série codSsl: type: string maxLength: 2 description: Subsérie qtdPar: type: integer format: int64 description: Quantidade máxima de parcelas minimum: 1 maximum: 999 qtdPos: type: integer format: int64 description: Quantidade de números da nota fiscal minimum: 6 maximum: 9 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: Tipo de título type: object properties: id: type: string format: uuid description: Id da entidade codTpt: type: string maxLength: 3 description: Código desTpt: type: string maxLength: 40 description: Descrição sitTpt: type: string allOf: – #/definitions/enumSitReg description: Situação aplTpt: type: string allOf: – #/definitions/enumAplGrp description: Tipo de aplicaçã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: e031moe: description: Moeda type: object properties: id: type: string format: uuid description: Id da entidade codMoe: type: string maxLength: 3 description: Código desMoe: type: string maxLength: 30 description: Descrição sigMoe: type: string maxLength: 5 description: Sigla 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: e044ccu: description: Centros de Custos type: object required: – e070emp – codCcu – desCcu – anaSin – aceRat properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codCcu: type: string maxLength: 9 description: Centro Custos desCcu: type: string maxLength: 80 description: Descrição anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítico ou Sintético aceRat: type: boolean description: AceRat 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: e045pla: description: Plano Contábil – Contas type: object required: – e070emp – ctaRed – desCta properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa ctaRed: type: integer format: int64 description: Conta Contábil Reduzida minimum: 0 maximum: 9999999 desCta: type: string maxLength: 250 description: Nomenclatura 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: e091plf: description: Tabelas – Plano Financeiro – Contas type: object required: – e070emp – ctaFin – desCta – natFin – sitFin – anaSin properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa ctaFin: type: integer format: int64 description: Conta Financeira Reduzida minimum: 0 maximum: 9999999 desCta: type: string maxLength: 80 description: Nomenclatura natFin: type: string allOf: – #/definitions/enumNatCtb description: Natureza sitFin: type: string allOf: – #/definitions/enumSitReg description: Situação anaSin: type: string allOf: – #/definitions/enumAnaSin description: Analítico ou Sintético 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: e026ram: description: Tabelas – Ramos de Atividade type: object required: – codRam – desRam – abrRam properties: id: type: string format: uuid description: Id da entidade codRam: type: string maxLength: 5 description: Ramo Atividade desRam: type: string maxLength: 100 description: Descrição abrRam: type: string maxLength: 10 description: Abreviatura tipRam: type: string allOf: – #/definitions/enumTipEmp description: Tipo de ramo de atividade armGerOpeLog: type: boolean description: Indicativo se o ramo de atividade trata-se de Armazém geral/Operador logístico default: false 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: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment