crm

2.0info: 9.7.0 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/accountsecurityDefinitions: 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: /accountCreated: post: description: Evento disparado quando um conta é criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountUpdated: post: description: Evento disparado quando um conta é atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountDefinitionCreated: post: description: Evento disparado quando uma definição da conta é criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountDefinitionRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountDefinitionUpdated: post: description: Evento disparado quando uma definição da conta é atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountDefinitionRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountPhoneCreated: post: description: Evento disparado quando um telefone da conta é criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountPhoneRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountPhoneUpdated: post: description: Evento disparado quando um telefone da conta é atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountPhoneRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountAddressCreated: post: description: Evento disparado quando um endereço da conta é criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountAddressRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountAddressUpdated: post: description: Evento disparado quando um endereço da conta é atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/fullAccountAddressRecord responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountDefinition: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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 security: – bearerAuth: [] 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: fullAccountRecord: type: object 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 economicGroup: type: string description: Grupo Econômico stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal cnpj: type: string description: CNPJ da conta rg: type: string description: RG da conta cpf: type: string description: CPF da conta einNumber: type: string description: EIN ssnNumber: type: string description: SSN url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro employees: type: integer description: Funcionários annualIncome: type: number description: Receita anual format: double registerDate: type: string description: Data do cadastro format: date-time customerSince: type: string description: Cliente desde format: date-time birthDate: type: string description: Data de nascimento/abertura format: date-time receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email customFields: type: string description: Campos customizados format: byte active: type: boolean description: Status de atividade personType: #/definitions/personTypeRecord companySize: #/definitions/companySizeRecord activityBranch: #/definitions/activityBranchRecord companyGroup: #/definitions/companyGroupRecord origin: #/definitions/originRecord definitions: type: array items: #/definitions/fullAccountDefinitionRecord description: Definições nit: type: string description: NIT citizenshipCard: type: string description: Cédula Cidadania passport: type: string description: Passaporte addresses: type: array items: #/definitions/fullAccountAddressRecord description: Endereços phones: type: array items: #/definitions/fullAccountPhoneRecord description: Telefones personTypeRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companySizeRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte activityBranchRecord: 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 active: type: boolean description: Ativo company: #/definitions/companyRecord companyRecord: type: object properties: id: type: integer description: Id de identificação no CRM companyErp: 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 cnpj: type: string description: CNPJ nit: type: string description: NIT companyGroupRecord: type: object properties: id: type: integer description: Código de identificação idErp: type: string description: Identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord originRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome da origem active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord fullAccountDefinitionRecord: type: object properties: id: type: integer description: Código de identificação idErp: type: string description: Id no sistema terceiro salesGoal: type: number description: Meta prevista format: double note: type: string description: Observações customFields: type: string description: Campos customizados format: byte receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email clientSince: type: string description: Cliente desde format: date-time rating: #/definitions/ratingRecord carrier: #/definitions/carrierRecord carrierDispatch: #/definitions/carrierDispatchRecord account: #/definitions/fullAccountRecord accountType: #/definitions/accountTypeRecord companyBranch: #/definitions/companyBranchRecord status: #/definitions/statusRecord paymentTerm: #/definitions/paymentTermRecord inactivationReason: #/definitions/inactivationReasonRecord priceTable: #/definitions/priceTableRecord typePayment: #/definitions/typePaymentRecord representative: #/definitions/representativeRecord seller: #/definitions/sellerRecord ratingRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte carrierRecord: 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 active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord companyBranchRecord: type: object properties: id: type: integer description: Código de identificação no CRM company: #/definitions/companyRecord branch: #/definitions/branchRecord branchRecord: type: object properties: id: type: integer description: Id de identificação no CRM branchErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ headquarters: type: integer description: Matriz nit: type: string description: NIT carrierDispatchRecord: 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 active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord accountTypeRecord: type: object required: – id properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo icon: type: string description: Ícone color: type: string description: Cor requiredFields: type: string description: Campos obrigatórios customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord statusRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome do status active: type: integer description: Ativo customFields: type: string description: Campos customizados format: byte icon: type: string description: Ícone idErp: type: string description: Id no sistema terceiro paymentTermRecord: 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 active: type: boolean description: Ativo generatesInstallments: type: boolean description: Gera parcelas amountInstallments: type: integer description: Quantidade de parcelas additionInstallments: type: number description: Acréscimos de parcelas format: double rounding: type: integer description: Arredondamento customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord inactivationReasonRecord: type: object properties: id: type: integer description: Código de identificação companyBranch: #/definitions/companyBranchRecord name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte priceTableRecord: 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 valueAddition: type: number description: Valor acréscimo format: double active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord typePaymentRecord: type: object properties: id: type: integer description: Código de identificação idErp: type: string description: Id no sistema terceiro name: type: string description: Nome valueAddition: type: number description: Valor de Acréscimo format: double active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord representativeRecord: 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 sellerRecord: 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 fullAccountAddressRecord: type: object properties: id: type: integer description: Código de identificação main: type: boolean description: Principal account: #/definitions/fullAccountRecord address: #/definitions/addressRecord addressRecord: type: object properties: id: type: integer description: Código de identificação active: type: boolean description: Ativo name: type: string description: Nome address: type: string description: Endereço number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro cep: type: string description: CEP latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double customFields: type: string description: Campos customizados format: byte type: #/definitions/addressTypeRecord companyBranch: #/definitions/companyBranchRecord city: #/definitions/cityRecord zipCode: type: string description: ZIP addressTypeRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte companyBranch: #/definitions/companyBranchRecord cityRecord: type: object properties: id: type: integer description: Código de identificação idErp: type: string description: Id no sistema terceiro idIbge: type: string description: Código da cidade no IBGE name: type: string description: Nome active: type: boolean description: Ativo dddCode: type: string description: Código DDD population: type: integer description: População estimatedPopulation: type: integer description: População Estimada consumptionPotential: type: number description: Potencial de consumo format: double pib: type: number description: PIB format: double customFields: type: string description: Custom Fields format: byte state: #/definitions/stateRecord stateRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Ativo country: #/definitions/countryRecord customFields: type: string description: Campos customizados format: byte idErp: type: string description: Id no sistema terceiro countryRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte countryCode: type: integer description: Código do País idErp: type: string description: Id no sistema terceiro fullAccountPhoneRecord: type: object properties: id: type: integer description: Código de identificação da definição da conta no CRM number: type: string description: Número type: type: integer description: Tipo operator: type: integer description: Operadora main: type: boolean description: Principal account: #/definitions/fullAccountRecord account: type: object 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 economicGroup: type: string description: Grupo Econômico stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal cnpj: type: string description: CNPJ da conta rg: type: string description: RG da conta cpf: type: string description: CPF da conta einNumber: type: string description: EIN ssnNumber: type: string description: SSN url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro employees: type: integer description: Funcionários annualIncome: type: number description: Receita anual format: double registerDate: type: string description: Data do cadastro format: date-time customerSince: type: string description: Cliente desde format: date-time birthDate: type: string description: Data de nascimento/abertura format: date-time receiveEmail: type: boolean description: Recebe email receiveEmailMarketing: type: boolean description: Recebe E-mail Marketing receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email customFields: type: string description: Campos customizados format: byte active: type: boolean description: Status de atividade personType: #/definitions/personTypeRecord companySize: #/definitions/companySizeRecord activityBranch: #/definitions/activityBranchRecord companyGroup: #/definitions/companyGroupRecord origin: #/definitions/originRecord responsible: type: array items: #/definitions/accountResponsible description: Responsáveis definitions: type: array items: #/definitions/accountDefinition description: Definições nit: type: string description: NIT citizenshipCard: type: string description: Cédula Cidadania passport: type: string description: Passaporte addresses: type: array items: #/definitions/accountAddress description: Endereços phones: type: array items: #/definitions/accountPhone description: Telefones historicIntegrations: type: array items: #/definitions/accountHistoryIntegration description: Histórico de Integrações contacts: type: array items: #/definitions/contact description: Contatos identifiers: type: array items: #/definitions/accountIdentifications description: Identificadores accountResponsible: type: object properties: id: type: integer description: Código de identificação erpOrigin: type: boolean description: Origem ERP user: #/definitions/userRecord account: #/definitions/account group: #/definitions/groupRecord userRecord: 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 lastName: type: string description: Sobrenome descriptionFunction: type: string description: Descrição Função photo: type: string description: Foto email: type: string description: Email active: type: boolean description: Ativo groupRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord users: type: array items: #/definitions/userGroupRecord description: Usuário idErp: type: integer description: Id no Sistema Terceiro userGroupRecord: type: object properties: id: type: integer description: Id user: #/definitions/userRecord group: #/definitions/groupRecord accountDefinition: type: object properties: id: type: integer description: Código de identificação idErp: type: string description: Id no sistema terceiro salesGoal: type: number description: Meta prevista format: double note: type: string description: Observações customFields: type: string description: Campos customizados format: byte receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email clientSince: type: string description: Cliente desde format: date-time rating: #/definitions/ratingRecord carrier: #/definitions/carrierRecord carrierDispatch: #/definitions/carrierDispatchRecord account: #/definitions/account accountType: #/definitions/accountTypeRecord companyBranch: #/definitions/companyBranchRecord status: #/definitions/statusRecord paymentTerm: #/definitions/paymentTermRecord inactivationReason: #/definitions/inactivationReasonRecord priceTable: #/definitions/priceTableRecord typePayment: #/definitions/typePaymentRecord representative: #/definitions/representativeRecord seller: #/definitions/sellerRecord accountAddress: type: object properties: id: type: integer description: Código de identificação main: type: boolean description: Principal account: #/definitions/account address: #/definitions/addressRecord accountPhone: type: object properties: id: type: integer description: Código de identificação da definição da conta no CRM number: type: string description: Número type: type: integer description: Tipo operator: type: integer description: Operadora main: type: boolean description: Principal account: #/definitions/account accountHistoryIntegration: type: object 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: Conteúdo account: #/definitions/account contact: type: object properties: id: type: integer description: Código de identificação search: type: integer description: Pesquisa privateUser: type: integer description: Usuário privado sequentialErp: type: string description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer description: Visibilidade name: type: string description: Nome treatment: type: string description: Tratamento functionDescription: type: string description: Função Descrição gender: type: integer description: Gênero Sexual cep: type: string description: CEP zipCode: type: string description: ZIP Code address: type: string description: Endereço number: type: string description: Numero complement: type: string description: Complemento district: type: string description: Bairro cpf: type: string description: CPF rg: type: string description: RG citizenshipCard: type: string description: Cédula Cidadania telephone: type: string description: Telefone corporatePhone: type: boolean description: Telefone Corporativo phoneBranch: type: string description: Ramal fax: type: string description: FAX cell: type: string description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer description: Operadora email: type: string description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveEmailMarketing: type: boolean description: Recebe E-mail Marketing receiveSearch: type: boolean description: Recebe pesquisa skype: type: string description: Skype twitter: type: string description: Twitter facebook: type: string description: Facebook birthday: type: string description: Aniversário birthDate: type: string description: Data de Nascimento format: date-time decisionLevel: type: integer description: Nível de Decisão opinionCompany: type: integer description: Parecer Empresa reasonOpinionCompany: type: string description: Motivo Parecer Empresa note: type: string description: Observações customFields: type: string description: Campos Customizados format: byte city: #/definitions/cityRecord department: #/definitions/departmentRecord function: #/definitions/functionRecord origin: #/definitions/originRecord account: #/definitions/account superiorContact: #/definitions/contact companyBranch: #/definitions/companyBranchRecord departmentRecord: type: object properties: id: type: integer description: Código de identificação companyBranch: #/definitions/companyBranchRecord name: type: string description: Nome active: type: boolean description: Ativo usesOccurrence: type: boolean description: Usa Ocorrência customFields: type: string description: Campos Customizados format: byte functionRecord: type: object properties: id: type: integer description: Código de identificação company: #/definitions/companyRecord name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos Customizados format: byte idErp: type: string description: Id no sistema terceiro accountIdentifications: type: object 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/account accountRelationships: type: object properties: id: type: integer description: Código de identificação note: type: string description: Observações status: type: boolean description: Status fatherAccount: #/definitions/account childAccount: #/definitions/account relationshipType: #/definitions/relationshipTypeRecord relationshipTypeRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte accountInterestAreas: type: object properties: id: type: integer description: Código de identificação interestType: type: integer description: Tipo de interesse note: type: string description: Observações dateRegister: type: string description: Data de Cadastro format: date-time account: #/definitions/account interestAreas: #/definitions/interestAreaRecord interestAreaRecord: type: object properties: id: type: integer description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string description: Campos customizados format: byte company: #/definitions/companyRecord accountCharacteristics: type: object properties: id: type: integer description: Código de identificação account: #/definitions/recordBasicAccount characteristics: type: array items: #/definitions/recordCharacteristic description: Características da conta 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 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