2.0info: 4.2.13 fcx_calculofinanceiro description: Serviço responsável por realizar cálculos financeiros dos títulos do contas pagar/receber do fluxo de caixa x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: fcx_calculofinanceiro contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erp_finsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /fcx_calculofinanceiro/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 /fcx_calculofinanceiro/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 /fcx_calculofinanceiro/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 /fcx_calculofinanceiro/actions/atualizarValoresFinanceirosTodosTitulosPagar: post: description: Atualizar os títulos com os valores financeiros calculados de todos os títulos a pagar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoCaixaId – calcularFinanceiro – calcularImpostos properties: fluxoCaixaId: type: integer format: int64 description: Id do fluxo de caixa calcularFinanceiro: type: boolean description: Se calcula financeiro calcularImpostos: type: boolean description: Se calcula impostos parametrosFinanceiro: type: object allOf: – #/definitions/recParametrosCalculoFinanceiros description: Parametros para o cálculo financeiro parametrosImpostos: type: object allOf: – #/definitions/recParametrosCalcularImpostos description: Parametros para o cálculo de impostos vencidos: type: boolean description: Se é vencido default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_calculofinanceiro/actions/atualizarValoresFinanceirosTitulosPagar: post: description: Atualizar os títulos com os valores financeiros calculados por título a pagar tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoCaixaId – calcularFinanceiro – calcularImpostos properties: fluxoCaixaId: type: integer format: int64 description: Id do fluxo de caixa calcularFinanceiro: type: boolean description: Se calcula financeiro calcularImpostos: type: boolean description: Se calcula impostos parametrosFinanceiro: type: object allOf: – #/definitions/recParametrosCalculoFinanceiros description: Parametros para o cálculo financeiro parametrosImpostos: type: object allOf: – #/definitions/recParametrosCalcularImpostos description: Parametros para o cálculo de impostos vencidos: type: boolean description: Se é vencido default: false offSet: type: integer format: int64 description: posição dos títulos para cálculo quantidade: type: integer format: int64 description: quantidade de títulos a serem cálculados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_calculofinanceiro/actions/atualizarValoresFinanceirosTodosTitulosReceber: post: description: Atualizar os títulos com os valores financeiros calculados de todos os títulos a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoCaixaId – calcularFinanceiro – calcularImpostos properties: fluxoCaixaId: type: integer format: int64 description: Id do fluxo de caixa calcularFinanceiro: type: boolean description: Se calcula financeiro calcularImpostos: type: boolean description: Se calcula impostos parametrosFinanceiro: type: object allOf: – #/definitions/recParametrosCalculoFinanceiros description: Parametros para o cálculo financeiro parametrosImpostos: type: object allOf: – #/definitions/recParametrosCalcularImpostos description: Parametros para o cálculo de impostos vencidos: type: boolean description: Se é vencido default: false responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /fcx_calculofinanceiro/actions/atualizarValoresFinanceirosTitulosReceber: post: description: Atualizar os títulos com os valores financeiros calculados por título a receber tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – fluxoCaixaId – calcularFinanceiro – calcularImpostos properties: fluxoCaixaId: type: integer format: int64 description: Id do fluxo de caixa calcularFinanceiro: type: boolean description: Se calcula financeiro calcularImpostos: type: boolean description: Se calcula impostos parametrosFinanceiro: type: object allOf: – #/definitions/recParametrosCalculoFinanceiros description: Parametros para o cálculo financeiro parametrosImpostos: type: object allOf: – #/definitions/recParametrosCalcularImpostos description: Parametros para o cálculo de impostos vencidos: type: boolean description: Se é vencido default: false offSet: type: integer format: int64 description: posição dos títulos para cálculo quantidade: type: integer format: int64 description: quantidade de títulos a serem cálculados responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN enumOrigem: description: Origem execução type: string enum: – CONTAS_PAGAR – CONTAS_RECEBER 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 recParametrosCalculoFinanceiros: description: Estrutura que recebe o que deverá ser calculado para os valores financeiros type: object required: – dataBase – calcularJuros – calcularMulta – calcularDescontos – calcularOutrosAcrescimos – calcularCorrecaoMonetaria properties: dataBase: type: string format: date description: Data base calcularJuros: type: boolean description: Se calcula juros calcularMulta: type: boolean description: Se calcula multa calcularDescontos: type: boolean description: Se calcula desconto calcularReajuste: type: boolean description: Se calcula reajuste calcularOutrosAcrescimos: type: boolean description: Se calcula outros acrescimos calcularCorrecaoMonetaria: type: boolean description: Se calcula correção monetaria recParametrosCalcularImpostos: description: Estrutura que recebe o que deverá ser calculado para os impostos type: object required: – dataBase – iIRRF – iINSS – iISS – iCOFINS – iPIS – iCSLL – iOutrasRetencoes properties: dataBase: type: string format: date description: Data base iIRRF: type: boolean description: Se calcula IRRF iINSS: type: boolean description: Se calcula INSS iISS: type: boolean description: Se calcula ISS iCOFINS: type: boolean description: Se calcula COFINS iPIS: type: boolean description: Se calcula PIS iCSLL: type: boolean description: Se calcula CSLL iOutrasRetencoes: type: boolean description: Se tem outras retenções 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 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. 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