2.0info: 1.0.0 ctb_integracoes x-senior-domain: erp_ctb x-senior-domain-path: erp_ctb x-senior-service-path: ctb_integracoes 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_ctbsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /ctb_integracoes/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 description: 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 /ctb_integracoes/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 /ctb_integracoes/signals/integrarLancamentosContabeis: post: description: Gerar os lançamentos contabeis na Gestão da Contabilidade a partir de movimentos das demais gestões do ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – parametros – modulos properties: parametros: type: object allOf: – #/definitions/recParametros description: modulos: type: object allOf: – #/definitions/recParamentrosModulos description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: enummodulosIntegracaoContabil: description: Tipos de integração disponÃvel type: string enum: – NotaFiscalVenda – FaturaVenda – NotaFiscalCompra – FaturaCompra – Estoque – ContasReceber – ContasPagar – Tesouraria – Comissoes – ContasReceberAjusteFinanceiro – ContasPagarAjusteFinanceiro – ContaCapital – Patrimonio – NotaFiscalSaida – NotaFiscalEntrada – ReducaoZ – OutrosDocumentos – ApuracaoImpostos 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 recParametros: description: Lista de parâmetros type: object required: – codigoEmpresa – codigoFilial – loteDiario properties: codigoEmpresa: type: integer format: int64 description: codigoFilial: type: integer format: int64 description: loteDiario: type: boolean description: recModulos: description: Modulos a serem integrados e suas respectivas transações type: object required: – tipo properties: codigosTransacoes: type: string description: ignorarTransacoes: type: boolean description: tipo: type: string allOf: – #/definitions/enummodulosIntegracaoContabil description: recParamentrosModulos: description: Lista de módulos que serão integrados para a contabilidade type: object required: – periodoInicial – periodoFinal – listaModulos properties: periodoInicial: type: string format: date description: periodoFinal: type: string format: date description: listaModulos: type: array items: type: object allOf: – #/definitions/recModulos minimum: 1 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 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