erp_fin

rco_painelrecuperacaocredito

35 views 07/11/2018 06/09/2019 integrador 0

2.0info: 5.0.0 rco_painelrecuperacaocredito x-senior-domain: erp_fin x-senior-domain-path: erp_fin x-senior-service-path: rco_painelrecuperacaocredito 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: /rco_painelrecuperacaocredito/queries/obterAssessorias: post: description: Retorna as assessorias de cobrança tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: integer format: int64 description: Id da empresa codigoAssessoria: type: integer format: int64 description: Id do título a receber da ocorrência responses: 200: description: Ok schema: type: object required: – assessorias properties: assessorias: type: array items: type: object allOf: – #/definitions/entAssessoria minimum: 1 description: Ocorrências localizadas a partir dos filtros informados default: description: Error response schema: #/definitions/genericError get: description: Retorna as assessorias de cobrança tags: – Queries x-senior-visibility: PRIVATE parameters: – name: empresaId description: Id da empresa in: query required: true type: integer format: int64 – name: codigoAssessoria description: Id do título a receber da ocorrência in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – assessorias properties: assessorias: type: array items: type: object allOf: – #/definitions/entAssessoria minimum: 1 description: Ocorrências localizadas a partir dos filtros informados default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/queries/obterOcorrenciasAssessoria: post: description: Retorna as ocorrências de assessoria tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – empresaId properties: empresaId: type: integer format: int64 description: Id da empresa tituloReceberId: type: array items: type: integer format: int64 description: Id do título a receber da ocorrência filialId: type: array items: type: integer format: int64 description: Id da filial numeroTitulo: type: array items: type: string description: Número do Título (15) tipoTituloId: type: array items: type: string description: Tipo do título (3) assessoriaId: type: array items: type: integer format: int64 description: Id da assessoria de cobranca tipoOcorrencia: type: array items: type: string allOf: – #/definitions/enumTipoOcorrenciaAssessoria description: Tipo de ocorrência dataInicialGeracao: type: string format: date description: Data inicial de geração da ocorrência dataFinalGeracao: type: string format: date description: Data final de geração da ocorrência responses: 200: description: Ok schema: type: object required: – ocorrencias properties: ocorrencias: type: array items: type: object allOf: – #/definitions/recDadosOcorrenciaAssessoria minimum: 1 description: Ocorrências localizadas a partir dos filtros informados default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/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 /rco_painelrecuperacaocredito/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 /rco_painelrecuperacaocredito/entities/entAssessoria: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entAssessoria responses: 200: description: The created resource schema: #/definitions/entAssessoria default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entAssessoria responses: 200: description: The created resource schema: #/definitions/entAssessoria default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entAssessoria default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/entities/entAssessoria/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entAssessoria responses: 200: description: Ok schema: #/definitions/entAssessoria default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entAssessoria responses: 200: description: Ok schema: #/definitions/entAssessoria default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entAssessoria default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/entities/entAssessoria/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entAssessoria responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/entities/entOcorrenciaAssessoria: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entOcorrenciaAssessoria responses: 200: description: The created resource schema: #/definitions/entOcorrenciaAssessoria default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/entOcorrenciaAssessoria responses: 200: description: The created resource schema: #/definitions/entOcorrenciaAssessoria default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/entOcorrenciaAssessoria default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/entities/entOcorrenciaAssessoria/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entOcorrenciaAssessoria responses: 200: description: Ok schema: #/definitions/entOcorrenciaAssessoria default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/entOcorrenciaAssessoria responses: 200: description: Ok schema: #/definitions/entOcorrenciaAssessoria default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/entOcorrenciaAssessoria default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /rco_painelrecuperacaocredito/entities/entOcorrenciaAssessoria/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/entOcorrenciaAssessoria responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: enumTipoOcorrenciaAssessoria: description: Tipo de ocorrência na assessoria de cobrança type: string enum: – Atualizacao – Devolucao – Historico – Inclusao – Pagamento – Renegociacao 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 entAssessoria: description: Assessorias de Cobrança type: object required: – empresaId – codigoAssessoria – descricao properties: id: type: integer format: int64 description: Id da assessoria empresaId: type: integer format: int64 description: Id da empresa onde a assessoria está cadastrada codigoAssessoria: type: integer format: int64 description: Código da assessoria que será exibido ao usuário descricao: type: string description: Descrição da assessoria (100) auditoria: type: object allOf: – #/definitions/recAuditoria description: Dados de auditoria do registro entOcorrenciaAssessoria: description: Assessorias de Cobrança type: object required: – tituloReceberId – assessoriaId – sequenciaOcorrencia – tipoOcorrencia – dataOcorrencia properties: id: type: integer format: int64 description: Id da assessoria tituloReceberId: type: integer format: int64 description: Id da empresa onde a assessoria está cadastrada assessoriaId: type: object allOf: – #/definitions/entAssessoria description: Código da assessoria que será exibido ao usuário sequenciaOcorrencia: type: integer format: int64 description: Número Sequêncial da ocorrência tipoOcorrencia: type: string allOf: – #/definitions/enumTipoOcorrenciaAssessoria description: Tipo de ocorrência descricao: type: string description: Descrição da ocorrência (2499) acionamentoId: type: integer format: int64 description: Id do acionamento que gerou a ocorrência numeroTituloAssessoria: type: string description: Número do título na assessria de cobrança (25) numeroArquivoRemessa: type: integer format: int64 description: Numero do arquivo de remessa movimentoTituloReceberId: type: integer format: int64 description: Id do movimento de título a receber que gerou a ocorrência dataOcorrencia: type: string format: date description: Data da ocorrência auditoria: type: object allOf: – #/definitions/recAuditoria description: Dados de auditoria do registro recAuditoria: description: Dados de auditoria do registro type: object required: – dataGeracao – usuarioGeracao properties: dataGeracao: type: string format: date-time description: Data de geração do registro usuarioGeracao: type: string description: Usuário de geração do registro dataAlteracao: type: string format: date-time description: Data de alteração do registro usuarioAlteracao: type: string description: Usuário de alteração do registro recDadosOcorrenciaAssessoria: description: Dados de uma ocorrência de assessoria type: object required: – ocorrenciaAssessoria – numeroTitulo – clienteId – nomeCliente – valorOriginalTitulo – valorAbertoTitulo – valorLiquidoTitulo properties: ocorrenciaAssessoria: type: object allOf: – #/definitions/entOcorrenciaAssessoria description: Dados da ocorrência numeroTitulo: type: string description: Número do título clienteId: type: integer format: int64 description: Código do cliente nomeCliente: type: string description: Nome do Cliente valorOriginalTitulo: type: number format: double description: Valor original do título da ocorrência valorAbertoTitulo: type: number format: double description: Valor em aberto do título da ocorrência valorLiquidoTitulo: type: number format: double description: Valor líquidoç do título da ocorrência 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

Este artigo foi útil para você?

Leave A Comment