2.0info: 0.1.1 tcp_contaspagar x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: tcp_contaspagar contact: name: Senior X Platform url: http://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: /tcp_contaspagar/queries/obterValorFinanceiroPagar: post: description: Retorna os valores financeiros por tÃtulo a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – parametros – titulosPagar properties: parametros: type: object allOf: – #/definitions/recParametrosCalculoPagar description: Valores financeiros para cálculo titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar minimum: 1 description: Lista de tÃtulos a pagar responses: 200: description: Ok schema: type: object required: – titulosCalculadosPagar properties: titulosCalculadosPagar: type: array items: type: object allOf: – #/definitions/recTituloCalculadoPagar minimum: 1 description: TÃtulos com os valores financeiros calculados default: description: Error response schema: #/definitions/genericError get: description: Retorna os valores financeiros por tÃtulo a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: parametros in: query required: true type: object allOf: – #/definitions/recParametrosCalculoPagar – name: titulosPagar in: query required: true type: array items: type: object allOf: – #/definitions/recTituloPagar minimum: 1 responses: 200: description: Ok schema: type: object required: – titulosCalculadosPagar properties: titulosCalculadosPagar: type: array items: type: object allOf: – #/definitions/recTituloCalculadoPagar minimum: 1 description: TÃtulos com os valores financeiros calculados default: description: Error response schema: #/definitions/genericError /tcp_contaspagar/queries/obterImpostoPagar: post: description: Retorna os valores de impostos simulados dos tÃtulos a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – dataPagamento – impostos – titulosPagar properties: dataPagamento: type: string format: date description: Data que será simulado a geração dos impostos, é a data fictÃcia de um pagamento impostos: type: object allOf: – #/definitions/recImpostosPagar description: Impostos que deverão ser considerados na simulação titulosPagar: type: array items: type: object allOf: – #/definitions/recTituloPagar minimum: 1 description: TÃtulos a pagar que serão utilizados para simulação dos impostos responses: 200: description: Ok schema: type: object required: – titulosComImpostosPagar properties: titulosComImpostosPagar: type: array items: type: object allOf: – #/definitions/recTituloComImpostosPagar minimum: 1 description: Impostos calculados por tÃtulo default: description: Error response schema: #/definitions/genericError get: description: Retorna os valores de impostos simulados dos tÃtulos a pagar tags: – Queries x-senior-visibility: PRIVATE parameters: – name: dataPagamento in: query required: true type: string format: date – name: impostos in: query required: true type: object allOf: – #/definitions/recImpostosPagar – name: titulosPagar in: query required: true type: array items: type: object allOf: – #/definitions/recTituloPagar minimum: 1 responses: 200: description: Ok schema: type: object required: – titulosComImpostosPagar properties: titulosComImpostosPagar: type: array items: type: object allOf: – #/definitions/recTituloComImpostosPagar minimum: 1 description: Impostos calculados por tÃtulo default: description: Error response schema: #/definitions/genericError /tcp_contaspagar/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /tcp_contaspagar/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError definitions: 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 recParametrosCalculoPagar: 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: calcularJuros: type: boolean description: calcularMulta: type: boolean description: calcularDescontos: type: boolean description: calcularReajuste: type: boolean description: calcularOutrosAcrescimos: type: boolean description: calcularCorrecaoMonetaria: type: boolean description: recTituloPagar: description: Estrutura básica para o cálculo financeiro do tÃtulo a pagar discriminator: _discriminator type: object required: – empresa – filial – titulo – tipoTitulo – fornecedor – valorAberto – _discriminator properties: empresa: type: integer format: int64 description: filial: type: integer format: int64 description: titulo: type: string description: tipoTitulo: type: string description: fornecedor: type: integer format: int64 description: valorAberto: type: number format: double description: valorDesconto: type: number format: double description: _discriminator: type: string description: recTituloCalculadoPagar: description: Estrutra que retorna os valores financeiros do tÃtulo allOf: – #/definitions/recTituloPagar – type: object required: – valorLiquido properties: valorJuros: type: number format: double description: valorMulta: type: number format: double description: valorCorrecao: type: number format: double description: valorDescontos: type: number format: double description: valorEncargos: type: number format: double description: valorOutrosAcrescimos: type: number format: double description: valorOutrosDescontos: type: number format: double description: valorLiquido: type: number format: double description: recImpostosPagar: description: Estrutura que armazena quais impostos deverão ser simulados type: object required: – iIRRF – iINSS – iISS – iCOFINS – iPIS – iCSLL – iOutrasRetencoes properties: iIRRF: type: boolean description: iINSS: type: boolean description: iISS: type: boolean description: iCOFINS: type: boolean description: iPIS: type: boolean description: iCSLL: type: boolean description: iOutrasRetencoes: type: boolean description: recValorImpostosPagar: description: Estrutura que retorna os valores dos impostos calculados type: object required: – valorLiquido properties: valorIRRF: type: number format: double description: valorINSS: type: number format: double description: valorISS: type: number format: double description: valorCOFINS: type: number format: double description: valorPIS: type: number format: double description: valorCSLL: type: number format: double description: valorOutrasRetencoes: type: number format: double description: valorLiquido: type: number format: double description: recTituloComImpostosPagar: description: Estrutura que armazena os impostos calculados por tÃtulo a pagar type: object required: – tituloPagar – valoresImpostos properties: tituloPagar: type: object allOf: – #/definitions/recTituloPagar description: valoresImpostos: type: object allOf: – #/definitions/recValorImpostosPagar description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: 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 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