foundation

2.0info: 2.7.0 foundation description: Serviço base do banking x-senior-domain: Domínio base do banking x-senior-domain-path: erpx_bnk x-senior-service-path: foundation 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_bnksecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /foundation/queries/healthcheck: post: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE 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 checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/queries/listServiceStatusReceivable: post: description: API responsável pelo retorno se o cliente possui a conta bancária implantada no banking\n### Resources\n- res : //senior.com.br/erpx_bnk/foundation/queries/listServiceStatusReceivable tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/recFilterListServiceStatusReceivable description: Filtro responses: 200: description: Ok schema: type: object properties: serviceAvailable: type: array items: type: object allOf: – #/definitions/recServiceReceivable description: Serviços disponíveis 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /foundation/queries/checkBankServiceEnabled: post: description: API responsável pelo retorno se o serviço bancário está habilitado para o banco\n### Resources\n- res : //senior.com.br/erpx_bnk/foundation/queries/checkBankServiceEnabled tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – bankCode – bankService properties: bankCode: type: string maxLength: 3 description: Código do banco bankService: type: string allOf: – #/definitions/enumBankService description: Tipo de serviço bancário responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Indica se o serviço está habilitado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado pelo código do banco default: description: Error response schema: #/definitions/genericError get: description: API responsável pelo retorno se o serviço bancário está habilitado para o banco\n### Resources\n- res : //senior.com.br/erpx_bnk/foundation/queries/checkBankServiceEnabled tags: – Queries x-senior-visibility: PUBLIC parameters: – name: bankCode description: Código do banco in: query required: true type: string maxLength: 3 – name: bankService description: Tipo de serviço bancário in: query required: true type: string allOf: – #/definitions/enumBankService responses: 200: description: Ok schema: type: object required: – enabled properties: enabled: type: boolean description: Indica se o serviço está habilitado 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado pelo código do banco default: description: Error response schema: #/definitions/genericError /foundation/queries/checkPaymentServicesEnabled: post: description: API responsável pelo retorno de quais serviços bancários de pagamento estão habilitados para o banco\n### Resources\n- res : //senior.com.br/erpx_bnk/foundation/queries/checkPaymentServicesEnabled tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – bankCode properties: bankCode: type: string maxLength: 3 description: Código do banco responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: string allOf: – #/definitions/enumBankService minimum: 1 description: Lista de serviços de pagamento habilitados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado pelo código do banco default: description: Error response schema: #/definitions/genericError get: description: API responsável pelo retorno de quais serviços bancários de pagamento estão habilitados para o banco\n### Resources\n- res : //senior.com.br/erpx_bnk/foundation/queries/checkPaymentServicesEnabled tags: – Queries x-senior-visibility: PRIVATE parameters: – name: bankCode description: Código do banco in: query required: true type: string maxLength: 3 responses: 200: description: Ok schema: type: object required: – services properties: services: type: array items: type: string allOf: – #/definitions/enumBankService minimum: 1 description: Lista de serviços de pagamento habilitados 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Registro não localizado pelo código do banco default: description: Error response schema: #/definitions/genericError /foundation/queries/getCredenciaisESales: post: description: Primitiva responsável por retornar as credenciais para a autenticação da API da eSales tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – producaoHabilitada properties: clientId: type: string description: ClientId clientSecret: type: string description: ClientSecret producaoHabilitada: type: boolean description: Indicativo se está habilitado a chamada para os endpoints de produção 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Primitiva responsável por retornar as credenciais para a autenticação da API da eSales tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – producaoHabilitada properties: clientId: type: string description: ClientId clientSecret: type: string description: ClientSecret producaoHabilitada: type: boolean description: Indicativo se está habilitado a chamada para os endpoints de produção 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /foundation/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 /foundation/queries/exportServicosBancarios: 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 /foundation/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 /foundation/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 /foundation/actions/importServicosBancarios: 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 /foundation/events/importServicosBancariosEvent: 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 /foundation/events/exportServicosBancariosEvent: 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 /foundation/entities/servicosBancarios: 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/servicosBancarios 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 enumServiceType: type: string enum: – PIX_QRCODE – COBRANCA_BOLETO – COBRANCA_BOLEPIX description: Tipo de serviço de cobrança: * `PIX_QRCODE` – PIX QRCode * `COBRANCA_BOLETO` – Cobrança Boleto * `COBRANCA_BOLEPIX` – Cobrança BolePix enumTipoServico: type: string enum: – PIX_QRCODE – COBRANCA_BOLETO – COBRANCA_BOLEPIX description: Tipo de serviço de cobrança: * `PIX_QRCODE` – PIX QRCode * `COBRANCA_BOLETO` – Cobrança Boleto * `COBRANCA_BOLEPIX` – Cobrança BolePix enumStatusApi: type: string enum: – ACTIVE – INACTIVE – NOT_DEPLOYED description: Situação do serviço: * `ACTIVE` – Ativo * `INACTIVE` – Inativo * `NOT_DEPLOYED` – Não implantado enumStatus: type: string enum: – ATIVO – INATIVO – NAO_IMPLANTADO description: Situação do serviço: * `ATIVO` – Ativo * `INATIVO` – Inativo * `NAO_IMPLANTADO` – Não implantado enumReceivableBank: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO – BTG_PACTUAL – CEF – SICREDI – BANCO_ABC description: Enumeration de bancos de recebimento: * `ITAU` – Itaú – 341 * `SANTANDER` – Santander – 033 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BRADESCO` – Bradesco – 237 * `BTG_PACTUAL` – BTG Pactual – 208 * `CEF` – Caixa Econômica Federal – 104 * `SICREDI` – Sicredi – 748 * `BANCO_ABC` – Banco ABC – 246 enumBancoRecebimento: type: string enum: – ITAU – SANTANDER – BANCO_DO_BRASIL – BRADESCO – BTG_PACTUAL – CEF – SICREDI – BANCO_ABC description: Enumeration de bancos de recebimento: * `ITAU` – Itaú – 341 * `SANTANDER` – Santander – 033 * `BANCO_DO_BRASIL` – Banco do Brasil – 001 * `BRADESCO` – Bradesco – 237 * `BTG_PACTUAL` – BTG Pactual – 208 * `CEF` – Caixa Econômica Federal – 104 * `SICREDI` – Sicredi – 748 * `BANCO_ABC` – Banco ABC – 246 enumBankService: type: string enum: – BILLING_PIX_DUEDATE – BILLING_BANKSLIP – BILLING_PIX – BILLING_BOLEPIX – PAYMENT_BANKSLIP – PAYMENT_PIX_TRANSFER – PAYMENT_PIX_QRCODE – PAYMENT_DARF – PAYMENT_PAYROLL 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 recServiceReceivable: description: Serviço e situação type: object required: – status – servicesTypes – receivableBank properties: status: type: string allOf: – #/definitions/enumStatusApi description: Status servicesTypes: type: array items: type: string allOf: – #/definitions/enumServiceType minimum: 1 description: Tipos de serviços pixKey: type: string description: Chave pix receivableBank: type: string allOf: – #/definitions/enumReceivableBank description: Banco do recebimento branchNumber: type: string maxLength: 5 description: Número da agência branchDigit: type: string maxLength: 2 description: Dígito da agência accountNumber: type: string maxLength: 12 description: Número da conta accountDigit: type: string maxLength: 2 description: Dígito da conta recFilterListServiceStatusReceivable: description: Record com os filtros disponíveis para consulta de serviços disponíveis para a cobrança type: object required: – documentNumber properties: documentNumber: type: string maxLength: 14 description: Documento do recebedor servicesTypes: type: array items: type: string allOf: – #/definitions/enumServiceType description: Tipos de serviços pixKey: type: string description: Chave pix receivableBank: type: string allOf: – #/definitions/enumReceivableBank description: Banco do recebimento branchNumber: type: string maxLength: 5 description: Número da agência branchDigit: type: string maxLength: 2 description: Dígito da agência accountNumber: type: string maxLength: 12 description: Número da conta accountDigit: type: string maxLength: 2 description: Dígito da conta servicosBancarios: description: Armazena as informações dos bancos e os serviços bancários disponíveis type: object required: – codBanco – nomeBanco – cobPixVencimento – cobPix – cobBoleto – cobBolePix – pagBoleto – pagPixTransfer – pagPixQRCode – pagDarf – pagSalario properties: id: type: string format: uuid description: Id da entidade codBanco: type: string maxLength: 3 description: Código do banco nomeBanco: type: string maxLength: 100 description: Nome do banco cobPixVencimento: type: boolean description: Indica se o banco aceita cobrança PIX com data de vencimento específica cobPix: type: boolean description: Indica se o banco aceita cobrança PIX cobBoleto: type: boolean description: Indica se o banco aceita cobrança Boleto cobBolePix: type: boolean description: Indica se o banco aceita cobrança BolePix pagBoleto: type: boolean description: Indica se o banco aceita pagamento de Boleto pagPixTransfer: type: boolean description: Indica se o banco aceita pagamento PIX por transferência pagPixQRCode: type: boolean description: Indica se o banco aceita pagamento PIX por QRCode pagDarf: type: boolean description: Indica se o banco aceita pagamento DARF pagSalario: type: boolean description: Indica se o banco aceita pagamento SALARIO 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