2.0info: 1.15.1 usuario description: ERPX x-senior-domain: erpx_fin x-senior-domain-path: erpx_fin x-senior-service-path: usuario 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_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /usuario/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 /usuario/queries/getDefinitionE099usuFinCpa: post: description: Retorna a definição do usuário do finanças tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codUsu – e070empId properties: codUsu: type: string description: Identificador do usuario e070empId: type: string description: Identificador da empresa responses: 200: description: Ok schema: type: object required: – e099usuFinCpa properties: e099usuFinCpa: type: object allOf: – #/definitions/e099usuFinCpa description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do usuário do finanças tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codUsu description: Identificador do usuario in: query required: true type: string – name: e070empId description: Identificador da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – e099usuFinCpa properties: e099usuFinCpa: type: object allOf: – #/definitions/e099usuFinCpa description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/queries/verifyIndAnt: post: description: Verifica permissão do usuário e se pode alterar um valor no cadastro da filial (e070filFinCre) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dscHcl – e070empId properties: dscHcl: type: boolean description: Ind. se utiliza desconto por antecipação em títulos do pedido e nota de saída e070empId: type: string description: Empresa responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica permissão do usuário e se pode alterar um valor no cadastro da filial (e070filFinCre) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dscHcl description: Ind. se utiliza desconto por antecipação em títulos do pedido e nota de saída in: query required: true type: boolean – name: e070empId description: Empresa in: query required: true type: string responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/queries/getDefinitionE099usuFinCre: post: description: Retorna a definição do usuário do finanças tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codUsu – e070empId properties: codUsu: type: string description: Identificador do usuario e070empId: type: string description: Identificador da empresa responses: 200: description: Ok schema: type: object required: – e099usuFinCre properties: e099usuFinCre: type: object allOf: – #/definitions/e099usuFinCre description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do usuário do finanças tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codUsu description: Identificador do usuario in: query required: true type: string – name: e070empId description: Identificador da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – e099usuFinCre properties: e099usuFinCre: type: object allOf: – #/definitions/e099usuFinCre description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/queries/getDefinitionE099usuFinTes: post: description: Retorna a definição do usuário do finanças tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codUsu – e070empId properties: codUsu: type: string description: Identificador do usuario e070empId: type: string description: Identificador da empresa responses: 200: description: Ok schema: type: object required: – e099usuFinTes properties: e099usuFinTes: type: object allOf: – #/definitions/e099usuFinTes description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a definição do usuário do finanças tags: – Queries x-senior-visibility: PRIVATE parameters: – name: codUsu description: Identificador do usuario in: query required: true type: string – name: e070empId description: Identificador da empresa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – e099usuFinTes properties: e099usuFinTes: type: object allOf: – #/definitions/e099usuFinTes description: Definição do usuário do finanças 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/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 /usuario/queries/exportE099usu: 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 /usuario/queries/exportE099usuFinCpa: 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 /usuario/queries/exportE099usuFinCre: 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 /usuario/queries/exportE099usuFinTes: 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 /usuario/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 /usuario/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 /usuario/actions/checkPermissionNegociation: post: description: Identifica se usuário logado possui permissão para fazer negociação com mais de um fornecedor tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – titleOrigin – e070empId – e001pesId – batchOrigin properties: titleOrigin: type: string allOf: – #/definitions/enumTituloOrigem description: Origem do titulo e070empId: type: string description: Id empresa baixa e001pesId: type: array items: type: string minimum: 1 description: Lista de pessoas do título batchOrigin: type: array items: type: string allOf: – #/definitions/enumOrigemLoteFinanceiro minimum: 1 description: Origem do lote financeiro responses: 200: description: Ok schema: type: object required: – showMessageConfirmation properties: showMessageConfirmation: type: boolean description: Identifica se deve mostrar mensagem de confirmação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/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 /usuario/actions/importE099usu: 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 /usuario/actions/importE099usuFinCpa: 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 /usuario/actions/importE099usuFinCre: 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 /usuario/actions/importE099usuFinTes: 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 /usuario/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 /usuario/events/importE099usuEvent: 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 /usuario/events/exportE099usuEvent: 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 /usuario/events/importE099usuFinCpaEvent: 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 /usuario/events/exportE099usuFinCpaEvent: 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 /usuario/events/importE099usuFinCreEvent: 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 /usuario/events/exportE099usuFinCreEvent: 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 /usuario/events/importE099usuFinTesEvent: 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 /usuario/events/exportE099usuFinTesEvent: 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 /usuario/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 /usuario/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 /usuario/entities/e099usu: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e099usu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usu/{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/e099usu 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usuFinCpa: 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/e099usuFinCpa responses: 200: description: The created resource schema: #/definitions/e099usuFinCpa 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/e099usuFinCpa responses: 200: description: The created resource schema: #/definitions/e099usuFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e099usuFinCpa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usuFinCpa/{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/e099usuFinCpa responses: 200: description: Ok schema: #/definitions/e099usuFinCpa 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/e099usuFinCpa responses: 200: description: Ok schema: #/definitions/e099usuFinCpa 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/e099usuFinCpa 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 /usuario/entities/e099usuFinCpa/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e099usuFinCpa responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usuFinCre: 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/e099usuFinCre responses: 200: description: The created resource schema: #/definitions/e099usuFinCre 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/e099usuFinCre responses: 200: description: The created resource schema: #/definitions/e099usuFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e099usuFinCre 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usuFinCre/{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/e099usuFinCre responses: 200: description: Ok schema: #/definitions/e099usuFinCre 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/e099usuFinCre responses: 200: description: Ok schema: #/definitions/e099usuFinCre 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/e099usuFinCre 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 /usuario/entities/e099usuFinCre/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e099usuFinCre responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usuFinTes: 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/e099usuFinTes responses: 200: description: The created resource schema: #/definitions/e099usuFinTes 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/e099usuFinTes responses: 200: description: The created resource schema: #/definitions/e099usuFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e099usuFinTes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e099usuFinTes/{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/e099usuFinTes responses: 200: description: Ok schema: #/definitions/e099usuFinTes 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/e099usuFinTes responses: 200: description: Ok schema: #/definitions/e099usuFinTes 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/e099usuFinTes 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 /usuario/entities/e099usuFinTes/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e099usuFinTes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/entities/e070emp: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /usuario/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 definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumDatFrj: description: Data base para cálculo do reajuste type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 enumTituloOrigem: description: Origem do título type: string enum: – CONTAS_RECEBER – CONTAS_PAGAR enumOrigemLoteFinanceiro: description: Origem de um lote financeiro type: string enum: – BAIXA_MANUAL_CP_POR_SUBSTITUICAO – BAIXA_MANUAL_CP_POR_APROVEITAMENTO – BAIXA_MANUAL_CP_POR_COMPENSACAO – BAIXA_MANUAL_CP_POR_PAGAMENTO – BAIXA_MANUAL_CR_POR_SUBSTITUICAO – BAIXA_MANUAL_CR_POR_APROVEITAMENTO – BAIXA_MANUAL_CR_POR_COMPENSACAO – BAIXA_MANUAL_CR_POR_PAGAMENTO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR 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 e099usu: description: Replicação – Usuário type: object properties: id: type: string format: uuid description: Id da entidade codUsu: type: string maxLength: 255 description: Usuário 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: e099usuFinCpa: description: Usuários Financeiro Contas a Pagar type: object properties: id: type: string format: uuid description: Id da entidade codUsu: type: string maxLength: 255 description: Código do usuário nomUsu: type: string maxLength: 255 description: Nome do usuário e070emp: type: object allOf: – #/definitions/e070emp description: Empresa pagDet: type: string allOf: – #/definitions/enumDatFrj description: Data base para cálculo do reajuste pagMax: type: number format: double description: Valor máximo permitido para aprovação pagamento contas a pagar pagPgr: type: boolean description: Indicativo se o usuário pode gravar recálculo da consulta do C.Pagar default: false pagAvp: type: boolean description: Indicativo se o usuário pode alterar o vencimento no C. Pagar default: true pagAvl: type: boolean description: Indicativo se o usuário pode alterar o valor no contas a pagar default: true pagAcd: type: boolean description: Indicativo se usuário pode alterar valores no critério de distribuição default: false pagEev: type: boolean description: Usuário aceita vencimento menor que quantidade dias entre entrada e vencimento da filial default: false pagArf: type: boolean description: Indicativo se o usuário pode alterar o rateio de títulos do C.Pagar com o período da filial fechado default: false capArf: type: boolean description: Indicativo se o usuário pode alterar o rateio das comissões com o período da filial fechado default: false patEmp: type: boolean description: Indicativo se o usuário pode alterar alguns campos de títulos de empréstimos default: false baixaNegociacaoMultiplosFornecedores: type: boolean description: Indicativo se a baixa por negociação irá aceitar multiplos fornecedores default: false excluido: type: boolean description: Indica se o registro foi excluido ? default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e099usuFinCre: description: Usuários Financeiro Contas a Receber type: object required: – recPgr – recAvr – recAvl – recAcd – recArf – cobAtc – acrCcm – porObr – altNnu – indAnt – indPon properties: id: type: string format: uuid description: Id da entidade codUsu: type: string maxLength: 255 description: Código do usuário nomUsu: type: string maxLength: 255 description: Nome do usuário e070emp: type: object allOf: – #/definitions/e070emp description: Empresa recPgr: type: boolean description: Indicativo se o usuário pode gravar o recálculo da consulta do C.Receber recAvr: type: boolean description: Indicativo se o usuário pode alterar o vencimento no C.Receber recAvl: type: boolean description: Indicativo se o usuário pode alterar o valor no contas a receber recAcd: type: boolean description: Indicativo se usuário pode alterar valores no critério de distribuição recArf: type: boolean description: Indicativo se o usuário pode alterar o rateio de títulos do C.Receber com o período da filial fechado cobAtc: type: boolean description: Indicativo se o usuário pode alterar títulos que estejam em cobrança acrCcm: type: boolean description: Indicativo se o usuário pode categorizar o cliente manualmente para crédito porObr: type: boolean description: Indicativo se usuário deve informar o código do Portador altNnu: type: boolean description: Indicativo se usuário pode alterar o nosso número da impressão de bloquetos indAnt: type: boolean description: Ind. se usuário tem permissão para informar descontos por antecipação indPon: type: boolean description: Ind. se usuário tem permissão para informar descontos por pontualidade excluido: type: boolean description: Indica se o registro foi excluido ? default: false baixaNegociacaoMultiplosClientes: type: boolean description: Indicativo se a baixa por negociação irá aceitar multiplos clientes default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e099usuFinTes: description: Usuários Financeiro Tesouraria type: object required: – cxbApm – cxbArf – cxbPgp – prpOcp properties: id: type: string format: uuid description: Id da entidade codUsu: type: string maxLength: 255 description: Código do usuário nomUsu: type: string maxLength: 255 description: Nome do usuário e070emp: type: object allOf: – #/definitions/e070emp description: Empresa cxbDcp: type: integer format: int64 description: Quantidade de dias aceita para cheques pré-datados default: 0 cxbApm: type: boolean description: Indicativo se o usuário pode alterar preparação de movimento tesouraria cxbArf: type: boolean description: Indicativo se o usuário pode alterar o rateio de movimentos da Tesouraria com o período da filial fechado cxbPgp: type: boolean description: Gerar a preparação na tesouraria (com origem na tesouraria) já processada prpOcp: type: boolean description: Gerar a preparação na tesouraria (com origem no C.Pagar) já processada excluido: type: boolean description: Indica se o registro foi excluido ? 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: Empresa type: object required: – codEmp – nomEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome excluido: type: boolean description: Indica se o registro foi excluido ? 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