2.0info: 3.13.0 Colaborativo description: Serviço responsável pelo módulo colaborativo CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: collaborative 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/crmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /collaborative/queries/healthcheck: post: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/statusHeathEnum description: Status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/statusHeathEnum description: Status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/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 maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 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 maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/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 /collaborative/apis/appointment: post: description: Entidade fachada de Compromisso tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/appointmentFacade responses: 200: description: Ok schema: #/definitions/appointmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada de Compromisso tags: – APIS x-senior-visibility: PUBLIC 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/appointmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/appointment/{id}: get: description: Entidade fachada de Compromisso tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/appointmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada de Compromisso tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/appointmentFacade responses: 200: description: Ok schema: #/definitions/appointmentFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada de Compromisso tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/event: post: description: Entidade fachada de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/eventFacade responses: 200: description: Ok schema: #/definitions/eventFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada de Evento tags: – APIS x-senior-visibility: PUBLIC 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/eventFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/event/{id}: get: description: Entidade fachada de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/eventFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/eventFacade responses: 200: description: Ok schema: #/definitions/eventFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada de Evento tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/appointmentParams: post: description: Fachada para AppointmentParams tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/appointmentParamsFacade responses: 200: description: Ok schema: #/definitions/appointmentParamsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Fachada para AppointmentParams tags: – APIS x-senior-visibility: PUBLIC 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/appointmentParamsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/appointmentParams/{id}: get: description: Fachada para AppointmentParams tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/appointmentParamsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Fachada para AppointmentParams tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/appointmentParamsFacade responses: 200: description: Ok schema: #/definitions/appointmentParamsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Fachada para AppointmentParams tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/task: post: description: Entidade fachada de Tarefa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/taskFacade responses: 200: description: Ok schema: #/definitions/taskFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada de Tarefa tags: – APIS x-senior-visibility: PUBLIC 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/taskFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/task/{id}: get: description: Entidade fachada de Tarefa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/taskFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada de Tarefa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/taskFacade responses: 200: description: Ok schema: #/definitions/taskFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada de Tarefa tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/reminder: post: description: Entidade fachada do Follow-up tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/reminderFacade responses: 200: description: Ok schema: #/definitions/reminderFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada do Follow-up tags: – APIS x-senior-visibility: PUBLIC 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/reminderFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /collaborative/apis/reminder/{id}: get: description: Entidade fachada do Follow-up tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/reminderFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada do Follow-up tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/reminderFacade responses: 200: description: Ok schema: #/definitions/reminderFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada do Follow-up tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: statusHeathEnum: description: Status do healthcheck type: string enum: – UP – DOWN comparatorEnum: description: Enum com os comparadores dos filtros das queries type: string enum: – EQ – NEQ – IN – NOT_IN – LIKE – NOT_LIKE – LT – LTE – GT – GTE enumRecurrenceType: description: Tipo de recorrência type: string enum: – UNICA – DIARIA – SEMANAL – MENSAL – ANUAL enumActivity: description: Atividade desempenhada no compromisso type: string enum: – REUNIAO – TELEFONEMA – COMPROMISSO – VISITA – EMAIL enumPriority: description: Prioridade do compromisso type: string enum: – BAIXA – MEDIA – ALTA – CRITICA enumMonthlyYearly: description: Indica se nas recorrências mensal e anual os eventos devem ser agendados com base no dia do mês ou no dia da semana type: string enum: – DIA_MES – DIA_SEMANA enumAvaliation: description: Nota de avaliação dada ao compromisso selecionado. type: string enum: – NAO_AVALIADO – OTIMO – BOM – REGULAR – RUIM enumEventStatus: description: Status do evento type: string enum: – AGENDADO – ANDAMENTO – CONCLUIDO – CANCELADO enumTaskStatus: description: Status do evento type: string enum: – NAO_INICIADO – EM_ANDAMENTO – REALIZADA – AGUARDANDO – ADIADA enumReminderStatus: description: Status do lembrete type: string enum: – ABERTO – CONCLUIDO enumModule: description: Módulo type: string enum: – TAREFA – COMPROMISSO – EVENTO – OPORTUNIDADE – OCORRENCIA – CONTRATO 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 detailRecord: description: Detalhe type: object properties: id: type: string maxLength: 255 description: ID no CRM contactDetailRecord: description: Contato type: object properties: id: type: integer format: int64 description: ID no CRM detail: type: object allOf: – #/definitions/detailRecord description: Detalhe do compromisso contact: type: object allOf: – #/definitions/detailRecord description: Contato userRecord: description: Usuário type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 50 description: ID no sistema terceiro name: type: string maxLength: 255 description: Nome lastName: type: string maxLength: 255 description: Sobrenome descriptionFunction: type: string maxLength: 255 description: Descrição da função photo: type: string maxLength: 255 description: Foto email: type: string maxLength: 255 description: E-mail active: type: boolean description: Se está ativo userCompanyBranches: type: array items: type: object allOf: – #/definitions/userCompanyBranchRecord description: Empresa/filiais do usuário recipientsUsersRecord: description: Usuários Destinatários type: object properties: id: type: integer format: int64 description: ID followUp: type: object allOf: – #/definitions/followUpRecord description: ID do follow-up user: type: object allOf: – #/definitions/userRecord description: ID do usuário followUpRecord: description: type: object properties: id: type: integer format: int64 description: ID externalUserRecord: description: Participante externo type: object properties: id: type: integer format: int64 description: ID no CRM email: type: string maxLength: 255 description: E-mail accountRecord: description: Conta type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 50 description: ID no sistema terceiro name: type: string maxLength: 255 description: Nome fantasyName: type: string maxLength: 255 description: Nome fantasia economicGroup: type: string maxLength: 255 description: Grupo econômico stateRegistration: type: string maxLength: 255 description: Inscrição estadual municipalRegistration: type: string maxLength: 255 description: Inscrição municipal cnpj: type: string maxLength: 255 description: CNPJ rg: type: string maxLength: 255 description: RG cpf: type: string maxLength: 255 description: CPF einNumber: type: string maxLength: 255 description: EIN ssnNumber: type: string maxLength: 255 description: SSN url: type: string maxLength: 255 description: URL generalEmail: type: string maxLength: 255 description: E-mail geral financialEmail: type: string maxLength: 255 description: E-mail financeiro employees: type: integer format: int64 description: Funcionários annualRevenue: type: integer format: int64 description: Receira anual registrationDate: type: string format: date-time description: Data de cadastro customerSince: type: string format: date-time description: Cliente desde birthDate: type: string format: date-time description: Data de nascimento receiveEmail: type: boolean description: Se recebe e-mail receiveSurvey: type: boolean description: Se recebe pesquisa receiveTrackEmail: type: boolean description: Se recebe monitoramento por e-mail active: type: boolean description: Se está ativo personType: type: object allOf: – #/definitions/personTypeRecord description: Tipo de pessoa companySize: type: object allOf: – #/definitions/companySizeRecord description: Porte da empresa branchActivity: type: object allOf: – #/definitions/branchActivityRecord description: Ramo de atividade companyGroup: type: object allOf: – #/definitions/companyGroupRecord description: Grupo da empresa origin: type: object allOf: – #/definitions/originRecord description: Origem nit: type: string maxLength: 255 description: NIT cedulaCiudadania: type: string maxLength: 255 description: Cédula de ciudadanía passport: type: string maxLength: 255 description: Passaporte customFields: type: string format: byte description: Campos customizados opportunityRecord: description: Oportunidade type: object properties: id: type: integer format: int64 description: ID account: type: object allOf: – #/definitions/accountRecord description: Conta companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial date: type: string format: date-time description: Data hour: type: string format: date-time description: Hora contact: type: object allOf: – #/definitions/contactRecord description: Contact companyId: type: integer format: int64 description: ID da empresa name: type: string maxLength: 255 description: Nome da oportunidade subType: type: integer format: int64 description: Subtipo da oportunidade origin: type: object allOf: – #/definitions/opportunityOriginRecord description: Origem da oportunidade script: type: object allOf: – #/definitions/scriptRecord description: Roteiro user: type: object allOf: – #/definitions/userRecord description: Usuário phase: type: integer format: int64 description: Estágio standByPhase: type: integer format: int64 description: Estágio standby lossReason: type: object allOf: – #/definitions/lossReasonRecord description: Motivo da perda saleReason: type: object allOf: – #/definitions/saleReasonRecord description: Motivo da venda probability: type: integer format: int64 description: Probabilidade standByProbability: type: integer format: int64 description: Probabilidade standby proposalNumber: type: string maxLength: 255 description: Número da proposta orderNumber: type: string maxLength: 255 description: Número do pedido autoNumbered: type: boolean description: Se é autonumerada predictedInitialClosingDate: type: string format: date-time description: Data prevista de fechamento inicial predictedClosingDate: type: string format: date-time description: Data prevista de fechamento effectiveDateClosing: type: string format: date-time description: Data efetiva de fechamento predictedDeliveryDate: type: string format: date-time description: Data prevista de entrega effectiveDelivertDate: type: string format: date-time description: Data efetiva de entreda initialPredictedValue: type: number format: double description: Valor previsto inicial predictedValue: type: number format: double description: Valor previsto closedValue: type: number format: double description: Valor fechado predictedValueCurrency: type: number format: double description: Moeda do valor previsto closedValueCurrency: type: number format: double description: Moeda do valor esperado predictedQuantitative: type: number format: double description: Quantidade prevista quantitativeAccomplished: type: number format: double description: Quantidade realizada history: type: string maxLength: 255 description: Histórico description: type: string maxLength: 255 description: Descrição timestampRegistration: type: string format: date-time description: Cadastro timestamp operatorRegistration: type: object allOf: – #/definitions/operatorRecord description: Cadastro do operador timestampChange: type: string format: date-time description: Alteração do timestamp operatorChange: type: object allOf: – #/definitions/operatorRecord description: Alteração do operador businessType: type: object allOf: – #/definitions/businessTypeRecord description: Modalidade de negócio customFields: type: string format: byte description: Campos customizados type: type: object allOf: – #/definitions/opportunityTypeRecord description: Tipo da oportunidade notifyEmail: type: boolean description: Se notifica por e-mail infoErp: type: string format: byte description: Informações do ERP occurrenceRecord: description: Ocorrência type: object properties: id: type: integer format: int64 description: ID date: type: string format: date-time description: Data hour: type: string format: date-time description: Hora userId: type: integer format: int64 description: ID do usuário groupId: type: integer format: int64 description: ID do grupo campaignId: type: integer format: int64 description: ID da campanha subaccountId: type: integer format: int64 description: ID da subconta relationshipId: type: integer format: int64 description: ID do relacionamento companyId: type: integer format: int64 description: ID da empresa name: type: string maxLength: 255 description: Nome occurrenceSubtypeId: type: integer format: int64 description: ID do subtipo da ocorrência departmentId: type: integer format: int64 description: ID do departamento priority: type: string maxLength: 255 description: Prioridade description: type: string maxLength: 255 description: Descrição status: type: integer format: int64 description: Status expectedStartDate: type: string format: date-time description: Data de início esperada expectedStartHour: type: string format: date-time description: Hora de início esperada effectiveStartDate: type: string format: date-time description: Data de início efetiva effectiveStartHour: type: string format: date-time description: Hora de início efetiva deadlineDate: type: string format: date-time description: Data do prazo deadlineHour: type: string format: date-time description: Hora do prazo deadlineTimestamp: type: string format: date-time description: Timestamp do prazo resolved: type: boolean description: Se está resolvida resolutionDate: type: string format: date-time description: Data de resolução resolutionHour: type: string maxLength: 255 description: Hora de resolução resolution: type: string maxLength: 255 description: Resolução dispositionOccurrenceId: type: integer format: int64 description: ID da disposição da ocorrência occurrenceCost: type: number format: double description: Custo da ocorrência checkFaq: type: boolean description: Se verifica a FAQ faqTags: type: string maxLength: 255 description: Tags da FAQ apInvoice: type: integer format: int64 description: Nota fiscal de entrada arInvoice: type: integer format: int64 description: Nota fiscal de saída carrierId: type: integer format: int64 description: ID da transportadora operatorRegistration: type: integer format: int64 description: Operador do cadastro timestampRegistration: type: string format: date-time description: Timestamp do cadastro operatorChange: type: integer format: int64 description: Operador da alteração timestampChange: type: string format: date-time description: Timestamp da alteração emailOrigin: type: string maxLength: 255 description: Origem do e-mail emailAddress: type: string maxLength: 255 description: Endereço de e-mail emailName: type: string maxLength: 255 description: Nome do e-mail representativeId: type: integer format: int64 description: ID do represetante account: type: object allOf: – #/definitions/accountRecord description: Conta occurrenceOrigin: type: object allOf: – #/definitions/occurrenceOriginRecord description: Origem da ocorrência occurrenceType: type: object allOf: – #/definitions/occurrenceTypeRecord description: Tipo da ocorrência companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial notifyClosing: type: integer format: int64 description: Se notifica o fechamento notifyEmail: type: integer format: int64 description: Se notifica o e-mail opportunity: type: object allOf: – #/definitions/opportunityRecord description: Oportunidade customFields: type: string format: byte description: Campos customizados createdBy: type: object allOf: – #/definitions/userRecord description: Criado por changedBy: type: object allOf: – #/definitions/userRecord description: Alterado por contactRecord: description: Contato type: object properties: id: type: integer format: int64 description: ID search: type: integer format: int64 description: Pesquisa privateUser: type: integer format: int64 description: Usuário privado sequentialErp: type: string maxLength: 255 description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer format: int64 description: Visibilidade name: type: string maxLength: 255 description: Nome treatment: type: string maxLength: 255 description: Tratamento functionDescription: type: string maxLength: 255 description: Descrição da função gender: type: integer format: int64 description: Gênero sexual cep: type: string maxLength: 255 description: CEP zipCode: type: string maxLength: 255 description: ZIP Code address: type: string maxLength: 255 description: Endereço number: type: string maxLength: 255 description: Numero complement: type: string maxLength: 255 description: Complemento district: type: string maxLength: 255 description: Bairro cpf: type: string maxLength: 255 description: CPF rg: type: string maxLength: 255 description: RG citizenshipCard: type: string maxLength: 255 description: Cédula cidadania telephone: type: string maxLength: 255 description: Telefone corporatePhone: type: boolean description: Telefone corporativo phoneBranch: type: string maxLength: 255 description: Ramal fax: type: string maxLength: 255 description: FAX cell: type: string maxLength: 255 description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer format: int64 description: Operadora email: type: string maxLength: 255 description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveSearch: type: boolean description: Recebe pesquisa skype: type: string maxLength: 255 description: Skype twitter: type: string maxLength: 255 description: Twitter facebook: type: string maxLength: 255 description: Facebook birthday: type: string maxLength: 255 description: Aniversário birthDate: type: string format: date-time description: Data de nascimento decisionLevel: type: integer format: int64 description: Nível de decisão opinionCompany: type: integer format: int64 description: Parecer empresa reasonOpinionCompany: type: string maxLength: 255 description: Motivo parecer empresa notes: type: string maxLength: 255 description: Observações customFields: type: string format: byte description: Campos customizados city: type: object allOf: – #/definitions/cityRecord description: Cidade department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função origin: type: object allOf: – #/definitions/originRecord description: Origem account: type: object allOf: – #/definitions/accountRecord description: Conta superiorContact: type: object allOf: – #/definitions/contactRecord description: Contato superior companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial departmentRecord: description: Departamento do contato type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo usesOccurrence: type: boolean description: Usa ocorrência customFields: type: string format: byte description: Campos customizados functionRecord: description: Objeto referente a Função type: object properties: id: type: integer format: int64 description: ID idErp: type: string maxLength: 255 description: Id no sistema terceiro company: type: object allOf: – #/definitions/companyRecord description: Empresa name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados opportunityOriginRecord: description: Origem da oportunidade type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial scriptRecord: description: Roteiro type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome description: type: string maxLength: 255 description: Descrição lossReasonRecord: description: Motivo da perda type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial saleReasonRecord: description: Motivo da venda type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial operatorRecord: description: Operador type: object properties: id: type: integer format: int64 description: ID idErp: type: string maxLength: 255 description: Id no sistema terceiro name: type: string maxLength: 255 description: Nome lastName: type: string maxLength: 255 description: Sobrenome functionDescription: type: string maxLength: 255 description: Descrição da função email: type: string maxLength: 255 description: E-mail active: type: boolean description: Se está ativo businessTypeRecord: description: Modalidade de negócio type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome notes: type: string maxLength: 255 description: Observações active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial opportunityTypeRecord: description: Record referente ao tipo da oportunidade type: object properties: id: type: integer format: int64 description: Id idErp: type: string maxLength: 255 description: Id no sistema terceiro name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observações active: type: boolean description: Ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial occurrenceOriginRecord: description: Origem da ocorrência type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados occurrenceTypeRecord: description: Tipo de ocorrência type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo sla: type: integer format: int64 description: SLA customFields: type: string format: byte description: Campos customizados taskCategoryRecord: description: Categoria da Tarefa type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo simpleAppointmentRecord: description: Record de Compromisso simples type: object properties: id: type: integer format: int64 description: Código de identificação date: type: string format: date-time description: Data startHour: type: string format: date-time description: Hora de início do compromisso endHour: type: string format: date-time description: Hora final do compromisso detail: type: object allOf: – #/definitions/detailRecord description: Detalhe canceled: type: boolean description: Indicador se o compromisso está cancelado justifiedCancellation: type: string maxLength: 255 description: Justificativa do cancelamento do compromisso status: type: integer format: int64 description: Status personTypeRecord: description: Tipo de pessoa type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome icon: type: string maxLength: 255 description: Ícone active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados companySizeRecord: description: Porte da empresa type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados branchActivityRecord: description: Ramo de atividade type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 255 description: ID no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo company: type: object allOf: – #/definitions/companyRecord description: Empresa companyGroupRecord: description: Grupo da empresa type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 255 description: ID no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo company: type: object allOf: – #/definitions/companyRecord description: Empresa customFields: type: string format: byte description: Campos customizados originRecord: description: Origem type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo company: type: object allOf: – #/definitions/companyRecord description: Empresa customFields: type: string format: byte description: Campos customizados companyBranchRecord: description: Empresa filial da definição da conta type: object properties: id: type: integer format: int64 description: ID no CRM company: type: object allOf: – #/definitions/companyRecord description: Objeto da Empresa branch: type: object allOf: – #/definitions/branchRecord description: Objeto da filial da Empresa companyRecord: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 description: ID no CRM companyErp: type: string maxLength: 50 description: ID no sistema terceiro name: type: string maxLength: 80 description: Nome da Empresa fantasyName: type: string maxLength: 80 description: Nome fantasia da Empresa cnpj: type: string maxLength: 14 description: CNPJ nit: type: string maxLength: 20 description: NIT branchRecord: description: Objeto referente a filial da Empresa type: object properties: id: type: integer format: int64 description: ID no CRM branchErp: type: string maxLength: 50 description: ID no sistema terceiro name: type: string maxLength: 80 description: Nome da Empresa fantasyName: type: string maxLength: 80 description: Nome fantasia da Empresa cnpj: type: string maxLength: 14 description: CNPJ headquarters: type: integer format: int64 description: Matriz nit: type: string maxLength: 20 description: NIT userCompanyBranchRecord: description: Empresa/filiais do usuário type: object properties: id: type: integer format: int64 description: ID no CRM standardCompanyBranch: type: boolean description: Empresa/filial padrão user: type: object allOf: – #/definitions/userRecord description: Usuário companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial priorityRecord: description: Prioridade type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome color: type: string maxLength: 255 description: Cor categoryRecord: description: Categoria do compromisso type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados activityRecord: description: Atividade type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome icon: type: string maxLength: 255 description: Ícone appointmentOriginRecord: description: Origem do compromisso type: object properties: id: type: integer format: int64 description: ID no CRM origin: type: integer format: int64 description: Origem idRef: type: integer format: int64 description: Id de referência originIntegrationRecord: description: Origem da integração type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome segmentRecord: description: Segmento type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo icon: type: string maxLength: 255 description: Ícone color: type: string maxLength: 255 description: Cor minimumArea: type: number format: double description: Área mínima countryRecord: description: País type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo countryCode: type: integer format: int64 description: Código do país customFields: type: string format: byte description: Campos customizados stateRecord: description: Estado type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome initials: type: string maxLength: 255 description: Iniciais active: type: boolean description: Se está ativo country: type: object allOf: – #/definitions/countryRecord description: País customFields: type: string format: byte description: Campos customizados cityRecord: description: Cidade type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro idIbge: type: string maxLength: 255 description: Código IBGE name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo dddCode: type: string maxLength: 255 description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População estimada potentialConsumption: type: string maxLength: 255 description: Potencial de consumo pib: type: string maxLength: 255 description: PIB state: type: object allOf: – #/definitions/stateRecord description: Estado customFields: type: string format: byte description: Campos customizados propertyRecord: description: Propriedade type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: integer format: int64 description: ID no sistema terceiro name: type: string maxLength: 255 description: Nome cultivationArea: type: number format: double description: Área de cultivo totalArea: type: number format: double description: Área total cep: type: string maxLength: 255 description: CEP latitude: type: string maxLength: 255 description: Latitude longitude: type: string maxLength: 255 description: Longitude address: type: string maxLength: 255 description: Endereço number: type: string maxLength: 255 description: Número complement: type: string maxLength: 255 description: Complemento neighborhoodVillage: type: string maxLength: 255 description: Bairro/vilarejo observation: type: string maxLength: 255 description: Observação active: type: boolean description: Se está ativo stateRegistration: type: string maxLength: 255 description: Inscrição estadual municipalRegistration: type: string maxLength: 255 description: Inscrição municiapl companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial segment: type: object allOf: – #/definitions/segmentRecord description: Segmento city: type: object allOf: – #/definitions/cityRecord description: Cidade account: type: object allOf: – #/definitions/accountRecord description: Conta customFields: type: string format: byte description: Campos customizados eventTypeRecord: description: Tipo do evento type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string maxLength: 255 description: Nome active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados eventStatusRecord: description: Status do evento type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome icon: type: string maxLength: 255 description: Ícone active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados followTypeRecord: description: Tipo de follow-up type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome slaHour: type: integer format: int64 description: sla em horas active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados originSystemRecord: description: Origem sistema registro type: object properties: idOrigin: type: integer format: int64 description: Id origem sistema nameOrigin: type: string maxLength: 255 description: Nome da Origem 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 maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 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 maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 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 maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service appointmentFacade: description: Entidade fachada de Compromisso type: object properties: id: type: integer format: int64 description: ID no CRM schedulerUser: type: object allOf: – #/definitions/userRecord description: Usuário agendador externalScheduler: type: object allOf: – #/definitions/externalUserRecord description: Agendador externo subject: type: string maxLength: 255 description: Assunto description: type: string maxLength: 65535 description: Descrição startDate: type: string format: date-time description: Data de início endDate: type: string format: date-time description: Data de término startHour: type: string format: date-time description: Hora de início endHour: type: string format: date-time description: Hora de término place: type: string maxLength: 255 description: Local syncApp: type: boolean description: Se sincroniza o app appId: type: string maxLength: 255 description: Id do app appEdit: type: boolean description: Se edita o app appOrigin: type: boolean description: Se é a origin do app priority: type: object allOf: – #/definitions/priorityRecord description: Prioridade category: type: object allOf: – #/definitions/categoryRecord description: Categoria activity: type: object allOf: – #/definitions/activityRecord description: Atividade origin: type: object allOf: – #/definitions/appointmentOriginRecord description: Origem account: type: object allOf: – #/definitions/accountRecord description: Conta appointments: type: array items: type: object allOf: – #/definitions/simpleAppointmentRecord description: Compromissos contacts: type: array items: type: object allOf: – #/definitions/contactDetailRecord description: Contatos recurrenceType: type: integer format: int64 description: Tipo de ocorrência intervalRecurrence: type: integer format: int64 description: Invervalo da recorrência weeklyRecurrence: type: array items: type: integer format: int64 description: Recorrência semanal annualMonthlyRecurrence: type: integer format: int64 description: Recorrência mensal/anual canceled: type: boolean description: Se está cancelado justificationCancellation: type: string maxLength: 255 description: Justificativa do cancelamento notifyEmail: type: boolean description: Se notifica por e-mail requestAcceptance: type: boolean description: Se solicita aceite hidden: type: integer format: int64 description: Oculto externalId: type: string maxLength: 255 description: Id externo originIntegration: type: object allOf: – #/definitions/originIntegrationRecord description: Origem da recorência property: type: object allOf: – #/definitions/propertyRecord description: Propriedade status: type: integer format: int64 description: Status creatorBy: type: object allOf: – #/definitions/userRecord description: Criado por updatedBy: type: object allOf: – #/definitions/userRecord description: Alterado por customFields: type: string format: byte description: Campos customizados eventFacade: description: Entidade fachada de Evento type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial user: type: object allOf: – #/definitions/userRecord description: Usuário eventType: type: object allOf: – #/definitions/eventTypeRecord description: Tipo evento status: type: object allOf: – #/definitions/eventStatusRecord description: Status description: type: string maxLength: 255 description: Descrição startDate: type: string format: date-time description: Data de início endDate: type: string format: date-time description: Data de término startHour: type: string format: date-time description: Hora de início endHour: type: string format: date-time description: Hora de término notes: type: string maxLength: 255 description: Observações local: type: string maxLength: 255 description: Local appointmentParamsFacade: description: Fachada para AppointmentParams type: object required: – automaticCompletion – automaticCompletionCategories properties: id: type: integer format: int64 description: ID no CRM automaticCompletion: type: boolean description: Conclusão Automática automaticCompletionCategories: type: array items: type: string maxLength: 255 minimum: 1 description: Conclusão Automática Categorias taskFacade: description: Entidade fachada de Tarefa type: object properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição user: type: object allOf: – #/definitions/userRecord description: Usuário schedulerUser: type: object allOf: – #/definitions/userRecord description: Usuário agendador account: type: object allOf: – #/definitions/accountRecord description: Conta opportunity: type: object allOf: – #/definitions/opportunityRecord description: Oportunidade occurrence: type: object allOf: – #/definitions/occurrenceRecord description: Ocorrência category: type: object allOf: – #/definitions/taskCategoryRecord description: Categoria value: type: number format: double description: Valor quantity: type: number format: double description: Quantidade completionPercentage: type: number format: double description: Porcentagem de conclusão notifyEmail: type: integer format: int64 description: Se notifica por e-mail requestAccept: type: boolean description: Se deve solicitar aceite do usuário participante accepted: type: integer format: int64 description: Se foi aceita pelo usuário participante status: type: integer format: int64 description: Status priority: type: integer format: int64 description: Prioridade justification: type: string maxLength: 255 description: Justificativa de não aceite observations: type: string maxLength: 255 description: Observações acceptanceDate: type: string format: date-time description: Data em que foi aceita startDate: type: string format: date-time description: Data de início deadlineDate: type: string format: date-time description: Data limite para conclusão endDate: type: string format: date-time description: Data de término customFields: type: string format: byte description: Campos customizados reminderFacade: description: Entidade fachada do Follow-up type: object properties: id: type: integer format: int64 description: ID originSystem: type: object allOf: – #/definitions/originSystemRecord description: Origem sistema registro companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial recurrenceType: type: integer format: int64 description: Tipo de Recorrência followType: type: object allOf: – #/definitions/followTypeRecord description: Tipo de Follow-up origin: type: string maxLength: 255 description: Origem followDate: type: string format: date-time description: Data do Follow-up followTime: type: string format: date-time description: Hora do Follow-up priority: type: object allOf: – #/definitions/priorityRecord description: Prioridade status: type: boolean description: Status closingDate: type: string format: date-time description: Data de fechamento closingTime: type: string format: date-time description: Hora de fechamento observations: type: string maxLength: 255 description: Observações closingObservations: type: string maxLength: 255 description: Observações de fechamento notifyEmail: type: integer format: int64 description: Notificar e-mail notifyEmailConclude: type: integer format: int64 description: Notificar e-mail quando concluído schedulerUser: type: object allOf: – #/definitions/userRecord description: Usuário Agendador recipientUser: type: object allOf: – #/definitions/userRecord description: Usuário Destinatário recipientsUsers: type: array items: type: object allOf: – #/definitions/recipientsUsersRecord description: Usuários Destinatários registrationDate: type: string format: date-time description: Data de cadastro dateChange: type: string format: date-time description: Data de alteração registerUser: type: object allOf: – #/definitions/userRecord description: Usuário cadastro changeUser: type: object allOf: – #/definitions/userRecord description: Usuário alteração customFields: type: string format: byte description: Campos customizados 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