Mais pesquisados:Customização, Tutorial, Documentação

client_area

104 views 0 10/07/2020 Atualizado em 30/10/2024 integrador

2.0info: 5.0.22 client_area description: Serviço de APIs para o portal do cliente x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: client_area 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /client_area/queries/getAllContractInfo: post: description: Retorna todos informações dos contratos dos clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId properties: clientId: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object required: – allContractInfo properties: allContractInfo: type: object allOf: – #/definitions/recAllContractInfo description: Informações dos contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos informações dos contratos dos clientes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clientId description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – allContractInfo properties: allContractInfo: type: object allOf: – #/definitions/recAllContractInfo description: Informações dos contratos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getRolesCRM: post: description: Cargos do CRM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/RecDepartmentsAndRolesCRM minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Cargos do CRM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/RecDepartmentsAndRolesCRM minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getDepartmentsCRM: post: description: Departamentos do CRM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – departments properties: departments: type: array items: type: object allOf: – #/definitions/RecDepartmentsAndRolesCRM minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Departamentos do CRM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – departments properties: departments: type: array items: type: object allOf: – #/definitions/RecDepartmentsAndRolesCRM minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/userInfo: post: description: Verifica Permissão do usuário tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/recUserInfo description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica Permissão do usuário tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/recUserInfo description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getChannel: post: description: Verifica Se é Canal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object properties: isChannel: type: boolean description: Verifica se é cliente de canal default: false bloqueioCadastro: type: string description: Verifica se tem bloqueio no cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica Se é Canal tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object properties: isChannel: type: boolean description: Verifica se é cliente de canal default: false bloqueioCadastro: type: string description: Verifica se tem bloqueio no cadastro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getFlowReset: post: description: Pega url do flow reset tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object properties: urlFlowReset: type: string description: url flow reset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pega url do flow reset tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object properties: urlFlowReset: type: string description: url flow reset 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getSaas: post: description: Verifica se o cliente é Saas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object required: – hasSaas properties: hasSaas: type: boolean description: Verifica se tem saas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o cliente é Saas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – hasSaas properties: hasSaas: type: boolean description: Verifica se tem saas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getServiceNowProject: post: description: Verifica se tem projeto no servicenow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object properties: idClientServiceNow: type: string description: codigo cliente ServiceNow numberOfProjectsServiceNow: type: integer format: int64 description: quantidade de projetos ServiceNow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se tem projeto no servicenow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object properties: idClientServiceNow: type: string description: codigo cliente ServiceNow numberOfProjectsServiceNow: type: integer format: int64 description: quantidade de projetos ServiceNow 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/masterOrSeniorUserInfo: post: description: Verifica Permissão do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: Email do usuario responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/recUserInfo description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica Permissão do usuário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: email description: Email do usuario in: query required: true type: string responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/recUserInfo description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/checkCRM: post: description: Verifica se CRM está on tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: Crm está ativo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se CRM está on tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: Crm está ativo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/checkERP: post: description: Verifica se ERP está on tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: Erp está ativo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se ERP está on tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: Erp está ativo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/isActiveUser: post: description: Verifica se usuário é ativo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se usuário é ativo tags: – Queries x-senior-visibility: PRIVATE parameters: – name: email description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – isActive properties: isActive: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/masterUserInfo: post: description: Dados do usuario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – assumedUserId properties: assumedUserId: type: string description: Id usuário master responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/recUserInfo description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Dados do usuario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: assumedUserId description: Id usuário master in: query required: true type: string responses: 200: description: Ok schema: type: object required: – user properties: user: type: object allOf: – #/definitions/recUserInfo description: Usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getClient: post: description: Retorna os dados do Cliente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object allOf: – #/definitions/recCompleteClient 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os dados do Cliente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/recCompleteClient 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getUserRoles: post: description: Retorna as funcoes do usuario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/recUserRole minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as funcoes do usuario tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/recUserRole minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getAllPermissions: post: description: Retorna todas as Permissoes existentes tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/recGetPermission minimum: 1 description: Permissões do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todas as Permissoes existentes tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/recGetPermission minimum: 1 description: Permissões do usuário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getBillet: post: description: Retorna os Boletos do cliente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId properties: clientId: type: string description: Identificador único do Cliente responses: 200: description: Ok schema: type: object required: – billets properties: billets: type: array items: type: object allOf: – #/definitions/recGetBillet minimum: 1 description: Boletos showMessageExtendedBillet: type: boolean description: Tem boleto prorrogado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os Boletos do cliente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clientId description: Identificador único do Cliente in: query required: true type: string responses: 200: description: Ok schema: type: object required: – billets properties: billets: type: array items: type: object allOf: – #/definitions/recGetBillet minimum: 1 description: Boletos showMessageExtendedBillet: type: boolean description: Tem boleto prorrogado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getModuleAccessMultiplier: post: description: Busca o multiplicador aplicado a modulos/solucoes no CRM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId – id – quantity – type properties: clientId: type: string description: ID do cliente id: type: string description: Id do modulo quantity: type: integer format: int64 description: Quantidade type: type: string allOf: – #/definitions/typeProductItem description: Tipo do item responses: 200: description: Ok schema: type: object required: – validValues properties: validValues: type: array items: type: integer format: int64 minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getPaymentsConditions: post: description: Busca as condicoes de pagamento no CRM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – conditions properties: conditions: type: array items: type: object allOf: – #/definitions/recPaymentsCondition minimum: 1 description: Condições de pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as condicoes de pagamento no CRM tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – conditions properties: conditions: type: array items: type: object allOf: – #/definitions/recPaymentsCondition minimum: 1 description: Condições de pagamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getProprietaryKey: post: description: Recupera a chave proprietaria do cliente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – proprietaryKey properties: proprietaryKey: type: string description: Chave prioritaria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera a chave proprietaria do cliente tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – proprietaryKey properties: proprietaryKey: type: string description: Chave prioritaria 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/healthcheck: post: description: HealthCheck (Obrigatorio pela SDL) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck (Obrigatorio pela SDL) tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getContractedSolutionModules: post: description: Retorna os módulos contratados pelo por todas as empresas do conglomerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: useRate: type: array items: type: string allOf: – #/definitions/productUseRate description: Filtro para a quantidade de uso, se não informado retorna todos. responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/activeProductItem minimum: 1 description: Produtos ativos do cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getClientProducts: post: description: Retorna os módulos contratados pelo por todas as empresas do conglomerado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: useRate: type: array items: type: string allOf: – #/definitions/productUseRate description: Filtro para a quantidade de uso, se não informado retorna todos. responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/activeProductItem minimum: 1 description: Produtos ativos do cliente 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getUpgradePrices: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId – prazoPagamentoId – items properties: clientId: type: string description: Identificador do cliente prazoPagamentoId: type: string description: Identificador do prazo items: type: array items: type: object allOf: – #/definitions/recItem minimum: 1 description: Preços do upgrade responses: 200: description: Ok schema: type: object allOf: – #/definitions/crmDtoProposta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getResume: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: responses: 200: description: Ok schema: type: object allOf: – #/definitions/upgradeResume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/upgradeResume 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/sendBillingRevaluation: post: description: Enviar email com pedido de reavaliação de faturamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – billingRevaluation properties: billingRevaluation: type: object allOf: – #/definitions/recBillingRevaluation description: responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getFtpFileNames: post: description: Pega nomes das pastas ftp tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – folderName properties: folderName: type: string description: responses: 200: description: Ok schema: type: object required: – listFiles properties: listFiles: type: array items: type: object allOf: – #/definitions/recGetDataFtp minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Pega nomes das pastas ftp tags: – Queries x-senior-visibility: PRIVATE parameters: – name: folderName description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – listFiles properties: listFiles: type: array items: type: object allOf: – #/definitions/recGetDataFtp minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/downloadAmazonFile: post: description: Faz download dos arquivos selecionados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userEmail – files properties: userEmail: type: string description: Email do usuário files: type: array items: type: object allOf: – #/definitions/recGetDataFtp minimum: 1 description: Arquivos para baixar responses: 200: description: Ok schema: type: object required: – download properties: download: type: boolean description: Retorno do download 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getLinksFtp: post: description: Gerar links para download dos arquivos ftp tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userEmail – files properties: userEmail: type: string description: Email do usuário files: type: array items: type: object allOf: – #/definitions/recFilesFtp minimum: 1 description: Arquivos responses: 200: description: Ok schema: type: object required: – links properties: links: type: array items: type: object allOf: – #/definitions/recFilesFtp minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/checkHasProjectServiceNow: post: description: Recupera lista de projetos ServiceNow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – integrationCode properties: integrationCode: type: string description: codigo cliente ServiceNow responses: 200: description: Ok schema: type: object required: – serviceNow properties: serviceNow: type: object allOf: – #/definitions/recServiceNow description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera lista de projetos ServiceNow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: integrationCode description: codigo cliente ServiceNow in: query required: true type: string responses: 200: description: Ok schema: type: object required: – serviceNow properties: serviceNow: type: object allOf: – #/definitions/recServiceNow description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getProjectsListServiceNow: post: description: Recupera lista de projetos ServiceNow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idClientServiceNow properties: idClientServiceNow: type: string description: codigo cliente ServiceNow responses: 200: description: Ok schema: type: object required: – listOfProjects properties: listOfProjects: type: array items: type: object allOf: – #/definitions/recListServiceNowOutput minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera lista de projetos ServiceNow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idClientServiceNow description: codigo cliente ServiceNow in: query required: true type: string responses: 200: description: Ok schema: type: object required: – listOfProjects properties: listOfProjects: type: array items: type: object allOf: – #/definitions/recListServiceNowOutput minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getProjectDetailsServiceNow: post: description: Recupera detalhes dos projetos ServiceNow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – idProjectServiceNow properties: idProjectServiceNow: type: string description: codigo cliente ServiceNow responses: 200: description: Ok schema: type: object required: – detailsServiceNow properties: detailsServiceNow: type: object allOf: – #/definitions/recDetailsServiceNowOutput description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Recupera detalhes dos projetos ServiceNow tags: – Queries x-senior-visibility: PRIVATE parameters: – name: idProjectServiceNow description: codigo cliente ServiceNow in: query required: true type: string responses: 200: description: Ok schema: type: object required: – detailsServiceNow properties: detailsServiceNow: type: object allOf: – #/definitions/recDetailsServiceNowOutput description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/allUsers: post: description: Retorna todos usuários pertencentes as empresas que o usuário logado pertence tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientLoggedId properties: clientLoggedId: type: string description: uuid do cliente logado responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/recAllUsers minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna todos usuários pertencentes as empresas que o usuário logado pertence tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clientLoggedId description: uuid do cliente logado in: query required: true type: string responses: 200: description: Ok schema: type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/recAllUsers minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/listUpgradeRequests: post: description: Lista as solicitações de upgrade de contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId properties: clientId: type: string description: Identificador do cliente size: type: integer format: int64 description: Quantidade de elementos a serem retornados default: 10 offset: type: integer format: int64 description: Posição inicial da listagem default: 0 orderBy: type: string description: Campo a ser utilizado para ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas em cima do tamanho passado totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/upgradeRequest minimum: 1 description: Conteúdo retornado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as solicitações de upgrade de contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clientId description: Identificador do cliente in: query required: true type: string – name: size description: Quantidade de elementos a serem retornados in: query type: integer format: int64 – name: offset description: Posição inicial da listagem in: query type: integer format: int64 – name: orderBy description: Campo a ser utilizado para ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas em cima do tamanho passado totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/upgradeRequest minimum: 1 description: Conteúdo retornado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getUpgradeRequest: post: description: Lista as solicitações de upgrade de contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador da solicitação de upgrade de contrato. responses: 200: description: Ok schema: type: object allOf: – #/definitions/recRascunho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as solicitações de upgrade de contrato tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador da solicitação de upgrade de contrato. in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/recRascunho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getUpgradeRequestItem: post: description: Busca o item de upgrade por id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador do item da do upgrade responses: 200: description: Ok schema: type: object allOf: – #/definitions/recRascunho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o item de upgrade por id tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador do item da do upgrade in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/recRascunho 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getUserPermissions: post: description: Lista todas as permissões do usuário informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyId properties: companyId: type: string description: responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/recGetUserPermission minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as permissões do usuário informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – permissions properties: permissions: type: array items: type: object allOf: – #/definitions/recGetUserPermission minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getAvailableRoles: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: includeDisabledRoles: type: boolean description: responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/recGetAvailableRoles minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: includeDisabledRoles description: in: query type: boolean responses: 200: description: Ok schema: type: object required: – roles properties: roles: type: array items: type: object allOf: – #/definitions/recGetAvailableRoles minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getRoleCustom: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador unico responses: 200: description: Ok schema: type: object required: – role properties: role: type: object allOf: – #/definitions/RecGetRoleCustom description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Identificador unico in: query required: true type: string responses: 200: description: Ok schema: type: object required: – role properties: role: type: object allOf: – #/definitions/RecGetRoleCustom description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getAllClients: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/recGetAllClients minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – clients properties: clients: type: array items: type: object allOf: – #/definitions/recGetAllClients minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/getAllUsersByClient: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId properties: clientId: type: string description: responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/recGetAllUsersByClient minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clientId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – users properties: users: type: array items: type: object allOf: – #/definitions/recGetAllUsersByClient minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/queries/checkSaasClient: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId properties: clientId: type: string description: responses: 200: description: Ok schema: type: object required: – saasModules properties: saasModules: type: array items: type: object allOf: – #/definitions/recItem minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: clientId description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – saasModules properties: saasModules: type: array items: type: object allOf: – #/definitions/recItem minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/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 /client_area/queries/exportClientAccessEnvironmentUpdating: 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 /client_area/queries/exportPermissionEnvironmentUpdating: 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 /client_area/queries/exportBilletRules: 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 /client_area/queries/exportClient: 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 /client_area/queries/exportUser: 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 /client_area/queries/exportBlockedModules: 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 /client_area/queries/exportContact: 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 /client_area/queries/exportAddress: 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 /client_area/queries/exportPhone: 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 /client_area/queries/exportLegalDocument: 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 /client_area/queries/exportBillet: 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 /client_area/queries/exportRequestDuplicate: 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 /client_area/queries/exportTracking: 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 /client_area/queries/exportProduct: 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 /client_area/queries/exportAgent: 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 /client_area/queries/exportContract: 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 /client_area/queries/exportContractItem: 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 /client_area/queries/exportUpgradeRequest: 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 /client_area/queries/exportBpmControll: 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 /client_area/queries/exportUpgradeRequestItem: 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 /client_area/queries/exportBillingDataItem: 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 /client_area/queries/exportRole: 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 /client_area/queries/exportPermission: 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 /client_area/queries/exportServiceMenuPermission: 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 /client_area/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 /client_area/actions/returnFile: post: description: Senha customizar(retornar arquivo) tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: codigoCliente: type: string description: flowInstanceID: type: string description: flowName: type: string description: responses: 200: description: Ok schema: type: object required: – archive properties: archive: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/consultantLogin: post: description: Login de consultores utilizando LDAP tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – user – password properties: user: type: string description: password: type: string description: responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/deleteUserClient: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId – usersId properties: clientId: type: string description: usersId: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object required: – success properties: success: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/getCoupon: post: description: Consulta para pegar cupom tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – codes – productValues properties: codes: type: string description: Código do cupom productValues: type: array items: type: object allOf: – #/definitions/recProductValues minimum: 1 description: Valores do produto responses: 200: description: Ok schema: type: object required: – couponResponse properties: isValid: type: boolean description: couponResponse: type: array items: type: object allOf: – #/definitions/recProductValues minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/readTable: post: description: Read tables tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – table – ids properties: table: type: string description: Nome da tabela ids: type: array items: type: string minimum: 1 description: Lista de ids responses: 200: description: Ok schema: type: object required: – dados properties: dados: type: array items: type: string minimum: 1 description: Dados encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/generateUser: post: description: Criação de Usuario manual tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recGenerateUser responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/genericUpdate: post: description: Repositorio Generico tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – command – schema – values properties: command: type: string description: command schema: type: string description: schema values: type: array items: type: object allOf: – #/definitions/recGenericUpdateValues minimum: 1 description: Valores responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/createAdditionalUser: post: description: Cria novos usuários tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recCreateAdditionalUser responses: 200: description: Ok schema: type: object allOf: – #/definitions/recAdditionalUserCreated 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/updateUserInfos: post: description: Altera informações do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recUpdateUserInfos responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/updateAllowed: post: description: Update do Campo Allowed tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – allowed – integrationCode properties: allowed: type: boolean description: Valor do campo integrationCode: type: array items: type: string minimum: 1 description: Lista de Integration code responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/resetPassword: post: description: Reseta senha do usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recResetPassword responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/getBillingStatement: post: description: Gerar demonstrativo financeiro tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: emailAdic: type: string description: flowInstanceID: type: string description: flowName: type: string description: idNF: type: object allOf: – #/definitions/recIdNF description: responses: 200: description: Ok schema: type: object required: – archive properties: archive: type: string description: Arquivo string base64 do pdf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/addBlockedModule: post: description: Adiciona módulo da lista de bloqueados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modulesId properties: modulesId: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/removeBlockedModule: post: description: Remove módulo da lista de bloqueados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – modulesId properties: modulesId: type: array items: type: string minimum: 1 description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/updateUserStatus: post: description: Atualiza Status do Usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email – isActive properties: email: type: string description: email isActive: type: boolean description: Status do Usuário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/generateUpgradeRequestSync: post: description: Criação da solicitação de upgrade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recUpgradeRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/recUpgradeRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/generateUpgradeRequest: post: description: Criação da solicitação de upgrade tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recUpgradeRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/upgradeRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/updateUpgradeRequestStatusByRequestId: post: description: Atualiza o status de uma solicitação de upgrade de contrato tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – requestId – status properties: requestId: type: integer format: int64 description: Identificador único da solicitação de upgrade de contrato status: type: string allOf: – #/definitions/statusOrder description: Status da solicitação de upgrade de contrato responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/registrationUpdate: post: description: Atualização cadastral do cliente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – trade – contractEmail – legalDocumentEmail – billingEmail – addresses – phones properties: id: type: string description: Identificador único do Cliente trade: type: string maxLength: 50 description: Nome fantasia contractEmail: type: string maxLength: 250 description: Email de contratos legalDocumentEmail: type: string maxLength: 250 description: Email de nota fiscal billingEmail: type: string maxLength: 250 description: Email de documentos eletronicos website: type: string maxLength: 30 description: Website addresses: type: array items: type: object allOf: – #/definitions/recAddress minimum: 1 description: Dados do endereço do usuario phones: type: array items: type: object allOf: – #/definitions/recPhone minimum: 1 description: Telefones do cliente responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado (true – atualizado, false – não atualizado) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/registrationUpdateContacts: post: description: Atualização cadastral dos contatos tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: contacts: type: array items: type: object allOf: – #/definitions/recContactWithPhone description: Contatos do cliente responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: Resultado (true – atualizado, false – não atualizado) 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/generateRequestDuplicate: post: description: Criação da Solicitação da segunda via tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – type properties: id: type: string description: Identificador único do boleto ou nota fiscal type: type: string allOf: – #/definitions/typeRequestDuplicate description: Tipo da solicitação (Boleto ou nota fiscal) responses: 200: description: Ok schema: type: object required: – sendTo properties: sendTo: type: array items: type: string minimum: 1 description: E-mail para onde será enviado o segunda via 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/downloadBilletPDF: post: description: Disponibilização do pdf do boleto tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – type properties: id: type: string description: Identificador único do boleto ou nota fiscal type: type: string allOf: – #/definitions/typeRequestDuplicate description: Tipo da solicitação (Boleto ou nota fiscal) responses: 200: description: Ok schema: type: object required: – archive properties: archive: type: string description: Arquivo string base64 do pdf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/setCurrentClient: post: description: Insere o currentClient no usuário logado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId properties: clientId: type: string description: Identificador único do cliente responses: 200: description: Ok schema: type: object required: – client properties: client: type: object allOf: – #/definitions/recClientInfo description: currentClient salvo com sucesso? 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/logoff: post: description: Efetua operações necessárias ao deslogar um usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userId properties: userId: type: string description: E-mail do usuário atualmente logado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/firstAccess: post: description: Primeiro acesso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: E-mail de acesso name: type: string description: Nome completo do usuário cnpj: type: string description: Cnpj da empresa alternativeEmail: type: string description: Alterar email de envio responses: 200: description: Ok schema: type: object required: – sendEmail – usuarioValido – resetPassword – sameDomain – fullBlockedEmail properties: sendEmail: type: boolean description: E-mail enviado usuarioValido: type: boolean description: Usuário possui cadastro resetPassword: type: boolean description: Precisa resetar senha sameDomain: type: boolean description: Verifica dominio fullBlockedEmail: type: string description: Email do adm default: description: Error response schema: #/definitions/genericError /client_area/actions/resendEmail: post: description: Primeiro acesso tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string description: E-mail de acesso responses: 200: description: Ok schema: type: object required: – sendEmail properties: sendEmail: type: boolean description: E-mail enviado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/createRoleCustom: post: description: Criação de papel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: object allOf: – #/definitions/recRoleCreate description: Informações do papel responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador unico papel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/updateRoleCustom: post: description: Atualização de papel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – role properties: role: type: object allOf: – #/definitions/recRoleUpdate description: Informações do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/changeUserRoles: post: description: Altera as roles para um usuário tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – rolesChange properties: rolesChange: type: object allOf: – #/definitions/recChangeUserRoles description: responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/removeRole: post: description: Remove Role tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador unico responses: 200: description: Ok schema: type: object required: – result properties: result: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/disableRole: post: description: Disable Role tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador unico responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/enableRole: post: description: Disable Role tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificador unico responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/saveUpgradeRequestDraft: post: description: Save upgrade request Draft tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recUpgradeRequest responses: 200: description: Ok schema: type: object allOf: – #/definitions/recUpgradeRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/linkUserToClient: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – userId – clientsIds properties: userId: type: string description: Identificador do usuário clientsIds: type: array items: type: string minimum: 1 description: Identificadores dos clientes responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/actions/importClientAccessEnvironmentUpdating: 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 /client_area/actions/importPermissionEnvironmentUpdating: 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 /client_area/actions/importBilletRules: 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 /client_area/actions/importClient: 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 /client_area/actions/importUser: 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 /client_area/actions/importBlockedModules: 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 /client_area/actions/importContact: 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 /client_area/actions/importAddress: 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 /client_area/actions/importPhone: 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 /client_area/actions/importLegalDocument: 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 /client_area/actions/importBillet: 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 /client_area/actions/importRequestDuplicate: 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 /client_area/actions/importTracking: 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 /client_area/actions/importProduct: 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 /client_area/actions/importAgent: 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 /client_area/actions/importContract: 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 /client_area/actions/importContractItem: 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 /client_area/actions/importUpgradeRequest: 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 /client_area/actions/importBpmControll: 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 /client_area/actions/importUpgradeRequestItem: 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 /client_area/actions/importBillingDataItem: 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 /client_area/actions/importRole: 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 /client_area/actions/importPermission: 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 /client_area/actions/importServiceMenuPermission: 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 /client_area/signals/generateNewPassword: post: description: Senha customizar(gerar nova senha) tags: – Signals parameters: – name: input in: body required: true schema: type: object properties: email: type: string description: flowInstanceID: type: string description: flowName: type: string description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/integrateClientsToERP: post: description: Forçar integração de clientes com o ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationCodeList properties: integrationCodeList: type: array items: type: string minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/allEmailsToLowerCase: post: description: Alterar e-mails do portal para minúsculo tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/addTrackingSystemCentral: post: description: Adicionar tracking de acesso á tela de sistema tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/deleteTrackingsByType: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – tracking properties: tracking: type: string allOf: – #/definitions/typeTracking description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateClient: post: description: Cria o client(cliente) e faz a associação do usuário externo com ele tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – client – address – email – activePortalUser properties: client: type: object allOf: – #/definitions/recClient description: Dados do cliente address: type: array items: type: object allOf: – #/definitions/recAddress minimum: 1 description: Dados do endereço do usuario email: type: string maxLength: 100 description: Email de login phone: type: array items: type: string description: Telefones do cliente activePortalUser: type: boolean description: Usuário ativo do portal floatingQuantity: type: integer format: int64 description: Quantidade de flutuante responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/deleteTable: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – table – id properties: table: type: string description: Nome da tabela id: type: array items: type: string minimum: 1 description: Id responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/insertTable: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – table properties: table: type: string description: Nome da tabela address: type: object allOf: – #/definitions/recUpdateAddress description: Tabelas agent: type: object allOf: – #/definitions/recUpdateAgent description: billet: type: object allOf: – #/definitions/recUpdateBillet description: billingDataItem: type: object allOf: – #/definitions/recUpdateBillingDataItem description: bpmControll: type: object allOf: – #/definitions/recUpdateBpmControll description: client: type: object allOf: – #/definitions/recUpdateClient description: contact: type: object allOf: – #/definitions/recUpdateContact description: contract: type: object allOf: – #/definitions/recUpdateContract description: contractItem: type: object allOf: – #/definitions/recUpdateContractItem description: legalDocument: type: object allOf: – #/definitions/recUpdateLegalDocument description: permission: type: object allOf: – #/definitions/recUpdatePermission description: phone: type: object allOf: – #/definitions/recUpdatePhone description: product: type: object allOf: – #/definitions/recUpdateProduct description: requestDuplicate: type: object allOf: – #/definitions/recUpdateRequestDuplicate description: role: type: object allOf: – #/definitions/recUpdateRole description: tracking: type: object allOf: – #/definitions/recUpdateTracking description: upgradeRequest: type: object allOf: – #/definitions/recUpdateUpgradeRequest description: upgradeRequestItem: type: object allOf: – #/definitions/recUpdateUpgradeRequestItem description: users: type: object allOf: – #/definitions/recUpdateUsers description: billetRules: type: object allOf: – #/definitions/recUpdateBilletRules description: serviceMenuPermission: type: object allOf: – #/definitions/recUpdateServiceMenuPermission description: clientAccessEnvironmentUpdating: type: array items: type: object allOf: – #/definitions/recClientAccessEnvironmentUpdating description: permissionEnvironmentUpdating: type: object allOf: – #/definitions/recPermissionEnvironmentUpdating description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/insertTableServiceMenuPermission: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – agentIdList properties: agentIdList: type: array items: type: string minimum: 1 description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/updateTable: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – table properties: table: type: string description: Nome da tabela address: type: object allOf: – #/definitions/recUpdateAddress description: Tabelas agent: type: object allOf: – #/definitions/recUpdateAgent description: billet: type: object allOf: – #/definitions/recUpdateBillet description: billingDataItem: type: object allOf: – #/definitions/recUpdateBillingDataItem description: bpmControll: type: object allOf: – #/definitions/recUpdateBpmControll description: client: type: object allOf: – #/definitions/recUpdateClient description: contact: type: object allOf: – #/definitions/recUpdateContact description: contract: type: object allOf: – #/definitions/recUpdateContract description: contractItem: type: object allOf: – #/definitions/recUpdateContractItem description: legalDocument: type: object allOf: – #/definitions/recUpdateLegalDocument description: permission: type: object allOf: – #/definitions/recUpdatePermission description: phone: type: object allOf: – #/definitions/recUpdatePhone description: product: type: object allOf: – #/definitions/recUpdateProduct description: requestDuplicate: type: object allOf: – #/definitions/recUpdateRequestDuplicate description: role: type: object allOf: – #/definitions/recUpdateRole description: tracking: type: object allOf: – #/definitions/recUpdateTracking description: upgradeRequest: type: object allOf: – #/definitions/recUpdateUpgradeRequest description: upgradeRequestItem: type: object allOf: – #/definitions/recUpdateUpgradeRequestItem description: users: type: object allOf: – #/definitions/recUpdateUsers description: billetRules: type: object allOf: – #/definitions/recUpdateBilletRules description: clientAccessEnvironmentUpdating: type: object allOf: – #/definitions/recClientAccessEnvironmentUpdating description: permissionEnvironmentUpdating: type: object allOf: – #/definitions/recPermissionEnvironmentUpdating description: responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateMasterUser: post: description: Cria o usuário Master tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string maxLength: 100 description: Email de login responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateAdminUser: post: description: Cria o usuário admin tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – email properties: email: type: string maxLength: 100 description: Email de login responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateContact: post: description: Criação do contact(contato) tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – clientIntegrationCode – contact properties: clientIntegrationCode: type: string description: Número de integração do cliente contact: type: object allOf: – #/definitions/recContact description: Dados do Contato phone: type: array items: type: object allOf: – #/definitions/recPhone description: Telefones do cliente responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateLegalDocument: post: description: Criação da nota fiscal tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – legalDocument properties: legalDocument: type: object allOf: – #/definitions/recLegalDocument description: Dados da nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateBillet: post: description: Criação do boleto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – clientIntegrationCode – companyCode – legalDocumentBranchCode – legalDocumentNumber – legalDocumentNumberExt – billet properties: clientIntegrationCode: type: string description: Número de integração do cliente companyCode: type: integer format: int64 description: Empresa legalDocumentBranchCode: type: integer format: int64 description: Filial legalDocumentNumber: type: integer format: int64 description: Número legalDocumentNumberExt: type: string maxLength: 3 description: Número de serie da nota fiscal billet: type: object allOf: – #/definitions/recBillet description: Dados do boleto responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateProduct: post: description: Criação de Produto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – product properties: product: type: object allOf: – #/definitions/recProduct description: Dados do produto responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateAgent: post: description: Criação de Representante tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – agent properties: agent: type: object allOf: – #/definitions/recAgent description: Dados do representante responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateContract: post: description: Criação de Contrato tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – clientIntegrationCode – agentIntegrationCode – contract properties: clientIntegrationCode: type: string description: Número de integração do cliente agentIntegrationCode: type: string description: Número de integração do representante contract: type: object allOf: – #/definitions/recContract description: Dados do contrato responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/generateContractItem: post: description: Criação de item do contrato tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – productIntegrationCode – contractItem properties: productIntegrationCode: type: string description: Número de integração do produto contractItem: type: object allOf: – #/definitions/recContractItem description: Dados do item do contrato responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/giveModeratorPermission: post: description: Permissão moderador pratodo mundo tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/setUsersClient: post: description: tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/deleteAllContract: post: description: Deleta registro do Contrato por ids tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/deleteAllContractItens: post: description: Deleta registro dos itens de contrato ids tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/deleteContractByIds: post: description: Deleta registro do Contrato por ids tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: array items: type: string minimum: 1 description: id do contrato\n responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/updateCurrentClient: post: description: Update currentCliente na tabela de usuário tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – idUser – idCurrentClient properties: idUser: type: string description: id do usuario idCurrentClient: type: string description: id do currentClient createdBy: type: string description: created by responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/deleteContractItensByIds: post: description: Deleta registro dos itens de contrato ids tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: array items: type: string minimum: 1 description: Id do item de contrato responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/removeLegalDocument: post: description: Exclusão da nota fiscal tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companyCode – branchCode – number – numberExt properties: companyCode: type: integer format: int64 description: Empresa branchCode: type: integer format: int64 description: Filial number: type: integer format: int64 description: Número numberExt: type: string maxLength: 3 description: Número de serie da nota fiscal responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/upgradeContractSendToERP: post: description: Envio da alteração dos contratos para o ERP tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – upgradeRequest properties: upgradeRequest: type: object allOf: – #/definitions/recUpgradeRequest description: Empresa responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/sendBilling: post: description: Envio de email generico tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – to – subject – description properties: to: type: string description: Remetente subject: type: string description: Titulo description: type: string description: Descricao files: type: array items: type: object allOf: – #/definitions/recFiles description: arquivos responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/removeBillet: post: description: Exclusão do boleto tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – companyCode – paymentNumber – paymentType properties: companyCode: type: integer format: int64 description: Empresa branchCode: type: integer format: int64 description: Filial paymentNumber: type: string maxLength: 15 description: Número do título paymentType: type: string maxLength: 3 description: Tipo do título responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/integrationUpdatedClient: post: description: Notificação de atualização do client pela integração tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – integrationCode properties: integrationCode: type: string description: Código de identificação interna responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/integrationUpdatedContact: post: description: Notificação de atualização do client pela integração tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – clientIntegrationCode – contact properties: clientIntegrationCode: type: string description: Número de integração do cliente contact: type: object allOf: – #/definitions/recContact description: Dados do Contato responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/reprocessRegistrationUpdate: post: description: Reprocessa a atualização cadastral do cliente tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/updateBilletStatus: post: description: Atualiza o status do boleto tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/signals/requestNewPassword: post: description: Solicitação de nova senha tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – email – isEmailConfirmation properties: email: type: string description: The email we want to request a new password isEmailConfirmation: type: boolean description: É confirmação de email ou uma nova senha de um novo email? responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /client_area/events/updatedClient: post: description: Evento de atualização do cliente x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – client – address – phone – user properties: client: type: object allOf: – #/definitions/client description: Cliente address: type: array items: type: object allOf: – #/definitions/address minimum: 1 description: Endereços phone: type: array items: type: object allOf: – #/definitions/phone minimum: 1 description: Telefones user: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Usuario responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /client_area/events/updatedContact: post: description: Evento de atualização do contato x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – contact – integrationCode properties: contact: type: object allOf: – #/definitions/contact description: Contato phone: type: array items: type: object allOf: – #/definitions/phone description: Telefones integrationCode: type: string description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /client_area/events/notifyRequestDuplicateBillet: post: description: Evento de notificação da solicitação da segunda via do boleto x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – companyCode – billet properties: companyCode: type: integer format: int64 description: Empresa billet: type: object allOf: – #/definitions/recBillet description: Dados do Boleto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /client_area/events/notifyRequestDuplicateLegalDocument: post: description: Evento de notificação da solicitação da segunda via da nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – legalDocument properties: legalDocument: type: object allOf: – #/definitions/recLegalDocument description: Dados do Boleto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /client_area/events/importClientAccessEnvironmentUpdatingEvent: 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 /client_area/events/exportClientAccessEnvironmentUpdatingEvent: 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 /client_area/events/importPermissionEnvironmentUpdatingEvent: 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 /client_area/events/exportPermissionEnvironmentUpdatingEvent: 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 /client_area/events/importBilletRulesEvent: 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 /client_area/events/exportBilletRulesEvent: 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 /client_area/events/importClientEvent: 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 /client_area/events/exportClientEvent: 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 /client_area/events/importUserEvent: 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 /client_area/events/exportUserEvent: 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 /client_area/events/importBlockedModulesEvent: 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 /client_area/events/exportBlockedModulesEvent: 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 /client_area/events/importContactEvent: 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 /client_area/events/exportContactEvent: 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 /client_area/events/importAddressEvent: 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 /client_area/events/exportAddressEvent: 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 /client_area/events/importPhoneEvent: 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 /client_area/events/exportPhoneEvent: 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 /client_area/events/importLegalDocumentEvent: 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 /client_area/events/exportLegalDocumentEvent: 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 /client_area/events/importBilletEvent: 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 /client_area/events/exportBilletEvent: 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 /client_area/events/importRequestDuplicateEvent: 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 /client_area/events/exportRequestDuplicateEvent: 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 /client_area/events/importTrackingEvent: 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 /client_area/events/exportTrackingEvent: 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 /client_area/events/importProductEvent: 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 /client_area/events/exportProductEvent: 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 /client_area/events/importAgentEvent: 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 /client_area/events/exportAgentEvent: 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 /client_area/events/importContractEvent: 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 /client_area/events/exportContractEvent: 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 /client_area/events/importContractItemEvent: 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 /client_area/events/exportContractItemEvent: 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 /client_area/events/importUpgradeRequestEvent: 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 /client_area/events/exportUpgradeRequestEvent: 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 /client_area/events/importBpmControllEvent: 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 /client_area/events/exportBpmControllEvent: 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 /client_area/events/importUpgradeRequestItemEvent: 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 /client_area/events/exportUpgradeRequestItemEvent: 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 /client_area/events/importBillingDataItemEvent: 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 /client_area/events/exportBillingDataItemEvent: 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 /client_area/events/importRoleEvent: 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 /client_area/events/exportRoleEvent: 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 /client_area/events/importPermissionEvent: 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 /client_area/events/exportPermissionEvent: 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 /client_area/events/importServiceMenuPermissionEvent: 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 /client_area/events/exportServiceMenuPermissionEvent: 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 /client_area/entities/clientAccessEnvironmentUpdating: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/clientAccessEnvironmentUpdating responses: 200: description: The created resource schema: #/definitions/clientAccessEnvironmentUpdating 401: description: Invalid Credentials 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/clientAccessEnvironmentUpdating responses: 200: description: The created resource schema: #/definitions/clientAccessEnvironmentUpdating 401: description: Invalid Credentials 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 – 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: array items: #/definitions/clientAccessEnvironmentUpdating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/clientAccessEnvironmentUpdating/{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/clientAccessEnvironmentUpdating responses: 200: description: Ok schema: #/definitions/clientAccessEnvironmentUpdating 401: description: Invalid Credentials 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/clientAccessEnvironmentUpdating responses: 200: description: Ok schema: #/definitions/clientAccessEnvironmentUpdating 401: description: Invalid Credentials 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/clientAccessEnvironmentUpdating 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/clientAccessEnvironmentUpdating/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/clientAccessEnvironmentUpdating responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/permissionEnvironmentUpdating: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/permissionEnvironmentUpdating responses: 200: description: The created resource schema: #/definitions/permissionEnvironmentUpdating 401: description: Invalid Credentials 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/permissionEnvironmentUpdating responses: 200: description: The created resource schema: #/definitions/permissionEnvironmentUpdating 401: description: Invalid Credentials 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 – 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: array items: #/definitions/permissionEnvironmentUpdating 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/permissionEnvironmentUpdating/{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/permissionEnvironmentUpdating responses: 200: description: Ok schema: #/definitions/permissionEnvironmentUpdating 401: description: Invalid Credentials 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/permissionEnvironmentUpdating responses: 200: description: Ok schema: #/definitions/permissionEnvironmentUpdating 401: description: Invalid Credentials 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/permissionEnvironmentUpdating 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/permissionEnvironmentUpdating/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/permissionEnvironmentUpdating responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billetRules: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/billetRules responses: 200: description: The created resource schema: #/definitions/billetRules 401: description: Invalid Credentials 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/billetRules responses: 200: description: The created resource schema: #/definitions/billetRules 401: description: Invalid Credentials 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 – 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: array items: #/definitions/billetRules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billetRules/{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/billetRules responses: 200: description: Ok schema: #/definitions/billetRules 401: description: Invalid Credentials 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/billetRules responses: 200: description: Ok schema: #/definitions/billetRules 401: description: Invalid Credentials 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/billetRules 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billetRules/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/billetRules responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/client: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/client responses: 200: description: The created resource schema: #/definitions/client 401: description: Invalid Credentials 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/client responses: 200: description: The created resource schema: #/definitions/client 401: description: Invalid Credentials 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 – 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: array items: #/definitions/client 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/client/{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/client responses: 200: description: Ok schema: #/definitions/client 401: description: Invalid Credentials 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/client responses: 200: description: Ok schema: #/definitions/client 401: description: Invalid Credentials 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/client 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/client/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/client responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/user: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/user responses: 200: description: The created resource schema: #/definitions/user 401: description: Invalid Credentials 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/user responses: 200: description: The created resource schema: #/definitions/user 401: description: Invalid Credentials 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 – 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: array items: #/definitions/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/user/{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/user responses: 200: description: Ok schema: #/definitions/user 401: description: Invalid Credentials 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/user responses: 200: description: Ok schema: #/definitions/user 401: description: Invalid Credentials 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/user 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/user/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/user responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/blockedModules: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/blockedModules responses: 200: description: The created resource schema: #/definitions/blockedModules 401: description: Invalid Credentials 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/blockedModules responses: 200: description: The created resource schema: #/definitions/blockedModules 401: description: Invalid Credentials 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 – 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: array items: #/definitions/blockedModules 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/blockedModules/{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/blockedModules responses: 200: description: Ok schema: #/definitions/blockedModules 401: description: Invalid Credentials 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/blockedModules responses: 200: description: Ok schema: #/definitions/blockedModules 401: description: Invalid Credentials 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/blockedModules 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/blockedModules/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/blockedModules responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contact: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact 401: description: Invalid Credentials 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/contact responses: 200: description: The created resource schema: #/definitions/contact 401: description: Invalid Credentials 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 – 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: array items: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contact/{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/contact responses: 200: description: Ok schema: #/definitions/contact 401: description: Invalid Credentials 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/contact responses: 200: description: Ok schema: #/definitions/contact 401: description: Invalid Credentials 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/contact 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contact/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/address: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/address responses: 200: description: The created resource schema: #/definitions/address 401: description: Invalid Credentials 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/address responses: 200: description: The created resource schema: #/definitions/address 401: description: Invalid Credentials 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 – 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: array items: #/definitions/address 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/address/{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/address responses: 200: description: Ok schema: #/definitions/address 401: description: Invalid Credentials 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/address responses: 200: description: Ok schema: #/definitions/address 401: description: Invalid Credentials 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/address 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/address/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/address responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/phone: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/phone responses: 200: description: The created resource schema: #/definitions/phone 401: description: Invalid Credentials 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/phone responses: 200: description: The created resource schema: #/definitions/phone 401: description: Invalid Credentials 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 – 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: array items: #/definitions/phone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/phone/{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/phone responses: 200: description: Ok schema: #/definitions/phone 401: description: Invalid Credentials 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/phone responses: 200: description: Ok schema: #/definitions/phone 401: description: Invalid Credentials 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/phone 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/phone/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/phone responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/legalDocument: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/legalDocument responses: 200: description: The created resource schema: #/definitions/legalDocument 401: description: Invalid Credentials 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/legalDocument responses: 200: description: The created resource schema: #/definitions/legalDocument 401: description: Invalid Credentials 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 – 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: array items: #/definitions/legalDocument 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/legalDocument/{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/legalDocument responses: 200: description: Ok schema: #/definitions/legalDocument 401: description: Invalid Credentials 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/legalDocument responses: 200: description: Ok schema: #/definitions/legalDocument 401: description: Invalid Credentials 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/legalDocument 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/legalDocument/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/legalDocument responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billet: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/billet responses: 200: description: The created resource schema: #/definitions/billet 401: description: Invalid Credentials 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/billet responses: 200: description: The created resource schema: #/definitions/billet 401: description: Invalid Credentials 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 – 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: array items: #/definitions/billet 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billet/{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/billet responses: 200: description: Ok schema: #/definitions/billet 401: description: Invalid Credentials 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/billet responses: 200: description: Ok schema: #/definitions/billet 401: description: Invalid Credentials 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/billet 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billet/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/billet responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/requestDuplicate: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/requestDuplicate responses: 200: description: The created resource schema: #/definitions/requestDuplicate 401: description: Invalid Credentials 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/requestDuplicate responses: 200: description: The created resource schema: #/definitions/requestDuplicate 401: description: Invalid Credentials 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 – 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: array items: #/definitions/requestDuplicate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/requestDuplicate/{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/requestDuplicate responses: 200: description: Ok schema: #/definitions/requestDuplicate 401: description: Invalid Credentials 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/requestDuplicate responses: 200: description: Ok schema: #/definitions/requestDuplicate 401: description: Invalid Credentials 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/requestDuplicate 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/requestDuplicate/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/requestDuplicate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/tracking: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tracking responses: 200: description: The created resource schema: #/definitions/tracking 401: description: Invalid Credentials 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/tracking responses: 200: description: The created resource schema: #/definitions/tracking 401: description: Invalid Credentials 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 – 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: array items: #/definitions/tracking 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/tracking/{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/tracking responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials 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/tracking responses: 200: description: Ok schema: #/definitions/tracking 401: description: Invalid Credentials 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/tracking 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/tracking/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tracking responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/product: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials 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/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials 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 – 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: array items: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/product/{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/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials 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/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials 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/product 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/product/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/agent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/agent responses: 200: description: The created resource schema: #/definitions/agent 401: description: Invalid Credentials 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/agent responses: 200: description: The created resource schema: #/definitions/agent 401: description: Invalid Credentials 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 – 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: array items: #/definitions/agent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/agent/{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/agent responses: 200: description: Ok schema: #/definitions/agent 401: description: Invalid Credentials 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/agent responses: 200: description: Ok schema: #/definitions/agent 401: description: Invalid Credentials 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/agent 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/agent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/agent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contract: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contract responses: 200: description: The created resource schema: #/definitions/contract 401: description: Invalid Credentials 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/contract responses: 200: description: The created resource schema: #/definitions/contract 401: description: Invalid Credentials 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 – 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: array items: #/definitions/contract 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contract/{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/contract responses: 200: description: Ok schema: #/definitions/contract 401: description: Invalid Credentials 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/contract responses: 200: description: Ok schema: #/definitions/contract 401: description: Invalid Credentials 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/contract 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contract/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contract responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contractItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contractItem responses: 200: description: The created resource schema: #/definitions/contractItem 401: description: Invalid Credentials 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/contractItem responses: 200: description: The created resource schema: #/definitions/contractItem 401: description: Invalid Credentials 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 – 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: array items: #/definitions/contractItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contractItem/{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/contractItem responses: 200: description: Ok schema: #/definitions/contractItem 401: description: Invalid Credentials 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/contractItem responses: 200: description: Ok schema: #/definitions/contractItem 401: description: Invalid Credentials 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/contractItem 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/contractItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contractItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/upgradeRequest: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/upgradeRequest responses: 200: description: The created resource schema: #/definitions/upgradeRequest 401: description: Invalid Credentials 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/upgradeRequest responses: 200: description: The created resource schema: #/definitions/upgradeRequest 401: description: Invalid Credentials 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 – 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: array items: #/definitions/upgradeRequest 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/upgradeRequest/{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/upgradeRequest responses: 200: description: Ok schema: #/definitions/upgradeRequest 401: description: Invalid Credentials 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/upgradeRequest responses: 200: description: Ok schema: #/definitions/upgradeRequest 401: description: Invalid Credentials 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/upgradeRequest 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/upgradeRequest/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/upgradeRequest responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/bpmControll: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/bpmControll responses: 200: description: The created resource schema: #/definitions/bpmControll 401: description: Invalid Credentials 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/bpmControll responses: 200: description: The created resource schema: #/definitions/bpmControll 401: description: Invalid Credentials 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 – 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: array items: #/definitions/bpmControll 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/bpmControll/{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/bpmControll responses: 200: description: Ok schema: #/definitions/bpmControll 401: description: Invalid Credentials 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/bpmControll responses: 200: description: Ok schema: #/definitions/bpmControll 401: description: Invalid Credentials 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/bpmControll 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/bpmControll/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/bpmControll responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/upgradeRequestItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/upgradeRequestItem responses: 200: description: The created resource schema: #/definitions/upgradeRequestItem 401: description: Invalid Credentials 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/upgradeRequestItem responses: 200: description: The created resource schema: #/definitions/upgradeRequestItem 401: description: Invalid Credentials 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 – 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: array items: #/definitions/upgradeRequestItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/upgradeRequestItem/{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/upgradeRequestItem responses: 200: description: Ok schema: #/definitions/upgradeRequestItem 401: description: Invalid Credentials 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/upgradeRequestItem responses: 200: description: Ok schema: #/definitions/upgradeRequestItem 401: description: Invalid Credentials 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/upgradeRequestItem 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/upgradeRequestItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/upgradeRequestItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billingDataItem: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/billingDataItem responses: 200: description: The created resource schema: #/definitions/billingDataItem 401: description: Invalid Credentials 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/billingDataItem responses: 200: description: The created resource schema: #/definitions/billingDataItem 401: description: Invalid Credentials 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 – 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: array items: #/definitions/billingDataItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billingDataItem/{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/billingDataItem responses: 200: description: Ok schema: #/definitions/billingDataItem 401: description: Invalid Credentials 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/billingDataItem responses: 200: description: Ok schema: #/definitions/billingDataItem 401: description: Invalid Credentials 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/billingDataItem 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/billingDataItem/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/billingDataItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/role: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/role responses: 200: description: The created resource schema: #/definitions/role 401: description: Invalid Credentials 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/role responses: 200: description: The created resource schema: #/definitions/role 401: description: Invalid Credentials 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 – 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: array items: #/definitions/role 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/role/{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/role responses: 200: description: Ok schema: #/definitions/role 401: description: Invalid Credentials 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/role responses: 200: description: Ok schema: #/definitions/role 401: description: Invalid Credentials 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/role 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/role/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/role responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/permission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/permission responses: 200: description: The created resource schema: #/definitions/permission 401: description: Invalid Credentials 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/permission responses: 200: description: The created resource schema: #/definitions/permission 401: description: Invalid Credentials 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 – 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: array items: #/definitions/permission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/permission/{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/permission responses: 200: description: Ok schema: #/definitions/permission 401: description: Invalid Credentials 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/permission responses: 200: description: Ok schema: #/definitions/permission 401: description: Invalid Credentials 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/permission 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/permission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/permission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/serviceMenuPermission: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/serviceMenuPermission responses: 200: description: The created resource schema: #/definitions/serviceMenuPermission 401: description: Invalid Credentials 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/serviceMenuPermission responses: 200: description: The created resource schema: #/definitions/serviceMenuPermission 401: description: Invalid Credentials 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 – 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: array items: #/definitions/serviceMenuPermission 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/serviceMenuPermission/{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/serviceMenuPermission responses: 200: description: Ok schema: #/definitions/serviceMenuPermission 401: description: Invalid Credentials 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/serviceMenuPermission responses: 200: description: Ok schema: #/definitions/serviceMenuPermission 401: description: Invalid Credentials 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/serviceMenuPermission 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /client_area/entities/serviceMenuPermission/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/serviceMenuPermission responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: typeAddress: description: Tipo de endereço type: string enum: – COMERCIAL – SHIPPING – BILLING healthcheckDTO: description: HealthCheck Enum type: string enum: – UP – DOWN typeProductItem: description: Tipo de item de Produto na listagem type: string enum: – MODULO – FLUTUANTE typeBpm: description: Tipo de item de Produto na listagem type: string enum: – PADRAO – MANUAL – RATEIO – MANUAL_MEGA typePhone: description: Tipo de telefone type: string enum: – COMERCIAL – RESIDENTIAL – FINANCIAL statusBillet: description: Status do Boleto type: string enum: – CREDIT_BUREAU – NEGOTIATION – LAWYER – EXPIRED – DUE – REGISTRY – ENCONTRO – TAXES – JURIDICAL – PROTESTED – REPRESENTATIVE – SUSPENDED – INTERNAL – EXTERNAL – CANCELED – PREPARATION – CHARGING – PAID – SUBSTITUTED paymentMethod: description: Forma de pagamento type: string enum: – UNDEFINED – DEPOSIT – CHECK – BILLET – CASH – DEBIT_CARD – CREDIT_CARD – CAIXA – EXTRA statusRequestDuplicate: description: Forma de pagamento type: string enum: – REQUESTED – GENERATED – ERROR – OTHER typeRequestDuplicate: description: Tipo da solicitação da segunda via type: string enum: – BILLET – LEGAL_DOCUMENT typeTracking: description: Tipo de rastreamento type: string enum: – REQUEST_DUPLICATE_BILLET – REQUEST_DUPLICATE_LEGAL_DOCUMENT – REGISTRATION_UPDATE – REGISTRATION_UPDATE_CONTACT – FIRST_ACCESS – ACCESS_FINANCIAL_INFO – ACCESS_SYSTEM_CENTRAL – ACCESS_USERS_CONFIGURATION – ACCESS_ROLES_CONFIGURATION – ACCESS_REGISTRATION_INFO – ACCESS_CONTRACT_UPGRADE – LEGAL_DOCUMENTS_HISTORIC_INTEGRATED – BILLETS_HISTORIC_INTEGRATED – CONTRACTS_HISTORIC_INTEGRATED – CONTRACTS_ITENS_HISTORIC_INTEGRATED – REQUEST_BILLING_STATEMENT – REQUEST_PROPRIETARY_KEY – REQUEST_FTP_DOWNLOAD_LINK – REQUEST_GENERATE_NEW_PASSWORD – REQUEST_CUSTOMIZE_CONTROL – REQUEST_REDEFINE_PASSWORD_USERS_CONFIGURATION – ACTIVATE_USER_USERS_CONFIGURATION – DEACTIVATE_USER_USERS_CONFIGURATION – RESEND_EMAIL_USERS_CONFIGURATION – ACCESS_MY_SERVICES – REQUEST_DOWNLOAD_PDF statusOrder: description: Status do pedido type: string enum: – SYNCHRONIZING – IN_REVIEW – IN_PROGRESS – FINISHED – CANCELED – ERROR – DRAFT productUseRate: description: Taxa de uso de um produto type: string enum: – FREE – UNLIMITED – LIMITED permissionType: description: Tipos de permissões type: string enum: – PAGE – ACTION – AGGREGATE permissionKey: description: Chave das permissões type: string enum: – ALL – ALL_EXCEPT_USER_CREATION – FINANCIAL – FINANCIAL_REQUEST_BILLET_COPY – FINANCIAL_REQUEST_LEGAL_DOCUMENT – FINANCIAL_REQUEST_FINANCIAL_REVISION – FINANCIAL_REQUEST_BILLING_STATEMENT – COMPANY_REGISTRY – COMPANY_REGISTRY_EDIT_COMPANY – COMPANY_REGISTRY_LIST_CONTACTS – COMPANY_REGISTRY_CREATE_CONTACTS – COMPANY_REGISTRY_EDIT_CONTACTS – MY_CONTRACT – UPGRATE_REQUEST – UPGRATE_REQUEST_NEW_REQUEST_UPGRADE – UPGRATE_REQUEST_VIEW_RESUME – CENTRAL_SETTINGS – CENTRAL_SETTINGS_DOWNLOAD_PROPRIETARY – CENTRAL_SETTINGS_ENVIRONMENT_UPDATING – CENTRAL_SETTINGS_PASSWORD_CUSTOMIZE – CENTRAL_SETTINGS_CUSTOMIZE_CONTROL – MY_SERVICES – CONFIGURATION – CONFIGURATION_CREATE_USER – CONFIGURATION_REDEFINE_PASSWORD – CONFIGURATION_DISABLE_USER – CONFIGURATION_MANAGE_USER_ROLES – CONFIGURATION_MANAGE_USER_COMPANIES – CONFIGURATION_RESEND_USER_CONFIRMATION_EMAIL – CONFIGURATION_ROLES_CREATE_ROLE – CONFIGURATION_ROLES_EDIT_ROLE – CONFIGURATION_ROLES_DISABLE_ROLE – CONFIGURATION_ROLES_DELETE_ROLE – ADMIN_USER 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 fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR RecGetRoleCustom: description: type: object required: – name – description – permissions – clients – users properties: name: type: string description: description: type: string description: permissions: type: array items: type: object allOf: – #/definitions/RecListId minimum: 1 description: clients: type: array items: type: object allOf: – #/definitions/RecListId minimum: 1 description: users: type: array items: type: object allOf: – #/definitions/RecListId minimum: 1 description: RecListId: description: type: object required: – id properties: id: type: string description: RecFlowReset: description: type: object required: – codigoERP – nome – cloud – acesso – flow properties: codigoERP: type: string description: nome: type: string description: cloud: type: string description: acesso: type: string description: flow: type: string description: RecDepartmentsAndRolesCRM: description: type: object required: – id – nome properties: id: type: integer format: int64 description: nome: type: string description: checkDTO: description: type: object RecLegalDocumentHistoric: description: type: object required: – CODEMP – CODFIL – NUMNFV – CODSNF – CODCLI – VLRFIN – DATEMI – HOREMI – USU_LINKNF – USU_INSTNF – USU_DATEMI – USU_HOREMI properties: CODEMP: type: string description: CODFIL: type: string description: NUMNFV: type: string description: CODSNF: type: string description: CODCLI: type: string description: VLRFIN: type: string description: DATEMI: type: string description: HOREMI: type: string description: USU_LINKNF: type: string description: USU_INSTNF: type: string description: USU_DATEMI: type: string description: USU_HOREMI: type: string description: RecBilletHistoric: description: type: object required: – CODEMP – CODFIL – NUMTIT – CODTPT – TITBAN – CODPOR – CODCLI – DATEMI – VCTPRO – VLRABE – VLRORI – CODFPG – SITTIT – USU_LINDIG – USU_DATBOL – USU_HORBOL – ORISUB – FILNFV – CODSNF – NUMNFV – NUMDFS properties: CODEMP: type: string description: CODFIL: type: string description: NUMTIT: type: string description: CODTPT: type: string description: TITBAN: type: string description: CODPOR: type: string description: CODCLI: type: string description: DATEMI: type: string description: VCTPRO: type: string description: VLRABE: type: string description: VLRORI: type: string description: CODFPG: type: string description: SITTIT: type: string description: USU_LINDIG: type: string description: USU_DATBOL: type: string description: USU_HORBOL: type: string description: ORISUB: type: string description: FILNFV: type: string description: CODSNF: type: string description: NUMNFV: type: string description: NUMDFS: type: string description: RecContractHistoric: description: type: object required: – CODEMP – CODFIL – NUMCTR – DATEMI – SITCTR – CODREP properties: CODEMP: type: string description: companyCode CODFIL: type: string description: branchCode NUMCTR: type: string description: number DATEMI: type: string description: emissionDate SITCTR: type: string description: status CODREP: type: string description: agent – integrationCode RecContractItemHistoric: description: type: object required: – CODEMP – CODFIL – NUMCTR – SITCVS – CODSER – CODFAM – USU_QTDPTO – USU_QTDUSU – USU_USUVET – PREPAD – PREUNI properties: CODEMP: type: string description: contractCompanyCode CODFIL: type: string description: contractBranchCode NUMCTR: type: string description: contractNumber SITCVS: type: string description: status CODSER: type: string description: CODFAM: type: string description: USU_QTDPTO: type: string description: USU_QTDUSU: type: string description: USU_USUVET: type: string description: PREPAD: type: string description: preco padrao PREUNI: type: string description: preco unitario recContratosCliente: description: type: object required: – CLIFAT – CODEMP – CODFIL – NUMCTR – SEQCVS – CODCLI – TIPCTR – INIVIG – FIMVIG – ULTREA – DATEMI – CODREP – DIAPAR – SITCTR – USU_NUMEST – CODSER – USU_CODAGRSER – USU_CODMODCOM – USU_QTDPTO – USU_QTDUSU – USU_USUVET – PREUNI – CPLCVS – SITCVS – CODMOT – DATUFT – CODFAM – DESMOE properties: CLIFAT: type: string description: CODEMP: type: string description: CODFIL: type: string description: NUMCTR: type: string description: SEQCVS: type: string description: CODCLI: type: string description: TIPCTR: type: string description: INIVIG: type: string description: FIMVIG: type: string description: ULTREA: type: string description: DATEMI: type: string description: CODREP: type: string description: DIAPAR: type: string description: SITCTR: type: string description: USU_NUMEST: type: string description: CODSER: type: string description: USU_CODAGRSER: type: string description: USU_CODMODCOM: type: string description: USU_QTDPTO: type: string description: USU_QTDUSU: type: string description: USU_USUVET: type: string description: PREUNI: type: string description: CPLCVS: type: string description: SITCVS: type: string description: CODMOT: type: string description: DATUFT: type: string description: CODFAM: type: string description: DESMOE: type: string description: recContractMenu: description: type: object required: – NUMCTR – CODCLI – SITCTR – CODSER – USU_USUVET – USU_QTDPTO – USU_QTDUSU – SITCVS – CODFAM – USU_CODAGRSER – USU_DESAGRSER – USU_CODPROD – USU_DESCPROD – USU_CODAGR – USU_DESCAGRUP properties: NUMCTR: type: string description: CODCLI: type: integer format: int64 description: SITCTR: type: string description: CODSER: type: string description: USU_USUVET: type: integer format: int64 description: USU_QTDPTO: type: integer format: int64 description: USU_QTDUSU: type: integer format: int64 description: SITCVS: type: string description: CODFAM: type: string description: USU_CODAGRSER: type: integer format: int64 description: USU_DESAGRSER: type: string description: USU_CODPROD: type: integer format: int64 description: USU_DESCPROD: type: string description: USU_CODAGR: type: integer format: int64 description: USU_DESCAGRUP: type: string description: recAgrupadores: description: type: object required: – USU_CODAGRSER – USU_DESAGRSER – USU_PROAGRSER – USU_INDNOVOFE – USU_VALNOVOFE – USU_INTCON – USU_INDHARD – USU_UNIMED – USU_INDINST – USU_SITAGR – USU_CODUNI – USU_CODAGR – USU_DESCAGRUP properties: USU_CODAGRSER: type: string description: USU_DESAGRSER: type: string description: USU_PROAGRSER: type: string description: USU_INDNOVOFE: type: string description: USU_VALNOVOFE: type: string description: USU_INTCON: type: string description: USU_INDHARD: type: string description: USU_UNIMED: type: string description: USU_INDINST: type: string description: USU_SITAGR: type: string description: USU_CODUNI: type: string description: USU_CODAGR: type: string description: USU_DESCAGRUP: type: string description: recGetDataFtp: description: type: object required: – name – type – lastModifiedDate properties: name: type: string description: type: type: string description: lastModifiedDate: type: string description: recFilesFtp: description: type: object required: – name – path properties: name: type: string description: path: type: string description: recIdNF: description: type: object properties: codEmp: type: integer format: int64 description: codFil: type: integer format: int64 description: codSnf: type: string description: numNfv: type: integer format: int64 description: recClientAccessEnvironmentUpdating: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Identificador do cliente permissionId: type: string description: Tipo de permissão recPermissionEnvironmentUpdating: description: type: object properties: id: type: string description: Identificador único permission: type: string description: Tipo de permissão description: type: string description: descrição da permissão recUpdateServiceMenuPermission: description: type: object properties: id: type: string description: Identificador único agentId: type: string description: Dados do representante recUpdateBilletRules: description: type: object properties: id: type: string description: Identificador único billetType: type: string description: tipo de boleto visible: type: boolean description: deve mostrar ou não na tela haveNf: type: boolean description: possui nota fiscal state: type: string description: estado da NF recUpdateUsers: description: type: object properties: id: type: string description: Identificador único email: type: string description: email currentClient: type: string description: Client Atual isActive: type: string description: Status Usuário isIntegrationUser: type: string description: Define se este usuário veio proveniente da integração ERP primaryEmail: type: string description: Indica qual é o conglomerado de empresas que esse usuário faz parte isMaster: type: string description: Indica se este usuário é master onBehalfOf: type: string description: Se o usuário for master, em nome de qual usuário está fazendo acesso quantidadeLogs: type: string description: Quantidade de vezes que o usuario logou recUpdateUpgradeRequestItem: description: type: object properties: id: type: string description: Identificador único upgradeRequestId: type: string description: Solicitação de upgrade productId: type: string description: Produto solicitado fromAmount: type: string description: Quantidade corrente toAmount: type: string description: Quantidade solicitada groupName: type: string description: Nome do grupo no momento que foi feita a solicitação familyName: type: string description: Nome da família no momento que foi feita a solicitação cdBaseCalc: type: string description: cdModal: type: string description: vlMonthly: type: string description: vlHabilitation: type: string description: vlMonthlyWithTax: type: string description: vlHabilitationWithTax: type: string description: isFloating: type: string description: vlGross: type: string description: percentageDiscount: type: string description: vlGrossWithCoupon: type: string description: note: type: string description: recUpdateUpgradeRequest: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Cliente contactId: type: string description: Contato bpmRequestId: type: string description: Identificador único da solicitação de upgrade de contrato requestDate: type: string description: Data de solicitação note: type: string description: Observação financialNote: type: string description: Observação financeira status: type: string allOf: – #/definitions/statusOrder description: Status licenseEmail: type: string description: E-mail da proprietária cdPayment: type: string description: cdCondition: type: string description: hasApportionment: type: string description: bpmControllId: type: string description: erpRec: type: string description: couponCod: type: string description: recUpdateTracking: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Dados do cliente type: type: string allOf: – #/definitions/typeTracking description: Tipo typeId: type: string description: Identificador único do tipo recUpdateRole: description: type: object properties: id: type: string description: Identificador único name: type: string description: Nome do papel description: type: string description: Descrição do papel status: type: string description: Situação do papel ((True-Ativo, False-Inativo) primaryEmail: type: string description: Vínculo com dados de integração systemData: type: string description: Registro não removível recUpdateRequestDuplicate: description: type: object properties: id: type: string description: Identificador único billetId: type: string description: Dados do boleto legalDocumentId: type: string description: Dados da nota fiscal userId: type: string description: Dados do usuário requestedDate: type: string description: Data da solicitação receiveDate: type: string description: Data do recebimento status: type: string allOf: – #/definitions/statusRequestDuplicate description: Status recUpdateProduct: description: type: object properties: id: type: string description: Identificador único integrationCode: type: string description: Código de integração name: type: string description: Nome description: type: string description: Descrição family: type: string description: Família status: type: string description: Situação do produto ((True-Ativo, False-Inativo) recUpdatePhone: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Dados do cliente contactId: type: string description: Dados do Contato type: type: string allOf: – #/definitions/typePhone description: Tipo (Comercial, Residential ou Financial) phone: type: string maxLength: 20 description: Telefone phoneExtension: type: string description: Ramal recUpdatePermission: description: type: object properties: id: type: string description: Identificador único permissionKey: type: string allOf: – #/definitions/permissionKey description: Chave da permissão type: type: string allOf: – #/definitions/permissionType description: Tipo de permissão parent: type: string allOf: – #/definitions/permissionKey description: Vinculo da permissão quando é do tipo action recUpdateLegalDocument: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Dados do cliente companyCode: type: string description: Empresa branchCode: type: string description: Filial number: type: string description: Número numberExt: type: string maxLength: 3 description: Número de serie da nota fiscal value: type: string description: Valor emissionLink: type: string maxLength: 300 description: Link de emissão linkInstruction: type: string maxLength: 300 description: Instrução da nota fiscal emissionDate: type: string description: Data de emissão recUpdateContractItem: description: type: object properties: id: type: string description: Identificador único contractId: type: string description: Código do contrato productId: type: string description: Código do produto quantity: type: string description: Quantidade contratada status: type: string description: Situação do item do contrato ((True-Ativo, False-Inativo) precoPadrao: type: string description: Preco Padrao precoUnitario: type: string description: Preco Unitario recUpdateContract: description: type: object properties: id: type: string description: Identificador único companyCode: type: string description: Empresa branchCode: type: string description: Filial number: type: string description: Número clientId: type: string description: Dados do cliente agentId: type: string description: Dados do representante emissionDate: type: string description: Data de emissão status: type: string description: Situação do contrato ((True-Ativo, False-Inativo) recUpdateContact: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Identificação do cliente integrationOrder: type: string description: Sequencial do contato name: type: string maxLength: 150 description: Nome do contato birthDate: type: string description: Data de nascimento department: type: string maxLength: 30 description: Setor na empresa role: type: string maxLength: 50 description: Cargo email: type: string maxLength: 100 description: Email status: type: string description: Situação do contato ((True-Ativo, False-Inativo) note: type: string maxLength: 250 description: Observação integrationDate: type: string description: Data de integração recUpdateBpmControll: description: type: object properties: id: type: string description: Identificador único allocatedId: type: string description: Id geral do BPM (entre todos os BPM juntos) processId: type: string description: Id normal de processo de BPM (retorno do envio) typeBpm: type: string description: Enum de tipo de BPM enviado businessJson: type: string description: Json enviado bpmStatus: type: string description: Status do BPM recUpdateBillingDataItem: description: type: object properties: id: type: string description: Identificador único upgradeRequestId: type: string description: Solicitação de upgrade trade: type: string description: trade company email: type: string description: email cnpj: type: string description: cnpj da hold apportionment: type: string description: valor rateio recUpdateBillet: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Dados do cliente legalDocumentId: type: string description: Nota Fiscal branchCode: type: string description: Filial paymentNumber: type: string maxLength: 15 description: Número do título paymentType: type: string maxLength: 3 description: Tipo do título code: type: string maxLength: 20 description: Código dueDate: type: string description: Vencimento status: type: string allOf: – #/definitions/statusBillet description: Status barcode: type: string maxLength: 48 description: Código de barras emissionDate: type: string description: Data de emissão emissionDuplicateDate: type: string description: Data de emissão da segunda via paymentPrice: type: string description: Valor do título paymentMethod: type: string allOf: – #/definitions/paymentMethod description: Forma de pagamento bankCode: type: string maxLength: 4 description: Código do portador numberDfs: type: string description: Codigo da nota fiscal recUpdateAgent: description: type: object properties: id: type: string description: Identificador único integrationCode: type: string description: Código de integração name: type: string description: Nome status: type: string description: Situação do agente ((True-Ativo, False-Inativo) recUpdateAddress: description: type: object properties: id: type: string description: Identificador único clientId: type: string description: Dados do cliente type: type: string allOf: – #/definitions/typeAddress description: Tipo (COMERCIAL, SHIPPING OU BILLING) cpfCnpj: type: string description: CPF ou CNPJ stateRegistration: type: string maxLength: 25 description: Inscrição Estadual municipalRegistration: type: string maxLength: 16 description: Inscrição Municipal address: type: string maxLength: 100 description: Endereço number: type: string maxLength: 60 description: Número complement: type: string maxLength: 200 description: Complemento do endereço landmark: type: string maxLength: 120 description: Ponto de referência neighborhood: type: string maxLength: 75 description: Bairro zipCode: type: string description: CEP city: type: string maxLength: 75 description: Cidade state: type: string maxLength: 75 description: Estado recUpdateClient: description: type: object properties: id: type: string description: Identificador único integrationCode: type: string description: Código de identificação interna companyName: type: string maxLength: 100 description: Nome trade: type: string maxLength: 50 description: Nome fantasia primaryEmail: type: string maxLength: 100 description: Email principal contractEmail: type: string maxLength: 250 description: Email de contratos legalDocumentEmail: type: string maxLength: 250 description: Email de nota fiscal billingEmail: type: string maxLength: 250 description: Email de documentos eletronicos website: type: string maxLength: 30 description: Website integrationDate: type: string description: Data de integração allowed: type: string description: Permir fluxo novo floatingQuantity: type: string description: Quantidade Flutuante projectCode: type: string description: Código do projeto usersId: type: array items: type: string description: Usuários recClientConnect: description: type: object required: – id_erp – nomeFantasia – razaoSocial – CNPJ – cnpjFaturaContra – idGrupoEconomico – grupo_economico – principalGrupoEconomico – endereco – bairro – municipio – estado – pais – cep – STATUS – ATIVOPORTALCLIENTE – data_alteracao – data_cadastro – tipo – ramoAtividade – canal – bloqueio properties: id_erp: type: string description: Código do cliente nomeFantasia: type: string description: Nome fantasia razaoSocial: type: string description: Company name CNPJ: type: string description: Cnpj cnpjFaturaContra: type: string description: Cnpj que fatura contra idGrupoEconomico: type: string description: Id do grupo economico grupo_economico: type: string description: Grupo economico principalGrupoEconomico: type: string description: Principal grupo economico endereco: type: string description: Endereço bairro: type: string description: Bairro municipio: type: string description: Municipio estado: type: string description: Estado pais: type: string description: Pais cep: type: string description: Cep STATUS: type: string description: Status ATIVOPORTALCLIENTE: type: string description: Se é ativo no portal do cliente data_alteracao: type: string description: Data de alteração data_cadastro: type: string description: Data de cadastro tipo: type: string description: Tipo ramoAtividade: type: string description: Ramo da atividade canal: type: string description: Se é canal bloqueio: type: string description: recGetCoupon: description: type: object required: – code – amountOfCoupons – usePerCustomer – isShippingDiscount – name – referenceCode – discountType – discountValue – minimumValue – maximumValue – startDate – endDate – customerType – criteria – onlyDefaultCriteria – createdAt – updatedAt properties: code: type: string description: amountOfCoupons: type: number format: double description: usePerCustomer: type: number format: double description: isShippingDiscount: type: boolean description: name: type: string description: referenceCode: type: string description: discountType: type: string description: discountValue: type: number format: double description: minimumValue: type: number format: double description: maximumValue: type: number format: double description: startDate: type: string description: endDate: type: string description: customerType: type: string description: criteria: type: string description: onlyDefaultCriteria: type: boolean description: createdAt: type: string description: updatedAt: type: string description: recCouponProductValues: description: type: object required: – quantity – initialQuantity – monthlyValue – licenseValue – monthlyValueWithTax – licenseValueWithTax properties: quantity: type: integer format: int64 description: initialQuantity: type: integer format: int64 description: monthlyValue: type: number format: double description: licenseValue: type: number format: double description: monthlyValueWithTax: type: number format: double description: licenseValueWithTax: type: number format: double description: recProductValues: description: type: object required: – productId – module – floating properties: productId: type: string description: Id do produto productIdAlt: type: string description: Id do produto com flutuante couponInfo: type: object allOf: – #/definitions/recGetCoupon description: Informações do cupom module: type: object allOf: – #/definitions/recCouponProductValues description: Módulos floating: type: object allOf: – #/definitions/recCouponProductValues description: Floating discountValue: type: number format: double description: Valor do desconto totalValueWithDiscount: type: number format: double description: Valor total com desconto recUpgradeRequestItem: description: type: object required: – fromAmount – toAmount – type – product – upgradeRequestId properties: id: type: string description: Identificador único productId: type: string description: Produto solicitado fromAmount: type: integer format: int64 description: Quantidade corrente toAmount: type: integer format: int64 description: Quantidade solicitada groupName: type: string description: Nome do grupo no momento que foi feita a solicitação familyName: type: string description: Nome da família no momento que foi feita a solicitação type: type: string description: Tipo do item product: type: object allOf: – #/definitions/recProduct description: produto do item do upgrade monthlyValue: type: number format: double description: valor mensalidade habilitationValue: type: number format: double description: valor habilitacao monthlyValueWithTax: type: number format: double description: valor mensalidade com taxas licenseValueWithTax: type: number format: double description: valor licenca com taxas upgradeRequestId: type: string description: id do upgradeRequest quando este já foi salvo no banco licenseValueWithoutCoupon: type: number format: double description: Valor total bruto discountPercentage: type: number format: double description: Porcentagem de desconto discountValue: type: number format: double description: Valor de desconto createdDate: type: string format: date-time description: Data de criação note: type: string description: observacao do item recGenericUpdateValues: description: Valores do genericUpdate type: object required: – value – type properties: value: type: string description: type: type: string description: recBillingRevaluation: description: Dados da reavaliação type: object required: – content – destination properties: content: type: object allOf: – #/definitions/content description: Conteúdo do e-mail source: type: string description: E-mail de origem do envio de e-mail destination: type: object allOf: – #/definitions/destination description: Destino do envio de e-mail origin: type: object allOf: – #/definitions/service description: Origem do envio de e-mail, se informado, será obtida a configuração de e-mail esta origem validate: type: boolean description: Indica se deverá fazer uma validação de forma síncrona da mensagem default: false upgradeResume: description: type: object required: – bpmRequestId – status – createdDate – trade – financialNote – name – phone – email – licenseEmail – items – note properties: bpmRequestId: type: integer format: int64 description: status: type: string description: createdDate: type: string description: trade: type: string description: financialNote: type: string description: name: type: string description: phone: type: string description: email: type: string description: licenseEmail: type: string description: items: type: array items: type: object allOf: – #/definitions/upgradeItemResume minimum: 1 description: note: type: string description: upgradeItemResume: description: type: object required: – itemId – description – familyName – fromAmount – toAmount – monthlyValue – habilitationValue – monthlyValueWithTax – licenseValueWithTax properties: itemId: type: string description: description: type: string description: familyName: type: string description: fromAmount: type: integer format: int64 description: toAmount: type: integer format: int64 description: monthlyValue: type: number format: double description: habilitationValue: type: number format: double description: monthlyValueWithTax: type: number format: double description: licenseValueWithTax: type: number format: double description: defaultSendBilling: description: Padrao envio emails type: object required: – content – destination properties: content: type: object allOf: – #/definitions/content description: Conteúdo do e-mail source: type: string description: E-mail de origem do envio de e-mail destination: type: object allOf: – #/definitions/destination description: Destino do envio de e-mail origin: type: object allOf: – #/definitions/service description: Origem do envio de e-mail, se informado, será obtida a configuração de e-mail esta origem validate: type: boolean description: Indica se deverá fazer uma validação de forma síncrona da mensagem default: false content: description: Conteúdo do e-mail type: object required: – body – subject properties: body: type: object allOf: – #/definitions/body description: Conteúdo do corpo subject: type: string description: Assunto do -email attachments: type: array items: type: object allOf: – #/definitions/attachment description: Anexos destination: description: Destino do e-mail type: object required: – to properties: to: type: array items: type: string minimum: 1 description: E-mails dos destinários cc: type: array items: type: string description: E-mails que serão adicionados em cópia bcc: type: array items: type: string description: E-mails que serão adicionados em cópia oculta service: description: Serviço de origem do envio type: object required: – domain – service properties: domain: type: string description: Domínio service: type: string description: Serviço attachment: description: Anexo type: object required: – name – url properties: name: type: string description: Nome do anexo url: type: string description: Localização do arquivo a ser anexado body: description: Corpo do conteúdo do e-mail type: object properties: html: type: string description: Conteúdo HTML text: type: string description: Conteúdo em formato text para dispositivos que não conseguem renderizar recGetAllUsersByClient: description: type: object required: – id – email properties: id: type: string description: email: type: string description: recGetAllClients: description: type: object required: – id – name – cpfCnpj – integrationCode properties: id: type: string description: name: type: string description: cpfCnpj: type: string description: integrationCode: type: string description: recClient: description: Dados do Client(cliente) type: object required: – integrationCode – companyName – trade – primaryEmail – contractEmail – legalDocumentEmail – billingEmail properties: id: type: string description: Identificador único do Cliente integrationCode: type: string description: Código de identificação interna companyName: type: string maxLength: 100 description: Nome trade: type: string maxLength: 50 description: Nome fantasia primaryEmail: type: string maxLength: 100 description: Email principal contractEmail: type: string maxLength: 250 description: Email de contratos legalDocumentEmail: type: string maxLength: 250 description: Email de nota fiscal billingEmail: type: string maxLength: 250 description: Email de documentos eletronicos website: type: string maxLength: 30 description: Web Site projectCode: type: string description: Código do cliente que aparece no zendesk(campo Projeto mega no crm) recCompleteClient: description: type: object required: – id – integrationCode – companyName – trade – primaryEmail – contractEmail – legalDocumentEmail – billingEmail – addresses – contacts – phones – allowed – createdDate properties: id: type: string description: Identificador único do Cliente integrationCode: type: string description: Código de integração companyName: type: string maxLength: 100 description: Nome trade: type: string maxLength: 50 description: Nome fantasia primaryEmail: type: string maxLength: 100 description: Email principal contractEmail: type: string maxLength: 250 description: Email de contratos legalDocumentEmail: type: string maxLength: 250 description: Email de nota fiscal billingEmail: type: string maxLength: 250 description: Email de documentos eletrônicos website: type: string maxLength: 30 description: Website addresses: type: array items: type: object allOf: – #/definitions/recAddress minimum: 1 description: Dados do endereço do usuario contacts: type: array items: type: object allOf: – #/definitions/recContactWithPhone minimum: 1 description: Contatos do cliente phones: type: array items: type: object allOf: – #/definitions/recPhone minimum: 1 description: Telefones do cliente allowed: type: boolean description: permitir fluxo novo createdDate: type: string description: Data de criação projectCode: type: string description: Código do cliente que aparece no zendesk(campo Projeto mega no crm) isGlobalTec: type: boolean description: cliente é globalTech hasMenuServicePermission: type: boolean description: permissao para acessar menu de serviços recServiceNow: description: Dados do ServiceNow type: object required: – CodigoCliente – QtdeProjetos properties: CodigoCliente: type: string description: codigo cliente ServiceNow QtdeProjetos: type: integer format: int64 description: quantidade de projetos ServiceNow recListServiceNowInput: description: Dados da lista de Projetos do ServiceNow input type: object required: – codigoProjeto – codigoPedido – codigoServico – descricaoServico – nomeProduto – estado properties: codigoProjeto: type: string description: codigo do projeto codigoPedido: type: string description: codigo do pedido codigoServico: type: string description: codigo do serviço descricaoServico: type: string description: descrição do serviço nomeProduto: type: string description: nome do produto estado: type: string description: estado do projeto recListServiceNowOutput: description: Dados da lista de Projetos do ServiceNow output type: object required: – idProject – idRequest – idService – serviceDescription – productName – status properties: idProject: type: string description: codigo do projeto idRequest: type: string description: codigo do pedido idService: type: string description: codigo do serviço serviceDescription: type: string description: descrição do serviço productName: type: string description: nome do produto status: type: string description: estado do projeto recDetailsServiceNowInput: description: dados dos detalhes dos projesto do ServiceNow input type: object required: – codigoProjeto – fase – estado – tipoServico – descricao – dataInicio – dataTermino – gerenteSenior – porcentagem properties: codigoProjeto: type: string description: codigo do projeto fase: type: string description: fase do projeto estado: type: string description: estado do projeto tipoServico: type: string description: tipo do serviço descricao: type: string description: descriçao dataInicio: type: string description: data do inicio dataTermino: type: string description: data do fim gerenteSenior: type: string description: gerente Senior porcentagem: type: string description: progresso do projeto recDetailsServiceNowOutput: description: dados dos detalhes dos projesto do ServiceNow output type: object required: – idProject – phase – status – serviceType – description – startDate – finishDate – manager – progress properties: idProject: type: string description: codigo do projeto phase: type: string description: fase do projeto status: type: string description: estado do projeto serviceType: type: string description: tipo do serviço description: type: string description: descriçao startDate: type: string description: data do inicio finishDate: type: string description: data do fim manager: type: string description: gerente Senior progress: type: string description: progresso do projeto recStatusProjectsServiceNow: description: type: object required: – notStarted – inProgress – suspended – closed – canceled properties: notStarted: type: integer format: int64 description: projeto nao iniciado inProgress: type: integer format: int64 description: projeto em andamento suspended: type: integer format: int64 description: projeto suspenso closed: type: integer format: int64 description: projeto encerrado canceled: type: integer format: int64 description: projeto cancelado recClientInfo: description: Dados do cliente type: object required: – id – companyName – trade – cpfCnpj properties: id: type: string description: identificador único companyName: type: string maxLength: 100 description: Nome trade: type: string maxLength: 50 description: Nome fantasia cpfCnpj: type: string description: CPF ou CNPJ recFiles: description: Files record type: object required: – name – file properties: name: type: string description: file: type: string description: recGetPermission: description: Permission record type: object required: – id – key – type properties: id: type: string description: key: type: string allOf: – #/definitions/permissionKey description: type: type: string allOf: – #/definitions/permissionType description: children: type: array items: type: object allOf: – #/definitions/recGetPermission description: recAddress: description: Dados do endereço type: object required: – type – address properties: id: type: string description: Identificador único do Endereço type: type: string allOf: – #/definitions/typeAddress description: Tipo (COMERCIAL, SHIPPING OU BILLING) cpfCnpj: type: string description: CPF ou CNPJ stateRegistration: type: string maxLength: 25 description: Inscrição Estadual municipalRegistration: type: string maxLength: 16 description: Inscrição Municipal address: type: string maxLength: 100 description: Endereço number: type: string maxLength: 60 description: Número complement: type: string maxLength: 200 description: Complemento do endereço landmark: type: string maxLength: 120 description: Ponto de referência neighborhood: type: string maxLength: 75 description: Bairro zipCode: type: integer format: int64 description: CEP city: type: string maxLength: 75 description: Cidade state: type: string maxLength: 75 description: Estado recPhone: description: Dados do telefone type: object required: – type – phone properties: id: type: string description: Identificador único do endereço clientId: type: string description: Dados do cliente contactId: type: string description: Dados do Contato type: type: string allOf: – #/definitions/typePhone description: Tipo (Comercial, Residential ou Financial) phone: type: string maxLength: 20 description: Telefone phoneExtension: type: integer format: int64 description: Ramal recUserInfo: description: Dados para o UserInfo type: object required: – externalUserId – id – clients – email – firstName – lastName – companyName – trade – isAdmin – isActive – isMaster – isSenior properties: externalUserId: type: string description: ID deste usuário no servico external user id: type: string description: ID deste usuário no client-area clients: type: array items: type: object allOf: – #/definitions/recClientInfo minimum: 1 description: Dados do cliente currentClient: type: string description: Identificador único do cliente logado email: type: string description: email firstName: type: string description: Nome lastName: type: string description: Sobrenome companyName: type: string maxLength: 100 description: Nome do cliente trade: type: string maxLength: 50 description: Nome fantasia do cliente isAdmin: type: boolean description: Usuário administrador isActive: type: boolean description: Usuário está ativo isMaster: type: boolean description: Usuário é master isSenior: type: boolean description: Usuário admin recContact: description: Dados do contato type: object required: – name properties: id: type: string description: Identificador único do usuário clientId: type: string description: Identificação do cliente integrationOrder: type: integer format: int64 description: Sequencial do contato name: type: string maxLength: 150 description: Nome do contato birthDate: type: string format: date description: Data de nascimento department: type: string maxLength: 30 description: Setor na empresa role: type: string maxLength: 50 description: Cargo email: type: string maxLength: 100 description: Email status: type: boolean description: Situação do contato (True-Ativo, False-Inativo) default: true lastModifiedDate: type: string format: date description: Data da ultima atualização idDepartmentCrm: type: integer format: int64 description: Id do departamento no crm idRoleCrm: type: integer format: int64 description: Id do cargo no crm recContactWithPhone: description: Dados do contato type: object required: – name – email properties: id: type: string description: Identificador único do usuário clientId: type: string description: Identificação do cliente integrationOrder: type: integer format: int64 description: Sequencial do contato name: type: string maxLength: 150 description: Nome do contato birthDate: type: string format: date description: Data de nascimento department: type: string maxLength: 30 description: Setor na empresa role: type: string maxLength: 50 description: Cargo email: type: string maxLength: 100 description: Email status: type: boolean description: Situação do contato ((True-Ativo, False-Inativo) default: true lastModifiedDate: type: string format: date description: Data da ultima atualização phones: type: array items: type: object allOf: – #/definitions/recPhone description: Telefones recLegalDocument: description: Dados da nota fiscal type: object required: – clientIntegrationCode – companyCode – branchCode – number – numberExt properties: clientIntegrationCode: type: string description: Número de integração do cliente companyCode: type: integer format: int64 description: Empresa branchCode: type: integer format: int64 description: Filial number: type: integer format: int64 description: Número numberExt: type: string maxLength: 3 description: Número de serie da nota fiscal value: type: number format: double description: Valor emissionLink: type: string maxLength: 300 description: Link de emissão emissionDate: type: string format: date-time description: Data de emissão linkInstruction: type: string maxLength: 300 description: Instrução da nota fiscal recBillet: description: Dados do boleto type: object required: – paymentNumber – paymentType – dueDate – status – emissionDate – paymentPrice – paymentMethod – bankCode properties: branchCode: type: integer format: int64 description: Filial paymentNumber: type: string maxLength: 15 description: Número do título paymentType: type: string maxLength: 3 description: Tipo do título code: type: string maxLength: 20 description: Código dueDate: type: string format: date description: Vencimento status: type: string allOf: – #/definitions/statusBillet description: Status barcode: type: string maxLength: 48 description: Código de barras emissionDate: type: string format: date-time description: Data de emissão emissionDuplicateDate: type: string format: date-time description: Data de emissão da segunda via paymentPrice: type: number format: double description: Valor do título paymentMethod: type: string allOf: – #/definitions/paymentMethod description: Forma de pagamento bankCode: type: string maxLength: 4 description: Código do portador numberDfs: type: integer format: int64 description: Código nota fiscal recGetBillet: description: Dados do retorno na primitiva getBillet type: object required: – billetId – legalDocumentId – paymentMethod – status – dueDate – emissionDate – legalDocumentNumber – legalDocumentNumberExt – paymentNumber – bankCode properties: billetId: type: string description: id do boleto legalDocumentId: type: string description: id da nota fiscal paymentMethod: type: string allOf: – #/definitions/paymentMethod description: Forma de pagamento status: type: string allOf: – #/definitions/statusBillet description: Status value: type: number format: double description: Valor dueDate: type: string format: date description: Vencimento emissionDate: type: string format: date-time description: Data de emissão emissionDuplicateDate: type: string format: date-time description: Data de emissão da segunda via legalDocumentNumber: type: integer format: int64 description: Número legalDocumentNumberExt: type: string maxLength: 3 description: Número de serie da nota fiscal legalDocumentLinkInstruction: type: string maxLength: 300 description: Instrução da nota fiscal barcode: type: string maxLength: 48 description: Código de barras legalDocumentLink: type: string maxLength: 250 description: Link para a nota fiscal limitExceededBillet: type: boolean description: Limite de boleto excedido? default: false limitExceededLegalDocument: type: boolean description: Limite de nota fiscal excedido? default: false paymentNumber: type: string description: Numero do boleto numberDfs: type: integer format: int64 description: Código nota fiscal bankCode: type: string description: Código do banco branchCode: type: integer format: int64 description: Codigo da filial paymentType: type: string description: tipo de pagamento state: type: string description: Estado da nota recProduct: description: Dados do produto type: object required: – integrationCode – name – description properties: id: type: string description: id do produto integrationCode: type: string description: Sequencial do produto name: type: string maxLength: 70 description: Nome do produto description: type: string maxLength: 250 description: Descrição do produto status: type: boolean description: Situação do produto ((True-Ativo, False-Inativo) default: true activeProductItem: description: Registro de um produto ativo de um cliente type: object required: – productId – integrationCode – name – useRate – type – floatingQuantity properties: groupName: type: string description: Grupo no qual o produto pertence familyName: type: string description: Grupo no qual o produto pertence quantityUsuVet: type: integer format: int64 description: Quantidade Instancias Web – USU_USUVET quantity: type: integer format: int64 description: Quantidade colaboradores – USU_QTDPTO quantityUsu: type: integer format: int64 description: Quantidade usuários – USU_QTDUSU productId: type: string description: Identificador do produto integrationCode: type: string description: Código de integração name: type: string description: Nome do produto description: type: string description: Descrição useRate: type: string allOf: – #/definitions/productUseRate description: Taxa de uso do produto type: type: string allOf: – #/definitions/typeProductItem description: Tipo floatingQuantity: type: integer format: int64 description: Quantidade Flutuante do Cliente modality: type: string description: Qual a modalidade – SAAS MANUT VENDA contractNumber: type: string description: Numero do contrato do modulo recAgent: description: Dados do representante type: object required: – integrationCode – name properties: integrationCode: type: string description: Sequencial do agente name: type: string maxLength: 100 description: Nome do agente status: type: boolean description: Situação do agente ((True-Ativo, False-Inativo) default: true recContract: description: Dados do contrato type: object required: – companyCode – branchCode – number – emissionDate properties: companyCode: type: integer format: int64 description: Empresa branchCode: type: integer format: int64 description: Filial number: type: integer format: int64 description: Número emissionDate: type: string format: date-time description: Data de emissão status: type: boolean description: Situação do produto ((True-Ativo, False-Inativo) default: true recContractItem: description: Dados dos itens do contrato type: object required: – contractCompanyCode – contractBranchCode – contractNumber – quantity properties: contractCompanyCode: type: integer format: int64 description: Empresa contractBranchCode: type: integer format: int64 description: Filial contractNumber: type: integer format: int64 description: Número do contrato quantity: type: integer format: int64 description: Quantidade status: type: boolean description: Situação do produto ((True-Ativo, False-Inativo) default: true precoPadrao: type: number format: double description: Preco Padrao precoUnitario: type: number format: double description: Preco Unitario recCreateAdditionalUser: description: type: object required: – firstName – lastName – email – roles – clients properties: firstName: type: string description: Primeiro nome do usuário lastName: type: string description: Último nome do usuário email: type: string description: Email do usuário roles: type: array items: type: object allOf: – #/definitions/recAdditionalUserRole minimum: 1 description: Roles deste usuário clients: type: array items: type: string minimum: 1 description: recGenerateUser: description: type: object required: – email – currentClient – primaryEmail – roles properties: email: type: string description: Email do usuário currentClient: type: string description: Id do client primaryEmail: type: string description: Email Primario roles: type: array items: type: object allOf: – #/definitions/recAdditionalUserRole minimum: 1 description: Roles deste usuário recAdditionalUserRole: description: type: object required: – roleId – roleName properties: roleId: type: string description: roleName: type: string description: recAdditionalUserCreated: description: type: object required: – id properties: id: type: string description: recUpdateUserInfos: description: type: object required: – firstName – lastName properties: firstName: type: string description: lastName: type: string description: recResetPassword: description: type: object required: – email properties: email: type: string description: recUpgradeRequest: description: Solicitação de upgrade type: object required: – clientId – contactId – items – payment – condition properties: upgradeRequestId: type: string description: Id de upgradeRequest clientId: type: string description: Cliente contactId: type: string description: Contato items: type: array items: type: object allOf: – #/definitions/recUpgradeContractRequestItem minimum: 1 description: Items billingDataItems: type: array items: type: object allOf: – #/definitions/recBillingDataItem description: Billing data items note: type: string description: Observação financialNote: type: string description: Observação financeira licenseEmail: type: string description: E-mail da proprietária status: type: string allOf: – #/definitions/statusOrder description: Status payment: type: string description: payment condition: type: string description: condition createdDate: type: string format: date-time description: Data Criacao createdBy: type: string description: Data de quem Criou requestId: type: string description: Id do request idErp: type: string description: id erp da condicao pgto interestRate: type: number format: double description: taxa juros idDraft: type: string description: id do rascunho hasApportionment: type: boolean description: possui rateio na negociação conditionName: type: string description: Nome da condição de pagamento erpRec: type: string description: Retorno do ERP coupon: type: string description: Codigo do cupom recRascunho: description: Solicitação de upgrade v2 type: object required: – id – client – contact – bpmRequestId – requestDate – payment – condition – upgradeRequestItems – billingDataItems properties: id: type: string description: Identificador client: type: object allOf: – #/definitions/recCompleteClient description: Cliente contact: type: object allOf: – #/definitions/recContactWithPhone description: Contato bpmRequestId: type: integer format: int64 description: bpm ID requestDate: type: string description: Data do request createdDate: type: string format: date-time description: Data Criacao note: type: string description: Observação financialNote: type: string description: Observação financeira payment: type: string description: payment condition: type: string description: condition status: type: string allOf: – #/definitions/statusOrder description: Status licenseEmail: type: string description: E-mail da proprietária upgradeRequestItems: type: array items: type: object allOf: – #/definitions/recUpgradeRequestItem minimum: 1 description: Items erpInfo: type: string description: Retorno do ERP couponCod: type: string description: Código do cupom billingDataItems: type: array items: type: object allOf: – #/definitions/billingDataItem minimum: 1 description: Billing data items recFaixas: description: Record de condicoes de pagamento type: object required: – faixaHabilitacaoA – faixaMensalidadeA – faixaHabilitacaoB – faixaMensalidadeB – faixaHabilitacaoProd – faixaMensalidadeProd – faixasHabilitacaoA – faixasMensalidadeA – faixasHabilitacaoB – faixasMensalidadeB – faixasHabilitacaoProd – faixasMensalidadeProd – valoresAdicionaisHabilitacaoA – valoresAdicionaisMensalidadeA – valoresAdicionaisHabilitacaoB – valoresAdicionaisMensalidadeB – valoresAdicionaisHabilitacaoProd – valoresAdicionaisMensalidadeProd – tabelasMenA – tabelasHabA – tabelasMenB – tabelasHabB – tabelasMenProd – tabelasHabProd – retornaContratos – retornaProdutoModalidade properties: faixaHabilitacaoA: type: object allOf: – #/definitions/recFaixaConteudo description: faixaHabilitacaoA faixaMensalidadeA: type: object allOf: – #/definitions/recFaixaConteudo description: faixaMensalidadeA faixaHabilitacaoB: type: object allOf: – #/definitions/recFaixaConteudo description: faixaHabilitacaoB faixaMensalidadeB: type: object allOf: – #/definitions/recFaixaConteudo description: faixaMensalidadeB faixaHabilitacaoProd: type: object allOf: – #/definitions/recFaixaConteudo description: faixaHabilitacaoProd faixaMensalidadeProd: type: object allOf: – #/definitions/recFaixaConteudo description: faixaMensalidadeProd faixasHabilitacaoA: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: faixasHabilitacaoA faixasMensalidadeA: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: faixasMensalidadeA faixasHabilitacaoB: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: faixasHabilitacaoB faixasMensalidadeB: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: faixasMensalidadeB faixasHabilitacaoProd: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: faixasHabilitacaoProd faixasMensalidadeProd: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: faixasMensalidadeProd valoresAdicionaisHabilitacaoA: type: array items: type: integer format: int64 minimum: 1 description: valoresAdicionaisHabilitacaoA valoresAdicionaisMensalidadeA: type: array items: type: integer format: int64 minimum: 1 description: valoresAdicionaisMensalidadeA valoresAdicionaisHabilitacaoB: type: array items: type: integer format: int64 minimum: 1 description: valoresAdicionaisHabilitacaoB valoresAdicionaisMensalidadeB: type: array items: type: integer format: int64 minimum: 1 description: valoresAdicionaisMensalidadeB valoresAdicionaisHabilitacaoProd: type: array items: type: integer format: int64 minimum: 1 description: valoresAdicionaisHabilitacaoProd valoresAdicionaisMensalidadeProd: type: array items: type: integer format: int64 minimum: 1 description: valoresAdicionaisMensalidadeProd tabelasMenA: type: array items: type: object allOf: – #/definitions/recTabelasMensalidadeHabilitacao minimum: 1 description: tabelasMenA tabelasHabA: type: array items: type: object allOf: – #/definitions/recTabelasMensalidadeHabilitacao minimum: 1 description: tabelasHabA tabelasMenB: type: array items: type: object allOf: – #/definitions/recTabelasMensalidadeHabilitacao minimum: 1 description: tabelasMenB tabelasHabB: type: array items: type: object allOf: – #/definitions/recTabelasMensalidadeHabilitacao minimum: 1 description: tabelasHabB tabelasMenProd: type: array items: type: object allOf: – #/definitions/recTabelasMensalidadeHabilitacao minimum: 1 description: tabelasMenProd tabelasHabProd: type: array items: type: object allOf: – #/definitions/recTabelasMensalidadeHabilitacao minimum: 1 description: tabelasHabProd retornaContratos: type: boolean description: retornaContratos retornaProdutoModalidade: type: boolean description: retornaProdutoModalidade recFaixaConteudo: description: Record de faixas de conteudo type: object required: – id – valorInicial – valorFinal – preco – quantidadeMultipla – seniorTabelasPrecoVigenciaId – listaValoresValidos properties: id: type: string description: valorInicial: type: string description: valorFinal: type: string description: preco: type: string description: quantidadeMultipla: type: string description: seniorTabelasPrecoVigenciaId: type: string description: listaValoresValidos: type: array items: type: string minimum: 1 description: recPaymentsCondition: description: Record de condicoes de pagamento type: object required: – id – idErp – empresaId – nome – taxaJuros – ativo – qtdParcela properties: id: type: string description: idErp: type: string description: empresaId: type: string description: nome: type: string description: taxaJuros: type: string description: ativo: type: string description: qtdParcela: type: string description: recTabelasMensalidadeHabilitacao: description: Record de tabelas mensalidade e habilitacao type: object required: – id – empresaId – produtoId – nome – ativo – prazo – faixas properties: id: type: string description: empresaId: type: string description: produtoId: type: string description: nome: type: string description: ativo: type: string description: prazo: type: string description: faixas: type: array items: type: object allOf: – #/definitions/recFaixaConteudo minimum: 1 description: recUpgradeContractRequestItem: description: Item de um upgrade de contrato type: object required: – floating – module – productId properties: floating: type: object allOf: – #/definitions/recUpgradeContractRequestItemQuantity description: Quantidades e valores do flutuante module: type: object allOf: – #/definitions/recUpgradeContractRequestItemQuantity description: Quantidades e valores do modulo/produto productId: type: string description: Identificador do modulo/produto licenseValueWithoutCoupon: type: number format: double description: Valor bruto sem cupom discountPercentage: type: number format: double description: Porcentagem de desconto note: type: string description: observacao do item recUpgradeContractRequestItemQuantity: description: Item de um upgrade de contrato type: object required: – quantity – initialQuantity properties: quantity: type: integer format: int64 description: Quantidade de items initialQuantity: type: integer format: int64 description: Quantidade inicial monthlyValue: type: number format: double description: valor mensalidade licenseValue: type: number format: double description: valor licenca monthlyValueWithTax: type: number format: double description: valor mensalidade com taxas licenseValueWithTax: type: number format: double description: valor licenca com taxas recBillingDataItem: description: billing data items type: object required: – email – cnpj – apportionment properties: company: type: string description: trade company email: type: string description: email cnpj: type: string description: cnpj da hold apportionment: type: number format: double description: valor rateio recItem: description: type: object required: – quantidadesFinais properties: numeroContrato: type: string description: quantidadesFinais: type: array items: type: object allOf: – #/definitions/recFinalQuantity minimum: 1 description: recFinalQuantity: description: type: object required: – produtoId – quantidade – quantidadeAdicional – quantidadeProd – quantidadeAdicionalProd properties: produtoId: type: string description: quantidade: type: integer format: int64 description: quantidadeAdicional: type: integer format: int64 description: quantidadeProd: type: integer format: int64 description: quantidadeAdicionalProd: type: integer format: int64 description: moduloId: type: integer format: int64 description: controlProductId: type: string description: controlProductIdAlt: type: string description: precoUnitario: type: number format: double description: modality: type: string description: floatingQuantity: type: integer format: int64 description: crmDtoProposta: description: type: object required: – contaErpId – tipoProposta – subtipoProposta – valorImpostoConta – modulos properties: contaErpId: type: string description: prazoPagamentoId: type: string description: tipoProposta: type: string description: subtipoProposta: type: string description: valorImpostoConta: type: string description: modulos: type: array items: type: object allOf: – #/definitions/crmDtoModulos minimum: 1 description: crmDtoModulos: description: type: object required: – produtoId – moduloId – precoHabilitacao – precoHabilitacaoComImposto – precoMensalidade – precoMensalidadeComImposto – quantidadeContrato properties: produtoId: type: string description: moduloId: type: integer format: int64 description: controlProductId: type: string description: controlProductIdAlt: type: string description: quantidadeA: type: object allOf: – #/definitions/crmDtoQuantidade description: quantidadeProd: type: object allOf: – #/definitions/crmDtoQuantidade description: precoHabilitacao: type: number format: double description: precoHabilitacaoComImposto: type: number format: double description: precoMensalidade: type: number format: double description: precoMensalidadeComImposto: type: number format: double description: quantidadeContrato: type: number format: double description: modality: type: string description: floatingQuantity: type: integer format: int64 description: crmDtoQuantidade: description: type: object required: – quantidade – quantidadeInicial – quantidadeAdicional – prazoContratual – precoHabilitacao – precoHabilitacaoComImposto – precoMensalidade – precoMensalidadeComImposto – calculaHabilitacao – calculaMensalidade properties: quantidade: type: integer format: int64 description: quantidadeInicial: type: integer format: int64 description: quantidadeAdicional: type: integer format: int64 description: prazoContratual: type: integer format: int64 description: precoHabilitacao: type: number format: double description: precoHabilitacaoComImposto: type: number format: double description: precoMensalidade: type: number format: double description: precoMensalidadeComImposto: type: number format: double description: calculaHabilitacao: type: boolean description: calculaMensalidade: type: boolean description: recAllUsers: description: type: object required: – id – email – isActive – clients – isPrimaryClientUser properties: id: type: string description: Id email: type: string description: Email isActive: type: boolean description: Status clients: type: array items: type: string minimum: 1 description: Clientes vinculados isPrimaryClientUser: type: boolean description: É usuário de integração recGetUserPermission: description: type: object required: – permissionType – permissionKey properties: permissionType: type: string allOf: – #/definitions/permissionType description: permissionKey: type: string allOf: – #/definitions/permissionKey description: permissionParent: type: string allOf: – #/definitions/permissionKey description: recPermission: description: type: object required: – permissionType – permissionKey properties: permissionType: type: string allOf: – #/definitions/permissionType description: permissionKey: type: string allOf: – #/definitions/permissionKey description: recUserRole: description: type: object required: – id – name properties: id: type: string description: name: type: string description: recGetAvailableRoles: description: type: object required: – roleId – roleName – roleDescription – enabled – readonly properties: roleId: type: string description: roleName: type: string description: roleDescription: type: string description: enabled: type: boolean description: readonly: type: boolean description: recRoleCreate: description: type: object required: – name – permissions – clients properties: name: type: string description: Nome do papel description: type: string description: Descrição do papel permissions: type: array items: type: object allOf: – #/definitions/recIds minimum: 1 description: Permissões users: type: array items: type: object allOf: – #/definitions/recIds description: Usuários clients: type: array items: type: object allOf: – #/definitions/recIds minimum: 1 description: Empresas recRoleUpdate: description: type: object required: – id – name properties: id: type: string description: Identificador unico papel name: type: string description: Nome do papel description: type: string description: Descrição do papel permissions: type: array items: type: object allOf: – #/definitions/recIds description: Permissões users: type: array items: type: object allOf: – #/definitions/recIds description: Usuários clients: type: array items: type: object allOf: – #/definitions/recIds description: Empresas recChangeUserRoles: description: type: object required: – userId properties: userId: type: string description: addedRolesIds: type: array items: type: string description: removedRolesIds: type: array items: type: string description: recIds: description: type: object required: – id properties: id: type: string description: recAllContractInfo: description: type: object required: – contracts – activeProducts – items properties: contractId: type: string description: Id do contract clientId: type: string description: Id do cliente agentId: type: string description: Id do agente companyCode: type: string description: Company code branchCode: type: string description: Branch code contractNumber: type: integer format: int64 description: Número do contrato emissionDate: type: string format: date-time description: Data de emissão endDate: type: string format: date-time description: Data fim do contrato status: type: boolean description: Situação do produto ((True-Ativo, False-Inativo) default: true integrationCode: type: string description: Código de identificação interna companyName: type: string description: Company name trade: type: string description: trade primaryEmail: type: string description: Email principal de contato contracts: type: array items: type: object allOf: – #/definitions/recUpdateContract minimum: 1 description: Lista de contratos activeProducts: type: array items: type: object allOf: – #/definitions/activeProductItem minimum: 1 description: Lista de activeProducts items: type: array items: type: object allOf: – #/definitions/recItem minimum: 1 description: Lista de itens numberOfUpgrades: type: integer format: int64 description: numero de upgrades realizado numberOfDuplicateBillet: type: integer format: int64 description: numero de segundas vias do boleto numberOfBillingStatement: type: integer format: int64 description: numero de demonstrativo financeiro numberOfDuplicateLegalDocument: type: integer format: int64 description: numero de segunda via de danfe numberOfAccess: type: integer format: int64 description: numero de acessos saasExists: type: boolean description: contem modulo saas recUpgradeRequestInfo: description: type: object properties: upgradeId: type: string description: id do upgrade bpmRequestId: type: string description: id do bpm requestDate: type: string description: data de requisição status: type: string description: status da requisição licenseEmail: type: string description: license email bpmControllId: type: string description: id de controle do bpm payment: type: string description: forma de pagamento clientAccessEnvironmentUpdating: description: Acesso ao ambiente de atualização type: object required: – clientId – permissionId properties: id: type: string format: uuid description: Identificador único clientId: type: string format: uuid description: Identificação do cliente permissionId: type: string format: uuid description: Identificação da permissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: permissionEnvironmentUpdating: description: Acesso ao ambiente de atualização type: object required: – permission – description properties: id: type: string format: uuid description: Identificador único permission: type: string description: Identificação da permissão description: type: string description: Descrição da permissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: billetRules: description: Regras de boletos type: object required: – billetType – visible – haveNf – state properties: id: type: string format: uuid description: Identificador único billetType: type: string description: tipo de boleto visible: type: boolean description: deve mostrar ou não na tela haveNf: type: boolean description: possui nota fiscal state: type: string description: estado da NF createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: client: description: Empresa type: object required: – integrationCode – companyName – trade – primaryEmail – contractEmail – legalDocumentEmail – billingEmail – user properties: id: type: string format: uuid description: Identificador único integrationCode: type: string description: Código de identificação interna companyName: type: string maxLength: 100 description: Nome trade: type: string maxLength: 50 description: Nome fantasia primaryEmail: type: string maxLength: 100 description: Email principal contractEmail: type: string maxLength: 250 description: Email de contratos legalDocumentEmail: type: string maxLength: 250 description: Email de nota fiscal billingEmail: type: string maxLength: 250 description: Email de documentos eletronicos website: type: string maxLength: 30 description: Website integrationDate: type: string format: date-time description: Data de integração allowed: type: boolean description: Permir fluxo novo default: true floatingQuantity: type: integer format: int64 description: Quantidade Flutuante default: 0 user: type: array items: type: object allOf: – #/definitions/user minimum: 1 description: Usuário projectCode: type: string description: Código do cliente que aparece no zendesk(campo Projeto mega no crm) createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: user: description: Usuário type: object required: – email – client properties: id: type: string format: uuid description: Identificador único roles: type: array items: type: object allOf: – #/definitions/role description: Papéis do usuário email: type: string description: email currentClient: type: string format: uuid description: Client Atual isActive: type: boolean description: Status Usuário default: true isIntegrationUser: type: boolean description: Define se este usuário veio proveniente da integração ERP default: false primaryEmail: type: string description: Indica qual é o conglomerado de empresas que esse usuário faz parte isMaster: type: boolean description: Indica se este usuário é master default: false onBehalfOf: type: string format: uuid description: Se o usuário for master, em nome de qual usuário está fazendo acesso quantidadeLogs: type: integer format: int64 description: Quantidade de vezes que o usuário logou no portal default: 0 client: type: array items: type: object allOf: – #/definitions/client minimum: 1 description: Clientes createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: blockedModules: description: Módulos Bloqueados ao Cliente type: object required: – module properties: module: type: string maxLength: 150 description: Id do módulo bloqueado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contact: description: Contato type: object required: – integrationOrder – name – note properties: id: type: string format: uuid description: Identificador único clientId: type: string format: uuid description: Identificação do cliente integrationOrder: type: integer format: int64 description: Sequencial do contato name: type: string maxLength: 150 description: Nome do contato birthDate: type: string format: date description: Data de nascimento department: type: string maxLength: 30 description: Setor na empresa role: type: string maxLength: 50 description: Cargo email: type: string maxLength: 100 description: Email status: type: boolean description: Situação do contato ((True-Ativo, False-Inativo) default: true note: type: string maxLength: 250 description: Observação integrationDate: type: string format: date-time description: Data de integração idDepartmentCrm: type: integer format: int64 description: Id do departamento no crm idRoleCrm: type: integer format: int64 description: Id do cargo no crm createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: address: description: Endereço type: object required: – type – cpfCnpj – address properties: id: type: string format: uuid description: Identificador único clientId: type: string format: uuid description: Dados do cliente type: type: string allOf: – #/definitions/typeAddress description: Tipo (COMERCIAL, SHIPPING OU BILLING) cpfCnpj: type: string description: CPF ou CNPJ stateRegistration: type: string maxLength: 25 description: Inscrição Estadual municipalRegistration: type: string maxLength: 16 description: Inscrição Municipal address: type: string maxLength: 100 description: Endereço number: type: string maxLength: 60 description: Número complement: type: string maxLength: 200 description: Complemento do endereço landmark: type: string maxLength: 120 description: Ponto de referência neighborhood: type: string maxLength: 75 description: Bairro zipCode: type: integer format: int64 description: CEP city: type: string maxLength: 75 description: Cidade state: type: string maxLength: 75 description: Estado createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: phone: description: Endereço type: object required: – type – phone properties: id: type: string format: uuid description: Identificador único clientId: type: string format: uuid description: Dados do cliente contactId: type: string format: uuid description: Dados do Contato type: type: string allOf: – #/definitions/typePhone description: Tipo (Comercial, Residential ou Financial) phone: type: string maxLength: 20 description: Telefone phoneExtension: type: integer format: int64 description: Ramal createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: legalDocument: description: Nota Fiscal type: object required: – client – companyCode – branchCode – number – numberExt properties: id: type: string format: uuid description: Identificador único client: type: object allOf: – #/definitions/client description: Dados do cliente companyCode: type: integer format: int64 description: Empresa branchCode: type: integer format: int64 description: Filial number: type: integer format: int64 description: Número numberExt: type: string maxLength: 3 description: Número de serie da nota fiscal value: type: number format: double description: Valor emissionLink: type: string maxLength: 300 description: Link de emissão linkInstruction: type: string maxLength: 300 description: Instrução da nota fiscal emissionDate: type: string format: date-time description: Data de emissão createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: billet: description: Boleto type: object required: – client – legalDocument – paymentNumber – paymentType – dueDate – status – emissionDate – paymentPrice – paymentMethod – bankCode – numberDfs properties: id: type: string format: uuid description: Identificador único client: type: object allOf: – #/definitions/client description: Dados do cliente legalDocument: type: object allOf: – #/definitions/legalDocument description: Nota Fiscal branchCode: type: integer format: int64 description: Filial paymentNumber: type: string maxLength: 15 description: Número do título paymentType: type: string maxLength: 3 description: Tipo do título code: type: string maxLength: 20 description: Código dueDate: type: string format: date description: Vencimento status: type: string allOf: – #/definitions/statusBillet description: Status barcode: type: string maxLength: 48 description: Código de barras emissionDate: type: string format: date-time description: Data de emissão emissionDuplicateDate: type: string format: date-time description: Data de emissão da segunda via paymentPrice: type: number format: double description: Valor do título paymentMethod: type: string allOf: – #/definitions/paymentMethod description: Forma de pagamento bankCode: type: string maxLength: 4 description: Código do portador numberDfs: type: integer format: int64 description: Codigo da nota fiscal createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: requestDuplicate: description: Solicitação de segunda via type: object required: – user – requestedDate – status properties: id: type: string format: uuid description: Identificador único billet: type: object allOf: – #/definitions/billet description: Dados do boleto legalDocument: type: object allOf: – #/definitions/legalDocument description: Dados da nota fiscal user: type: object allOf: – #/definitions/user description: Dados do usuário requestedDate: type: string format: date-time description: Data da solicitação receiveDate: type: string format: date-time description: Data do recebimento status: type: string allOf: – #/definitions/statusRequestDuplicate description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tracking: description: Rastreamento type: object required: – client – type properties: id: type: string format: uuid description: Identificador único client: type: object allOf: – #/definitions/client description: Dados do cliente type: type: string allOf: – #/definitions/typeTracking description: Tipo typeId: type: string format: uuid description: Identificador único do tipo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: product: description: Produto type: object required: – id – integrationCode – name properties: id: type: string format: uuid description: Identificador único integrationCode: type: string description: Código de integração name: type: string description: Nome description: type: string description: Descrição family: type: string description: Família status: type: boolean description: Situação do produto ((True-Ativo, False-Inativo) default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: agent: description: Representante type: object required: – id – integrationCode – name properties: id: type: string format: uuid description: Identificador único integrationCode: type: string description: Código de integração name: type: string description: Nome status: type: boolean description: Situação do agente ((True-Ativo, False-Inativo) default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contract: description: Contrato type: object required: – id – companyCode – branchCode – number – client – agent – emissionDate properties: id: type: string format: uuid description: Identificador único companyCode: type: integer format: int64 description: Empresa branchCode: type: integer format: int64 description: Filial number: type: integer format: int64 description: Número client: type: object allOf: – #/definitions/client description: Dados do cliente agent: type: object allOf: – #/definitions/agent description: Dados do representante emissionDate: type: string format: date-time description: Data de emissão status: type: boolean description: Situação do contrato ((True-Ativo, False-Inativo) default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contractItem: description: Itens do Contrato type: object required: – id – contract – product – quantity properties: id: type: string format: uuid description: Identificador único contract: type: object allOf: – #/definitions/contract description: Código do contrato product: type: object allOf: – #/definitions/product description: Código do produto quantity: type: integer format: int64 description: Quantidade contratada status: type: boolean description: Situação do item do contrato ((True-Ativo, False-Inativo) default: true precoPadrao: type: number format: double description: Preco Padrao precoUnitario: type: number format: double description: Preco Unitario createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: upgradeRequest: description: Solicitação de upgrade type: object required: – bpmRequestId – requestDate – status – licenseEmail – payment – condition – hasApportionment – bpmControllId properties: id: type: string format: uuid description: Identificador único clientId: type: string format: uuid description: Cliente contactId: type: string format: uuid description: Contato bpmRequestId: type: integer format: int64 description: Identificador único da solicitação de upgrade de contrato requestDate: type: string format: date description: Data de solicitação note: type: string description: Observação financialNote: type: string description: Observação financeira status: type: string allOf: – #/definitions/statusOrder description: Status licenseEmail: type: string description: E-mail da proprietária payment: type: string description: condition: type: string description: hasApportionment: type: boolean description: bpmControllId: type: string format: uuid description: erpRec: type: string description: couponCod: type: string description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: bpmControll: description: Controle de BPM utilizados no sistema type: object required: – allocatedId – typeBpm – businessJson – bpmStatus properties: id: type: string format: uuid description: Identificador único allocatedId: type: integer format: int64 description: Id geral do BPM (entre todos os BPM juntos) processId: type: integer format: int64 description: Id normal de processo de BPM (retorno do envio) typeBpm: type: string description: Enum de tipo de BPM enviado businessJson: type: string description: Json enviado bpmStatus: type: string description: Status do BPM createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: upgradeRequestItem: description: Item de Solicitação de upgrade type: object required: – fromAmount – toAmount – baseCalc – modality – monthlyValue – habilitationValue – monthlyValueWithTax – licenseValueWithTax – isFloating properties: id: type: string format: uuid description: Identificador único upgradeRequestId: type: string format: uuid description: Solicitação de upgrade productId: type: string format: uuid description: Produto solicitado fromAmount: type: integer format: int64 description: Quantidade corrente toAmount: type: integer format: int64 description: Quantidade solicitada groupName: type: string description: Nome do grupo no momento que foi feita a solicitação familyName: type: string description: Nome da família no momento que foi feita a solicitação baseCalc: type: string description: modality: type: string description: monthlyValue: type: number format: double description: habilitationValue: type: number format: double description: monthlyValueWithTax: type: number format: double description: licenseValueWithTax: type: number format: double description: isFloating: type: boolean description: grossValue: type: number format: double description: discountPercentage: type: number format: double description: grossValueWithCoupon: type: number format: double description: note: type: string description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: billingDataItem: description: Billing data type: object required: – trade – email – cnpj – apportionment properties: id: type: string format: uuid description: Identificador único upgradeRequestId: type: string format: uuid description: Solicitação de upgrade trade: type: string description: trade company email: type: string description: email cnpj: type: string description: cnpj da hold apportionment: type: number format: double description: valor rateio createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: role: description: Papéis do usuário type: object required: – name – status – systemData – clients properties: id: type: string format: uuid description: Identificador único name: type: string description: Nome do papel description: type: string description: Descrição do papel status: type: boolean description: Situação do papel ((True-Ativo, False-Inativo) permissions: type: array items: type: object allOf: – #/definitions/permission description: Permissões users: type: array items: type: object allOf: – #/definitions/user description: Usuários primaryEmail: type: string description: Vínculo com dados de integração systemData: type: boolean description: Registro não removível clients: type: array items: type: object allOf: – #/definitions/client minimum: 1 description: Empresas para as quais esse papel concederá acesso/terá efeito createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: permission: description: Permissões type: object required: – permissionKey – type properties: id: type: string format: uuid description: Identificador único permissionKey: type: string allOf: – #/definitions/permissionKey description: Chave da permissão type: type: string allOf: – #/definitions/permissionType description: Tipo de permissão parent: type: string allOf: – #/definitions/permissionKey description: Vinculo da permissão quando é do tipo action createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: serviceMenuPermission: description: Serivece Menu Pemission type: object required: – agent properties: id: type: string format: uuid description: Identificador único agent: type: object allOf: – #/definitions/agent description: Dados do representante createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: 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 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
Mais pesquisados:Customização, Tutorial, Documentação