crm

2.0info: 8.1.1 Contas description: Serviço responsável pelo contas do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: account contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/account/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /getAddressByAccount: post: description: Query que retorna os endereços da conta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – account properties: account: type: integer description: Id da Conta main: type: boolean description: Indicidor se é o endereço principal responses: 200: description: Ok schema: type: object required: – addresses properties: addresses: #/definitions/recordFullAccountAddress default: description: Error response schema: #/definitions/genericError /getHistoryIntegrationByAccount: post: description: Query que retorna o histórico de integração de uma conta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – account properties: account: type: string description: responses: 200: description: Ok schema: type: object required: – historyIntegrations properties: historyIntegrations: #/definitions/recordFullAccountHistoryIntegration default: description: Error response schema: #/definitions/genericError /getDefinitionByAccount: post: description: Query que retorna as definições da conta x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – account properties: account: type: integer description: Id da Conta responses: 200: description: Ok schema: type: object required: – definitions properties: definitions: #/definitions/recordFullAccountDefinition default: description: Error response schema: #/definitions/genericError /accountCreated: post: description: Evento de conta criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccount responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountDefinitionCreated: post: description: Evento de definição de conta criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccountDefinition responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountPhoneCreated: post: description: Evento de telefone criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccountPhone responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountAddressCreated: post: description: Evento de endereço criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccountAddress responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountUpdated: post: description: Evento de conta atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccount responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountDefinitionUpdated: post: description: Evento de definição de conta atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccountDefinition responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountPhoneUpdated: post: description: Evento de telefone atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccountPhone responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountAddressUpdated: post: description: Evento de endereço atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/recordFullAccountAddress responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountDefinition: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError /entities/accountDefinition/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountDefinition/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountDefinition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountPhone: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError /entities/accountPhone/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountPhone/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountPhone responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/account: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/account responses: 200: description: The created resource schema: #/definitions/account default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/account responses: 200: description: The created resource schema: #/definitions/account default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/account default: description: Error response schema: #/definitions/genericError /entities/account/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/account responses: 200: description: Ok schema: #/definitions/account default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/account responses: 200: description: Ok schema: #/definitions/account default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/account default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/account/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/account responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountResponsible: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountResponsible responses: 200: description: The created resource schema: #/definitions/accountResponsible default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountResponsible responses: 200: description: The created resource schema: #/definitions/accountResponsible default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountResponsible default: description: Error response schema: #/definitions/genericError /entities/accountResponsible/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountResponsible responses: 200: description: Ok schema: #/definitions/accountResponsible default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountResponsible responses: 200: description: Ok schema: #/definitions/accountResponsible default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountResponsible default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountResponsible/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountResponsible responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountHistoryIntegration: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountHistoryIntegration responses: 200: description: The created resource schema: #/definitions/accountHistoryIntegration default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountHistoryIntegration responses: 200: description: The created resource schema: #/definitions/accountHistoryIntegration default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountHistoryIntegration default: description: Error response schema: #/definitions/genericError /entities/accountHistoryIntegration/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountHistoryIntegration responses: 200: description: Ok schema: #/definitions/accountHistoryIntegration default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountHistoryIntegration responses: 200: description: Ok schema: #/definitions/accountHistoryIntegration default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountHistoryIntegration default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountHistoryIntegration/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountHistoryIntegration responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountRelationships: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountRelationships responses: 200: description: The created resource schema: #/definitions/accountRelationships default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountRelationships responses: 200: description: The created resource schema: #/definitions/accountRelationships default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountRelationships default: description: Error response schema: #/definitions/genericError /entities/accountRelationships/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountRelationships responses: 200: description: Ok schema: #/definitions/accountRelationships default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountRelationships responses: 200: description: Ok schema: #/definitions/accountRelationships default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountRelationships default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountRelationships/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountRelationships responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountIdentifications: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountIdentifications responses: 200: description: The created resource schema: #/definitions/accountIdentifications default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountIdentifications responses: 200: description: The created resource schema: #/definitions/accountIdentifications default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountIdentifications default: description: Error response schema: #/definitions/genericError /entities/accountIdentifications/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountIdentifications responses: 200: description: Ok schema: #/definitions/accountIdentifications default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountIdentifications responses: 200: description: Ok schema: #/definitions/accountIdentifications default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountIdentifications default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountIdentifications/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountIdentifications responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountCharacteristics: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountCharacteristics responses: 200: description: The created resource schema: #/definitions/accountCharacteristics default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountCharacteristics responses: 200: description: The created resource schema: #/definitions/accountCharacteristics default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountCharacteristics default: description: Error response schema: #/definitions/genericError /entities/accountCharacteristics/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountCharacteristics responses: 200: description: Ok schema: #/definitions/accountCharacteristics default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountCharacteristics responses: 200: description: Ok schema: #/definitions/accountCharacteristics default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountCharacteristics default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountCharacteristics/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountCharacteristics responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountInterestAreas: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountInterestAreas responses: 200: description: The created resource schema: #/definitions/accountInterestAreas default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountInterestAreas responses: 200: description: The created resource schema: #/definitions/accountInterestAreas default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountInterestAreas default: description: Error response schema: #/definitions/genericError /entities/accountInterestAreas/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountInterestAreas responses: 200: description: Ok schema: #/definitions/accountInterestAreas default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountInterestAreas responses: 200: description: Ok schema: #/definitions/accountInterestAreas default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountInterestAreas default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountInterestAreas/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountInterestAreas responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountAddress: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError /entities/accountAddress/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountAddress/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/accountAddress responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/contact: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/contact default: description: Error response schema: #/definitions/genericError /entities/contact/{id}: put: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: Ok schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: Ok schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/contact/bulk: post: description: This entity is customizable. tags: – Entities parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: enumPhoneType: type: string enum: – LANDLINE – CELL – FAX enumOperator: type: string enum: – CLARO – TIM – VIVO – OI enumGender: type: string enum: – UNINFORMED – MASCULINE – FEMININE enumVisibility: type: string enum: – PUBLIC – PRIVATE enumDecisionLevel: type: string enum: – NONE – USER – FINANCIAL_DECISION_MAKER – TECHNICAL_DECISION_MAKER – RECOMMENDS enumFavorableCompany: type: string enum: – YES – INDIFFERENT – NO enumInterestType: type: string enum: – HAS_INTEREST – ALREADY_HAVE – HAS_POTENTIAL – NO_INTEREST recordFullAccountHistoryIntegration: type: object required: – status – content – account properties: id: type: integer description: Id de identificação dateTime: type: string description: Data e hora format: date-time status: type: integer description: Status onde 0: Não Integrado; 1: Integrado: 2: Falha ao integrar content: type: string description: Conteudo account: type: integer description: Id da conta referente a esse histórico recordFullAccount: type: object required: – id – name – registerDate – active – origin – accountDefinition properties: id: type: integer description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do cadastro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários einNumber: type: string description: EIN ssnNumber: type: string description: SSN birthDate: type: string description: Data de nascimento/abertura format: date active: type: boolean description: Status de atividade customFields: type: string description: Campos customizados activityBranch: #/definitions/recordActivityBranch companySize: #/definitions/recordCompanySize personType: #/definitions/recordPersonType companyGroup: #/definitions/recordCompanyGroup origin: #/definitions/recordOrigin accountDefinition: #/definitions/recordBasicAccountDefinition accountResponsible: #/definitions/recordAccountResponsible recordActivityBranch: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da Empresa/Filial recordCompanySize: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do porte da empresa recordPersonType: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do tipo de Pessoa recordCompanyGroup: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome grupo da empresa recordOrigin: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome da origem recordBasicAccountDefinition: type: object required: – accountType – rating – status properties: id: type: integer description: Código de identificação salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados companyBranch: #/definitions/recordCompanyBranch accountType: #/definitions/recordAccountType rating: #/definitions/recordRating status: #/definitions/recordStatus inactivationReason: #/definitions/recordInactivationReason priceTable: #/definitions/recordPriceTable carrier: #/definitions/recordCarrier carrierDispatch: #/definitions/recordCarrierDispatch representative: #/definitions/recordRepresentative seller: #/definitions/recordSeller paymentTerm: #/definitions/recordPaymentTerm recordCompanyBranch: type: object required: – company – branch properties: id: type: integer description: Código de identificação no CRM company: #/definitions/recordCompany branch: #/definitions/recordBranch recordCompany: type: object properties: id: type: integer description: Id de identificação no CRM idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome da Empresa fantasyName: type: string description: Nome fantasia da Empresa recordBranch: type: object properties: id: type: integer description: Id de identificação no CRM idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome da Empresa fantasyName: type: string description: Nome fantasia da Empresa recordAccountType: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do tipo da Conta recordRating: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do Rating da conta recordStatus: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome do status recordInactivationReason: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Motivo da inativação recordPriceTable: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da tabela de preços recordCarrier: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da operadora recordCarrierDispatch: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da operadora de dispacho recordRepresentative: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome do representante recordSeller: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome do vendedor recordPaymentTerm: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome do termo de pagamento recordAccountResponsible: type: object required: – id properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recordFullAccountPhone: type: object required: – id – account – number – type – main properties: id: type: integer description: Código de dentificação account: #/definitions/recordBasicAccount number: type: string description: Número de telefone type: type: integer description: Tipo de telefone operator: type: integer description: Operadora da conta main: type: boolean description: Telefone principal recordBasicAccount: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da conta cnpj: type: string description: CNPJ da Conta cpf: type: string description: CPF da Conta rg: type: string description: RG da Conta recordFullAccountAddress: type: object required: – id – account – type – main – address – active – district – cepCode – city properties: id: type: integer description: Código de identificação account: #/definitions/recordBasicAccount type: #/definitions/recordAddressType main: type: boolean description: Endereço principal address: type: string description: Endereço active: type: boolean description: Status de atividade number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro cepCode: type: string description: CEP latitude: type: string description: Latitude longitude: type: string description: Longitude city: #/definitions/recordCity zipCode: type: string description: ZIP code customFields: type: string description: Campos customizados recordAddressType: type: object required: – id – name properties: id: type: integer description: Código de identificação name: type: string description: Nome recordCity: type: object properties: id: type: integer description: Código de identificação idErp: type: string description: Id do ERP no CRM ibgeCode: type: string description: Código da cidade no IBGE name: type: string description: Nome da cidade state: #/definitions/recordState recordState: type: object required: – id properties: id: type: integer description: Código de identificação idErp: type: string description: Id do ERP no CRM name: type: string description: Nome initials: type: string description: Inicial country: #/definitions/recordCountry recordCountry: type: object required: – id properties: id: type: integer description: Código de identificação idErp: type: string description: Id do ERP no CRM name: type: string description: Nome recordFullAccountDefinition: type: object required: – accountType – rating – status – account properties: id: type: integer description: Código de identificação salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados companyBranch: #/definitions/recordCompanyBranch accountType: #/definitions/recordAccountType rating: #/definitions/recordRating status: #/definitions/recordStatus inactivationReason: #/definitions/recordInactivationReason priceTable: #/definitions/recordPriceTable carrier: #/definitions/recordCarrier carrierDispatch: #/definitions/recordCarrierDispatch representative: #/definitions/recordRepresentative seller: #/definitions/recordSeller paymentTerm: #/definitions/recordPaymentTerm account: #/definitions/recordBasicAccount account: type: object required: – name – personType – origin properties: id: type: integer description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta nit: type: string description: NIT citizenshipCard: type: string description: Identificação de cidadania passport: type: string description: Passaporte activityBranch: #/definitions/recordActivityBranch stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal companySize: #/definitions/recordCompanySize url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do cadastro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários personType: #/definitions/recordPersonType einNumber: type: string description: EIN ssnNumber: type: string description: SSN companyGroup: #/definitions/recordCompanyGroup origin: #/definitions/recordOrigin birthDate: type: string description: Data de nascimento/abertura format: date active: type: integer description: Status de atividade customFields: type: string description: Campos customizados accountPhone: #/definitions/recordAccountPhone accountAddress: #/definitions/recordAccountAddress recordAccountPhone: type: object required: – number – type – main properties: id: type: integer description: Código de identificação da definição da conta no CRM number: type: string description: Número de telefone da conta type: #/definitions/enumPhoneType operator: #/definitions/enumOperator main: type: boolean description: É o principal telefone da conta account: #/definitions/recordBasicAccount recordAccountAddress: type: object required: – main – type – address – district – city – latitude – longitude – active properties: id: type: integer description: Código de identificação main: type: boolean description: É o endereço principal da conta type: #/definitions/recordAddressType address: type: string description: Endereço number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro city: #/definitions/recordCity cepCode: type: string description: CEP zipCode: type: string description: ZIP latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double active: type: integer description: Status do endereço customFields: type: string description: Campos customizados account: #/definitions/recordBasicAccount accountDefinition: type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer description: Código de identificação companyBranch: #/definitions/recordCompanyBranch account: #/definitions/recordBasicAccount status: #/definitions/recordStatus inactivationReason: #/definitions/recordInactivationReason accountType: #/definitions/recordAccountType rating: #/definitions/recordRating priceTable: #/definitions/recordPriceTable carrier: #/definitions/recordCarrier carrierDispatch: #/definitions/recordCarrierDispatch representative: #/definitions/recordRepresentative seller: #/definitions/recordSeller paymentTerm: #/definitions/recordPaymentTerm salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string description: Observações da definição de conta receiveEmail: type: boolean description: Informa se a conta por definição recebe emails do sistema receiveSurvey: type: boolean description: Informa se a conta por definição recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Informa se a conta por definição recebe e monitora emails do sistema clientSince: type: string description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados desse cadastro accountPhone: type: object required: – account – number – type – main properties: id: type: integer description: Código de identificação da definição da conta no CRM account: #/definitions/recordBasicAccount number: type: string description: Número de telefone da conta type: #/definitions/enumPhoneType operator: #/definitions/enumOperator main: type: boolean description: É o principal telefone da conta accountAddress: type: object required: – account – main – type – address – district – city – latitude – longitude – active properties: id: type: integer description: Código de identificação account: #/definitions/recordBasicAccount main: type: boolean description: É o endereço principal da conta type: #/definitions/recordAddressType address: type: string description: Endereço number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro city: #/definitions/recordCity cepCode: type: string description: CEP zipCode: type: string description: ZIP latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double active: type: integer description: Status do endereço customFields: type: string description: Campos customizados accountHistoryIntegration: type: object required: – status – content – account properties: id: type: integer description: Id de identificação dateTime: type: string description: Data e hora format: date-time status: type: integer description: Status onde 1: Não Integrado; 2: Integrado: 3: Falha ao integrar content: type: string description: Conteudo account: type: integer description: Id da conta referente a esse histórico contact: type: object required: – visibility – companyBranch – name – treatment – active properties: id: type: integer description: Código de identificação gender: #/definitions/enumGender visibility: #/definitions/enumVisibility decisionLevel: #/definitions/enumDecisionLevel favorableCompany: #/definitions/enumFavorableCompany isCorporatePhone: type: boolean description: Indicador se o telefone do contato é corporativo isCorporateMobile: type: boolean description: Indicador se o celular do contato é corporativo isWhatsapp: type: boolean description: Indicador se o celular do contato tem Whatsapp isCorporateEmail: type: boolean description: Indicador se o email do contato é corporativo receiveCampaign: type: boolean description: Indicador se o contato recebe campanhas receiveSurvey: type: boolean description: Indicador se o contato recebe pesquisas companyBranch: #/definitions/recordCompanyBranch originContact: #/definitions/recordOriginContact department: #/definitions/recordDepartment role: #/definitions/recordRole superiorContact: #/definitions/recordSuperiorContact account: #/definitions/recordBasicAccount city: #/definitions/recordCity operator: #/definitions/enumOperator name: type: string description: Nome do contato treatment: type: string description: Nome de tratamento do contato email: type: string description: Email do contato phone: type: string description: Telefone do contato phoneBranch: type: string description: Ramal de telefone do contato birthDate: type: string description: Data de nascimento do contato format: date cpf: type: string description: CPF do contato rg: type: string description: RG do contato reasonFavorableCompany: type: string description: Motivo do parecer favorável do cliente para com a empresa zipCode: type: string description: Zip code do contato, quando endereço exterior cep: type: string description: CEP do endereço do contato address: type: string description: Endereço do contato complement: type: string description: Complemento do endereço do contato district: type: string description: Bairro do contato number: type: string description: Número do endereço do contato mobile: type: string description: Número de celular do contato facebook: type: string description: Endereço do Facebook do contato twitter: type: string description: Endereço do Twitter do contato skype: type: string description: Skype do contato note: type: string description: Observações internas do contato active: type: boolean description: Indicador se o registro do contato está ativo no sistema recordOriginContact: type: object required: – id properties: id: type: integer description: Código de identificação recordDepartment: type: object required: – id properties: id: type: integer description: Código de identificação recordRole: type: object required: – id properties: id: type: integer description: Código de identificação recordSuperiorContact: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro accountRelationships: type: object required: – relationshipType – childAccount – fatherAccount – status properties: id: type: integer description: Código de identificação relationshipType: #/definitions/recordRelationshipType childAccount: #/definitions/recordBasicAccount fatherAccount: #/definitions/recordBasicAccount status: type: boolean description: Indicador se o registro de vínculo entre contas está ativo no sistema startDate: type: string description: Data inicial da relação entre as contas format: date startHour: type: string description: Hora inicial da relação entre as contas endDate: type: string description: Data final da relação entre as contas format: date endHour: type: string description: Hora final da relação entre as contas note: type: string description: Observações recordRelationshipType: type: object properties: id: type: integer description: Código de identificação accountResponsible: type: object required: – account properties: id: type: integer description: Código de identificação account: #/definitions/recordBasicAccount responsible: #/definitions/recordUser group: type: array items: #/definitions/recordGroup description: Grupo de usuários recordUser: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recordGroup: type: object properties: id: type: integer description: Código de identificação accountInterestAreas: type: object required: – interestAreas – account – interestType properties: id: type: integer description: Código de identificação interestAreas: #/definitions/recordInterestArea account: #/definitions/recordBasicAccount interestType: #/definitions/enumInterestType note: type: string description: Observações recordInterestArea: type: object properties: id: type: integer description: Código de identificação accountIdentifications: type: object required: – code – description – account properties: id: type: integer description: Código de identificação code: type: integer description: Outro possível código para a conta description: type: string description: Descrição do código account: #/definitions/recordBasicAccount accountCharacteristics: type: object required: – account – characteristics properties: id: type: integer description: Código de identificação account: #/definitions/recordBasicAccount characteristics: type: array items: #/definitions/recordCharacteristic description: Características da conta recordCharacteristic: type: object properties: id: type: integer description: Código de identificação 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