2.0info: 3.0.0 Finanças – Controle de saldos da tesouraria description: Serviço de controle de saldos da tesouraria x-senior-domain: ERPX x-senior-domain-path: erpx_fin x-senior-service-path: tes_saldos 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: /tes_saldos/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 /tes_saldos/queries/obterSaldosContasInternas: post: description: Primitiva que retorna o saldos das contas internas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – periodoInicial – periodoFinal properties: empresaId: type: array items: type: string description: Filtro por empresa tipoContaId: type: array items: type: string description: Filtro por tipo de conta contaInternaId: type: array items: type: string description: Filtro por conta interna periodoInicial: type: string format: date description: Filtro por período inicial do movimento periodoFinal: type: string format: date description: Filtro por período final do movimento transacaoId: type: array items: type: string description: Filtro por transação do movimento modalidadeMovimentoTesouraria: type: string allOf: – #/definitions/enumModalidadeMovimentoTesouraria description: Indicativo da busca do movimento (por data de liberação ou por data de movimento) buscarSaldo: type: string allOf: – #/definitions/enumBuscarSaldo description: Tipo de saldo a ser retornado valorInicial: type: string description: Filtro por valor – Faixa inicial valorFinal: type: string description: Filtro por valor – Faixa final naturezaMovimento: type: string allOf: – #/definitions/enumNatureza description: Filtro por natureza de movimento documento: type: array items: type: string description: Filtro por documento numeroCheque: type: array items: type: integer format: int64 description: Filtro por número de cheque pageRequest: type: object allOf: – #/definitions/recPageRequest description: Controle de paginação responses: 200: description: Ok schema: type: object required: – total – saldos properties: total: type: integer format: int64 description: Quantidade de saldos a paginar saldos: type: array items: type: object allOf: – #/definitions/recSaldoContaInterna minimum: 1 description: Saldos retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/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 /tes_saldos/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 /tes_saldos/queries/exportE600cco: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/queries/exportE600mes: 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 /tes_saldos/queries/exportE600mcc: 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 /tes_saldos/queries/exportControleProcessoDadosSaldoTesouraria: 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 /tes_saldos/queries/exportControleProcessoItemSaldoTesouraria: 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 /tes_saldos/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 /tes_saldos/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 /tes_saldos/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 /tes_saldos/actions/importE600cco: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/actions/importE600mes: 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 /tes_saldos/actions/importE600mcc: 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 /tes_saldos/actions/importControleProcessoDadosSaldoTesouraria: 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 /tes_saldos/actions/importControleProcessoItemSaldoTesouraria: 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 /tes_saldos/signals/updateAccountBalance: post: description: Atualiza o saldo mensal da conta tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – movementData properties: movementData: type: array items: type: object allOf: – #/definitions/recAccountMovement minimum: 1 description: Dados do movimento da conta controlProcessId: type: string description: Ticket responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tes_saldos/signals/updateAccountBalanceByTesouraria: post: description: Atualiza o saldo mensal da conta – processo origem tesouraria tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – movementData properties: movementData: type: array items: type: object allOf: – #/definitions/recAccountMovement minimum: 1 description: Dados do movimento da conta controlProcessId: type: string description: Ticket callback: type: object allOf: – #/definitions/callback description: Serviço de Retorno quando o processo for finalizado responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tes_saldos/signals/updateAccountBalanceByContasPagar: post: description: Atualiza o saldo mensal da conta – processo origem contas pagar tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – movementData properties: movementData: type: array items: type: object allOf: – #/definitions/recAccountMovement minimum: 1 description: Dados do movimento da conta controlProcessId: type: string description: Ticket responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tes_saldos/signals/updateAccountBalanceByContasReceber: post: description: Atualiza o saldo mensal da conta – processo origem contas receber tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – movementData properties: movementData: type: array items: type: object allOf: – #/definitions/recAccountMovement minimum: 1 description: Dados do movimento da conta controlProcessId: type: string description: Ticket responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tes_saldos/signals/recalculoSaldosContaInterna: post: description: Primitiva que refaz os saldos da conta interna de acordo com os movimentos na tesouraria tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – contaInternaId properties: contaInternaId: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceFinished: post: description: Evento disparado quando a atualização o saldo mensal da conta é finalizado com sucesso x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId properties: controlProcessId: type: string description: Ticket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceError: post: description: Evento disparado quando ocorre algum erro ao atualizar o saldo mensal da conta x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – message properties: controlProcessId: type: string description: Ticket message: type: string description: Mensagem de erro ao atualizar o saldo da conta stackTrace: type: string description: Stack Trace responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceFinishedByTesouraria: post: description: Evento disparado quando a atualização o saldo mensal da conta é finalizado com sucesso – processo origem tesouraria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId properties: controlProcessId: type: string description: Ticket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceErrorByTesouraria: post: description: Evento disparado quando ocorre algum erro ao atualizar o saldo mensal da conta – processo origem tesouraria x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – message properties: controlProcessId: type: string description: Ticket message: type: string description: Mensagem de erro ao atualizar o saldo da conta stackTrace: type: string description: Stack Trace responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceFinishedByContasPagar: post: description: Evento disparado quando a atualização o saldo mensal da conta é finalizado com sucesso – processo origem contas pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId properties: controlProcessId: type: string description: Ticket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceErrorByContasPagar: post: description: Evento disparado quando ocorre algum erro ao atualizar o saldo mensal da conta – processo origem contas pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – message properties: controlProcessId: type: string description: Ticket message: type: string description: Mensagem de erro ao atualizar o saldo da conta stackTrace: type: string description: Stack Trace responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceFinishedByContasReceber: post: description: Evento disparado quando a atualização o saldo mensal da conta é finalizado com sucesso – processo origem contas pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId properties: controlProcessId: type: string description: Ticket responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/updateAccountBalanceErrorByContasReceber: post: description: Evento disparado quando ocorre algum erro ao atualizar o saldo mensal da conta – processo origem contas pagar x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – controlProcessId – message properties: controlProcessId: type: string description: Ticket message: type: string description: Mensagem de erro ao atualizar o saldo da conta stackTrace: type: string description: Stack Trace responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/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 /tes_saldos/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 /tes_saldos/events/importE600ccoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/exportE600ccoEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /tes_saldos/events/importE600mesEvent: 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 /tes_saldos/events/exportE600mesEvent: 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 /tes_saldos/events/importE600mccEvent: 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 /tes_saldos/events/exportE600mccEvent: 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 /tes_saldos/events/importControleProcessoDadosSaldoTesourariaEvent: 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 /tes_saldos/events/exportControleProcessoDadosSaldoTesourariaEvent: 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 /tes_saldos/events/importControleProcessoItemSaldoTesourariaEvent: 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 /tes_saldos/events/exportControleProcessoItemSaldoTesourariaEvent: 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 /tes_saldos/entities/e070emp: 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/e070emp responses: 200: description: The created resource schema: #/definitions/e070emp 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/e070emp responses: 200: description: The created resource schema: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/e070emp/{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/editE070emp responses: 200: description: Ok schema: #/definitions/editE070emp 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/e070emp responses: 200: description: Ok schema: #/definitions/e070emp 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/e070emp 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 /tes_saldos/entities/e070emp/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e070emp responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/e600cco: 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/e600cco responses: 200: description: The created resource schema: #/definitions/e600cco 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/e600cco responses: 200: description: The created resource schema: #/definitions/e600cco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e600cco 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/e600cco/{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/editE600cco responses: 200: description: Ok schema: #/definitions/editE600cco 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/e600cco responses: 200: description: Ok schema: #/definitions/e600cco 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/e600cco 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 /tes_saldos/entities/e600cco/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e600cco responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/e600mes: 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/e600mes responses: 200: description: The created resource schema: #/definitions/e600mes 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/e600mes responses: 200: description: The created resource schema: #/definitions/e600mes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e600mes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/e600mes/{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/editE600mes responses: 200: description: Ok schema: #/definitions/editE600mes 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/e600mes responses: 200: description: Ok schema: #/definitions/e600mes 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/e600mes 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 /tes_saldos/entities/e600mes/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e600mes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/controleProcessoDadosSaldoTesouraria: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/controleProcessoDadosSaldoTesouraria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /tes_saldos/entities/controleProcessoItemSaldoTesouraria: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/controleProcessoItemSaldoTesouraria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumDebCre: type: string enum: – VD – VC description: Enumeração débito/crédito: * `VD` – Débito * `VC` – Crédito enumSitMov: type: string enum: – VA – VI description: Enumeração situação do movimento: * `VA` – Ativo * `VI` – Inativo enumNatureza: type: string enum: – CREDITO – DEBITO – TODOS description: Filtrar por natureza: * `CREDITO` – Filtrar somente créditos * `DEBITO` – Filtrar somente débitos * `TODOS` – Filtrar ambos enumStatusControleProcesso: type: string enum: – PENDENTE – PROCESSANDO – SUCESSO – ERROR enumTypeOrder: type: string enum: – ASC – DESC description: Enumeração para o tipo de ordenação: * `ASC` – Tipo de ordenação – Crescente * `DESC` – Tipo de ordenação – Decrescente enumBuscarSaldo: type: string enum: – CONCILIADOS – NAO_CONCILIADOS – SO_SALDOS – TODOS enumModalidadeMovimentoTesouraria: type: string enum: – LIBERACAO – MOVIMENTO enumSitReg: type: string enum: – VA – VI enumTipCnc: type: string enum: – VA – VM enumOriMcc: type: string enum: – VCR – VCP – VCM – VCH – VOU enumTipoSaldo: type: string enum: – SALDO_ANTERIOR – SALDO_ATUAL – MOVIMENTO userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recAccountMovement: description: Record com os dados do movimento da conta type: object required: – e600ccoId – vlrMov – vlrMoe – debCre – datMov – sitMov properties: e600ccoId: type: string description: Id da conta interna vlrMov: type: string description: Valor Movimento minimum: 0.00 maximum: 9999999999999.99 vlrMoe: type: string description: Valor Movimento em moeda estrangeira minimum: 0.00 maximum: 9999999999999.99 debCre: type: string allOf: – #/definitions/enumDebCre description: Débito/Crédito datMov: type: string format: date description: Data Movimento datLib: type: string format: date description: Data Liberação sitMov: type: string allOf: – #/definitions/enumSitMov description: Situação do movimento identificadorRegistro: type: string description: Identificador de controle do Registro recPageRequest: description: type: object required: – offset – size properties: offset: type: integer format: int64 description: size: type: integer format: int64 description: orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: description: Define o registro com os dados dos campos à serem ordenados type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recSaldoContaInterna: description: Estrutura de saldo da conta interna type: object required: – data – movimento – saldoDisponivel – saldoAcumulado – saldoDisponivelMoeda – saldoAcumuladoMoeda properties: data: type: string format: date description: Data atual movimnetação movimento: type: object allOf: – #/definitions/recMovimentoTesourariaConsulta description: Movimento tipoSaldo: type: string allOf: – #/definitions/enumTipoSaldo description: Tipo de de saldo saldoDisponivel: type: string description: Saldo disponível dos movimentos saldoAcumulado: type: string description: Saldo acumulado dos movimentos saldoDisponivelMoeda: type: string description: Saldo disponível dos movimentos na moeda da conta saldoAcumuladoMoeda: type: string description: Saldo acumulado dos movimentos na moeda da conta recMovimentoTesourariaConsulta: description: Movimento gerado na tesouraria type: object required: – empresa – filial – contaInterna – transacao – dataMovimento – dataLiberacao – dataContabil – natureza – valorMovimento – informacoesAdicionaisTesouraria properties: id: type: string description: Identificador do movimento empresa: type: object allOf: – #/definitions/recGenerico description: Informação da empresa filial: type: object allOf: – #/definitions/recGenerico description: Filial contaInterna: type: object allOf: – #/definitions/recGenerico description: Conta interna utilizada transacao: type: object allOf: – #/definitions/recGenerico description: Transação utilizada dataMovimento: type: string format: date description: Data do movimento de transferência dataLiberacao: type: string format: date description: Data da liberação dataContabil: type: string format: date description: Data contábil natureza: type: string allOf: – #/definitions/enumDebCre description: Natureza do movimento (Débito/Crédito) valorMovimento: type: string description: Valor do movimento informacoesAdicionaisTesouraria: type: object allOf: – #/definitions/recInformacoesAdicionaisMovimentoTesourariaConsulta description: Informações adicionais do movimento da tesouraria conciliado: type: boolean description: Indicativo se o movimento está conciliado recInformacoesAdicionaisMovimentoTesourariaConsulta: description: Informações adicionais do movimento da tesouraria type: object required: – origemMovimento – tipoMovimento – lancadoPlanoFinanceiro – situacaoMovimento – usuarioGerador – dataGeracao properties: origemMovimento: type: string allOf: – #/definitions/enumOriMcc description: Origem do movimento tipoMovimento: type: string allOf: – #/definitions/enumTipCnc description: Tipo de movimento numeroCheque: type: integer format: int64 description: Número do cheque naturezaGasto: type: object allOf: – #/definitions/recGenerico description: Informação da natureza de gasto tipoDocumento: type: object allOf: – #/definitions/recGenerico description: Indicativo do tipo de documento numeroDocumento: type: string maxLength: 20 description: Número do documento do movimento historico: type: string maxLength: 100 description: Histórico do movimento complemento: type: string maxLength: 100 description: Complemento do histórico do movimento observacao: type: string maxLength: 250 description: Observação do movimento nomeRecebedor: type: string maxLength: 100 description: Nome do recebedor do cheque loteContabil: type: integer format: int64 description: Número do lote contábil lancadoPlanoFinanceiro: type: boolean description: Lançado no plano financeiro situacaoMovimento: type: string allOf: – #/definitions/enumSitReg description: Situacao valoresMovimentoTesourariaMoedaEstrangeira: type: object allOf: – #/definitions/recValoresMovimentoTesourariaMoedaEstrangeira description: Informações do movimento da tesouraria em moeda estrangeira rateio: type: object allOf: – #/definitions/recRateioGenerico description: Informações rateio conciliado: type: boolean description: Indicativo se o movimento está conciliado usuarioGerador: type: string description: Usuário que realizou o movimento dataGeracao: type: string format: date-time description: Data da geração do movimento recValoresMovimentoTesourariaMoedaEstrangeira: description: Informações do movimento da tesouraria em moeda estrangeira type: object required: – valorDataMovimento – cotacaoDataMovimento – valorDataLiberacao – cotacaoDataLiberacao properties: valorDataMovimento: type: string description: Valor do movimento na moeda estrangeria na data de movimento cotacaoDataMovimento: type: string description: Valor da cotação do movimento na moeda estrangeria na data de movimento valorDataLiberacao: type: string description: Valor do movimento na moeda estrangeria na data de liberação cotacaoDataLiberacao: type: string description: Valor da cotação do movimento na moeda estrangeria na data de liberação recRateioGenerico: description: Indicativo das informações para geração de rateio type: object properties: projeto: type: object allOf: – #/definitions/recGenerico description: Indicativo do projeto faseProjeto: type: object allOf: – #/definitions/recGenerico description: Indicativo da fase do projeto contaFinanceira: type: object allOf: – #/definitions/recGenerico description: Indicativo da conta financeira contaContabil: type: object allOf: – #/definitions/recGenerico description: Indicativo da conta contábil centroCustos: type: object allOf: – #/definitions/recGenerico description: Indicativo do centro de custos recGenerico: description: Record para retorno das informações principais de uma entidade type: object required: – id – label – codigo – descricao properties: id: type: string description: Identificador da entidade label: type: string description: Descrição do label codigo: type: string description: Código de negócio descricao: type: string description: Descrição de negócio callback: description: Record que contem qual primitiva será chamada no final do processo type: object required: – dominio – servico – primitiva properties: dominio: type: string description: Dominio da primitiva servico: type: string description: Service da primitiva primitiva: type: string description: Nome da primitiva infoCallback: description: Record com os dados do callback type: object required: – controlProcessId – movimentoRetorno properties: controlProcessId: type: string description: Identificador do processo movimentoRetorno: type: array items: type: object allOf: – #/definitions/dadosCallback minimum: 1 description: Informações do callback dadosCallback: description: Record responsável pelo corpo do callback type: object required: – identificadorRegistro – e600ccoId – ocorreuErro properties: identificadorRegistro: type: string description: Identificador de controle do Registro e600ccoId: type: string description: Identificador da conta interna ocorreuErro: type: boolean description: Indicativo se ocorreu algum erro no processo mensagemErro: type: string description: Mensagem de Erro 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: Código da empresa maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 10 description: Nome fantasia da empresa usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE070emp: type: object required: – id allOf: – #/definitions/e070emp e600cco: description: Tesouraria – Conta – Cadastro type: object required: – e070emp – numCco – desCco – abrCco properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Código da empresa numCco: type: string maxLength: 14 description: Número da Conta Interna desCco: type: string maxLength: 30 description: Descrição da conta interna abrCco: type: string maxLength: 10 description: Abreviatura da conta interna usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE600cco: type: object required: – id allOf: – #/definitions/e600cco e600mes: description: Tesouraria – Movimento – Controle dos Saldos Mensais das Contas type: object required: – e600cco – datCmp properties: id: type: string format: uuid description: Id da entidade e600cco: type: object allOf: – #/definitions/e600cco description: Número da conta interna datCmp: type: string format: date description: Mês e ano de competência para os saldos da conta salAnt: type: string description: Saldo do mês anterior maximum: 999999999999999.99 creMes: type: string description: Valor dos créditos do mês maximum: 999999999999999.99 debMes: type: string description: Valor dos débitos do mês maximum: 999999999999999.99 salMes: type: string description: Saldo do mês maximum: 999999999999999.99 disAnt: type: string description: Saldo disponível do mês anterior maximum: 999999999999999.99 disCre: type: string description: Valor dos créditos disponíveis do mês maximum: 999999999999999.99 disDeb: type: string description: Valor dos débitos disponíveis do mês maximum: 999999999999999.99 disMes: type: string description: Saldo disponível do mês maximum: 999999999999999.99 salAnm: type: string description: Saldo do mês anterior na moeda da conta maximum: 999999999999999.99 creMem: type: string description: Valor dos créditos do mês na moeda da conta maximum: 999999999999999.99 debMem: type: string description: Valor dos débitos do mês na moeda da conta maximum: 999999999999999.99 salMem: type: string description: Saldo do mês na moeda da conta maximum: 999999999999999.99 disAnm: type: string description: Saldo disponível do mês anterior na moeda da conta maximum: 999999999999999.99 disCrm: type: string description: Valor dos créditos disponíveis do mês na moeda da conta maximum: 999999999999999.99 disDem: type: string description: Valor dos débitos disponíveis do mês na moeda da conta maximum: 999999999999999.99 disMem: type: string description: Saldo disponível do mês na moeda da conta maximum: 999999999999999.99 salAnb: type: string description: Saldo Mês Anterior Bloqueado maximum: 999999999999999.99 creMeb: type: string description: Valor Créditos Mês Bloqueados maximum: 999999999999999.99 debMeb: type: string description: Valor Débitos Mês Bloqueados maximum: 999999999999999.99 salMeb: type: string description: Saldo do Mês Bloqueado maximum: 999999999999999.99 disAnb: type: string description: Saldo Disponível Anterior Bloqueado maximum: 999999999999999.99 disCrb: type: string description: Valor Créditos Disponíveis Bloqueados maximum: 999999999999999.99 disDbb: type: string description: Valor Débitos Disponíveis Bloqueados maximum: 999999999999999.99 disMeb: type: string description: Saldo Disponível Mês Bloqueado maximum: 999999999999999.99 salAmb: type: string description: Saldo Mês Anterior Moeda Bloqueado maximum: 999999999999999.99 creMmb: type: string description: Valor Créditos Mês Moeda Bloqueados maximum: 999999999999999.99 debMmb: type: string description: Valor Débitos Mês Moeda Bloqueados maximum: 999999999999999.99 salMmb: type: string description: Saldo do Mês Moeda Bloqueado maximum: 999999999999999.99 disAmb: type: string description: Saldo Disponível Anterior Moeda Bloqueado maximum: 999999999999999.99 disCmb: type: string description: Valor Créditos Disponíveis Moeda Bloqueados maximum: 999999999999999.99 disDmb: type: string description: Valor Débitos Disponíveis Moeda Bloqueados maximum: 999999999999999.99 disMmb: type: string description: Saldo Disponível Mês Moeda Bloqueado maximum: 999999999999999.99 usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editE600mes: type: object required: – id allOf: – #/definitions/e600mes e600mcc: description: Tesouraria – Movimento – Movimentações das Contas type: object required: – e070emp – e600cco – datMov – oriMcc – vlrMov – debCre – lctFin properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e600cco: type: object allOf: – #/definitions/e600cco description: Conta Interna datMov: type: string format: date description: Data Movimento oriMcc: type: string allOf: – #/definitions/enumOriMcc description: Origem datCtb: type: string format: date description: Data Contábil datLib: type: string format: date description: Data Liberação docMov: type: string maxLength: 20 description: Nº Documento hisMov: type: string maxLength: 100 description: Histórico Movimento nroChe: type: integer format: int64 description: Número Cheque minimum: 0 maximum: 999999 vlrMov: type: string description: Valor Movimento minimum: 0.00 maximum: 9999999999999.99 debCre: type: string allOf: – #/definitions/enumDebCre description: Débito/Crédito vlrMoe: type: string description: Valor Movimento na Moeda da Conta (Mov) minimum: 0.00 maximum: 9999999999999.99 cotMov: type: string description: Cotação Moeda Movimento minimum: 0.00 maximum: 999999999.9999999999 cgcCpf: type: string description: CNPJ/CPF nomRec: type: string maxLength: 100 description: Recebedor cplMov: type: string maxLength: 100 description: Complemento sitMcc: type: string allOf: – #/definitions/enumSitReg description: Situação obsMcc: type: string maxLength: 250 description: Observação tipMcc: type: string allOf: – #/definitions/enumTipCnc description: Tipo Movimento numLot: type: integer format: int64 description: Nº Lote Contábil minimum: 0 maximum: 999999999 lctFin: type: boolean description: Lançado Plano Financeiro vlrPis: type: string description: Valor PIS Recuperar minimum: -999999999999.99 maximum: 999999999999.99 vlrBpr: type: string description: Base/Valor PIS Recuperar minimum: 0.00 maximum: 9999999999999.99 vlrCof: type: string description: Valor Cofins Recuperar minimum: -999999999999.99 maximum: 999999999999.99 vlrBcr: type: string description: Base/Valor Cofins Recuperar minimum: 0.00 maximum: 9999999999999.99 numRem: type: string maxLength: 15 description: Número Movimento Banco e039por: type: string format: uuid description: Portador numArb: type: integer format: int64 description: Nº Arquivo Banco minimum: 0 maximum: 999999999 datRem: type: string format: date description: Data Remessa cotLib: type: string description: Cotação Moeda Liberação minimum: 0.00 maximum: 999999999.9999999999 vlrMol: type: string description: Valor Movimento na Moeda da Conta (Lib) minimum: 0.00 maximum: 9999999999999.99 intImp: type: boolean description: Integrado gestão tributos indEsp: type: boolean description: Indicativo estorno parcial fatoFinanceiro: type: string format: uuid description: Identificador do fato financeiro cebLoteConciliacaoId: type: string format: uuid description: Identificador lote conciliado usuEst: type: string maxLength: 255 description: Usuário que estornou o movimento dthEst: type: string format: date-time description: Data e hora que foi estornado o movimento excluido: type: boolean description: Indica se o registro foi excluído default: false intCtb: type: boolean description: Indicativo de integração contábil default: false e640lotId: type: string format: uuid description: Identificador do lote contábil gerado usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: controleProcessoDadosSaldoTesouraria: description: Tabela de controle de processo geral do saldo da tesouraria type: object required: – assyncTransationsId – status – dominio – servico – primitiva properties: id: type: string format: uuid description: Identificador do movimento assyncTransationsId: type: string description: Identificador do assyncTransarions desse processo status: type: string allOf: – #/definitions/enumStatusControleProcesso description: Status dominio: type: string description: Domain do callback servico: type: string description: service primitiva: type: string description: primitiva usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: controleProcessoItemSaldoTesouraria: description: Tabela de controle de processo dos itens do saldo da tesouraria type: object required: – controleProcessoDadosId – controleId – status properties: id: type: string format: uuid description: Identificador do movimento controleProcessoDadosId: type: string format: uuid description: Identificador do controleProcessoDados desse processo controleId: type: string description: Identificador do registro do processo e600ccoId: type: string format: uuid description: Identificador da Conta Interna status: type: string allOf: – #/definitions/enumStatusControleProcesso description: Status mensagemErro: type: string description: Mensagem de Erro usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage