Contas (account)

2.0info: 10.3.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: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/crmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /account/queries/updateAccountReceiveEmailMarketing: post: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string maxLength: 255 description: Dados em formato Base64 para decodificação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Dados em formato Base64 para decodificação in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /account/queries/updateContactReceiveEmailMarketing: post: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string maxLength: 255 description: Dados em formato Base64 para decodificação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Dados em formato Base64 para decodificação in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /account/queries/getAccountContactByPhone: post: description: Retorna o contato de uma conta a partir de um telefone tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – phoneNumber properties: phoneNumber: type: string maxLength: 255 description: Número de telefone responses: 200: description: Ok schema: type: object required: – accounts – contacts properties: accounts: type: array items: type: object allOf: – #/definitions/fullAccountRecord minimum: 1 description: Contas contacts: type: array items: type: object allOf: – #/definitions/fullContactRecord minimum: 1 description: Contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o contato de uma conta a partir de um telefone tags: – Queries x-senior-visibility: PRIVATE parameters: – name: phoneNumber description: Número de telefone in: query required: true type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – accounts – contacts properties: accounts: type: array items: type: object allOf: – #/definitions/fullAccountRecord minimum: 1 description: Contas contacts: type: array items: type: object allOf: – #/definitions/fullContactRecord minimum: 1 description: Contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/healthcheck: post: description: Healthcheck do serviço de exportação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/statusHealthcheckEnum description: Status geral do serviço checks: type: object allOf: – #/definitions/checkRecord description: Checagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Healthcheck do serviço de exportação tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/statusHealthcheckEnum description: Status geral do serviço checks: type: object allOf: – #/definitions/checkRecord description: Checagens 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string maxLength: 255 description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string maxLength: 255 responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string maxLength: 255 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/publishEvent: post: description: Dispara um evento do account tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – action – payload – facade – accessKey properties: action: type: string allOf: – #/definitions/actionEnum description: Ação do evento a ser disparado payload: type: string maxLength: 10485760 description: Conteúdo em forma de json desse evento facade: type: string maxLength: 255 description: Nome da facade accessKey: type: string maxLength: 255 description: Chave de acesso responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/events/accountCreated: post: description: Evento disparado quando um conta é criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountUpdated: post: description: Evento disparado quando um conta é atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDeleted: post: description: Evento disparado quando um conta é deletada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionCreated: post: description: Evento disparado quando uma definição da conta é criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountDefinitionRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionUpdated: post: description: Evento disparado quando uma definição da conta é atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountDefinitionRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionDeleted: post: description: Evento disparado quando uma definição da conta é deletada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountDefinitionRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneCreated: post: description: Evento disparado quando um telefone da conta é criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountPhoneRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneUpdated: post: description: Evento disparado quando um telefone da conta é atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountPhoneRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneDeleted: post: description: Evento disparado quando um telefone da conta é deletado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountPhoneRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressCreated: post: description: Evento disparado quando um endereço da conta é criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountAddressRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressUpdated: post: description: Evento disparado quando um endereço da conta é atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountAddressRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressDeleted: post: description: Evento disparado quando um endereço da conta é deletada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountAddressRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/apis/account: post: description: Entidade fachada da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountFacade responses: 200: description: Ok schema: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/account/{id}: get: description: Entidade fachada da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountFacade responses: 200: description: Ok schema: #/definitions/accountFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountDefinition: post: description: Entidade fachada da Definições da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountDefinitionFacade responses: 200: description: Ok schema: #/definitions/accountDefinitionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada da Definições da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountDefinitionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountDefinition/{id}: get: description: Entidade fachada da Definições da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountDefinitionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada da Definições da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountDefinitionFacade responses: 200: description: Ok schema: #/definitions/accountDefinitionFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada da Definições da Conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountAddress: post: description: Entidade fachada do endereço da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountAddressFacade responses: 200: description: Ok schema: #/definitions/accountAddressFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada do endereço da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountAddressFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountAddress/{id}: get: description: Entidade fachada do endereço da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountAddressFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada do endereço da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountAddressFacade responses: 200: description: Ok schema: #/definitions/accountAddressFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada do endereço da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountPhone: post: description: Entidade fachada da conta de telefone tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountPhoneFacade responses: 200: description: Ok schema: #/definitions/accountPhoneFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada da conta de telefone tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountPhoneFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountPhone/{id}: get: description: Entidade fachada da conta de telefone tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountPhoneFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada da conta de telefone tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountPhoneFacade responses: 200: description: Ok schema: #/definitions/accountPhoneFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada da conta de telefone tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountHistoryIntegration: post: description: Facade referente ao histórico de integração da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountHistoryIntegrationFacade responses: 200: description: Ok schema: #/definitions/accountHistoryIntegrationFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Facade referente ao histórico de integração da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountHistoryIntegrationFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountHistoryIntegration/{id}: get: description: Facade referente ao histórico de integração da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountHistoryIntegrationFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Facade referente ao histórico de integração da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountHistoryIntegrationFacade responses: 200: description: Ok schema: #/definitions/accountHistoryIntegrationFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Facade referente ao histórico de integração da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/contact: post: description: Entidade fachada referente ao contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/contactFacade responses: 200: description: Ok schema: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente ao contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/contact/{id}: get: description: Entidade fachada referente ao contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente ao contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/contactFacade responses: 200: description: Ok schema: #/definitions/contactFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente ao contato tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountRelationships: post: description: Entidade fachada referente ao relacionamento de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountRelationshipsFacade responses: 200: description: Ok schema: #/definitions/accountRelationshipsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente ao relacionamento de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountRelationshipsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountRelationships/{id}: get: description: Entidade fachada referente ao relacionamento de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountRelationshipsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente ao relacionamento de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountRelationshipsFacade responses: 200: description: Ok schema: #/definitions/accountRelationshipsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente ao relacionamento de contas tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountResponsible: post: description: Entidade fachada referente ao responsável da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountResponsibleFacade responses: 200: description: Ok schema: #/definitions/accountResponsibleFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente ao responsável da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountResponsibleFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountResponsible/{id}: get: description: Entidade fachada referente ao responsável da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountResponsibleFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente ao responsável da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountResponsibleFacade responses: 200: description: Ok schema: #/definitions/accountResponsibleFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente ao responsável da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountInterestAreas: post: description: Entidade fachada referente à área de interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountInterestAreasFacade responses: 200: description: Ok schema: #/definitions/accountInterestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente à área de interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountInterestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountInterestAreas/{id}: get: description: Entidade fachada referente à área de interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountInterestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente à área de interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountInterestAreasFacade responses: 200: description: Ok schema: #/definitions/accountInterestAreasFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente à área de interesse tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountIdentifications: post: description: Entidade fachada referente aos identificadores da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountIdentificationsFacade responses: 200: description: Ok schema: #/definitions/accountIdentificationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente aos identificadores da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountIdentificationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountIdentifications/{id}: get: description: Entidade fachada referente aos identificadores da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountIdentificationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente aos identificadores da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountIdentificationsFacade responses: 200: description: Ok schema: #/definitions/accountIdentificationsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente aos identificadores da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountCharacteristics: post: description: Entidade fachada referente às características da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/accountCharacteristicsFacade responses: 200: description: Ok schema: #/definitions/accountCharacteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Entidade fachada referente às características da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/accountCharacteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/apis/accountCharacteristics/{id}: get: description: Entidade fachada referente às características da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountCharacteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError put: description: Entidade fachada referente às características da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/accountCharacteristicsFacade responses: 200: description: Ok schema: #/definitions/accountCharacteristicsFacade 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Entidade fachada referente às características da conta tags: – APIS x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: actionEnum: description: Enum com as ações de uma facade type: string enum: – CREATED – UPDATED – DELETED statusHealthcheckEnum: description: UP ou DOWN type: string enum: – UP – DOWN userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fullAccountRecord: description: Record cópia da facade account type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Código de identificação name: type: string maxLength: 255 description: Nome da conta fantasyName: type: string maxLength: 255 description: Nome fantasia economicGroup: type: string maxLength: 255 description: Grupo Econômico stateRegistration: type: string maxLength: 255 description: Inscrição estadual municipalRegistration: type: string maxLength: 255 description: Inscrição municipal cnpj: type: string maxLength: 255 description: CNPJ da conta rg: type: string maxLength: 255 description: RG da conta cpf: type: string maxLength: 255 description: CPF da conta einNumber: type: string maxLength: 255 description: EIN ssnNumber: type: string maxLength: 255 description: SSN url: type: string maxLength: 255 description: URL do site da conta generalEmail: type: string maxLength: 255 description: E-mail geral financialEmail: type: string maxLength: 255 description: E-mail financeiro employees: type: integer format: int64 description: Funcionários annualIncome: type: number format: double description: Receita anual registerDate: type: string format: date-time description: Data do cadastro customerSince: type: string format: date-time description: Cliente desde birthDate: type: string format: date-time description: Data de nascimento/abertura 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 format: byte description: Campos customizados active: type: boolean description: Status de atividade personType: type: object allOf: – #/definitions/personTypeRecord description: Tipo de pessoa companySize: type: object allOf: – #/definitions/companySizeRecord description: Porte da empresa activityBranch: type: object allOf: – #/definitions/activityBranchRecord description: Ramo de atividade companyGroup: type: object allOf: – #/definitions/companyGroupRecord description: Grupo de empresa origin: type: object allOf: – #/definitions/originRecord description: Origem responsible: type: array items: type: object allOf: – #/definitions/fullAccountResponsibleRecord description: Responsáveis definitions: type: array items: type: object allOf: – #/definitions/fullAccountDefinitionRecord description: Definições nit: type: string maxLength: 255 description: NIT citizenshipCard: type: string maxLength: 255 description: Cédula Cidadania passport: type: string maxLength: 255 description: Passaporte addresses: type: array items: type: object allOf: – #/definitions/fullAccountAddressRecord description: Endereços phones: type: array items: type: object allOf: – #/definitions/fullAccountPhoneRecord description: Telefones historicIntegrations: type: array items: type: object allOf: – #/definitions/fullAccountHistoryIntegrationRecord description: Histórico de Integrações contacts: type: array items: type: object allOf: – #/definitions/fullContactRecord description: Contatos identifiers: type: array items: type: object allOf: – #/definitions/fullAccountIdentificationsRecord description: Identificadores characteristics: type: array items: type: object allOf: – #/definitions/fullAccountCharacteristicsRecord description: Caracteristicas fullAccountDefinitionRecord: description: Record cópia da facade accountDefinition type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Id no sistema terceiro salesGoal: type: number format: double description: Meta prevista note: type: string maxLength: 255 description: Observações customFields: type: string format: byte description: Campos customizados receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email clientSince: type: string format: date-time description: Cliente desde rating: type: object allOf: – #/definitions/ratingRecord description: Rating carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora carrierDispatch: type: object allOf: – #/definitions/carrierDispatchRecord description: Redespacho account: type: object allOf: – #/definitions/fullAccountRecord description: Conta accountType: type: object allOf: – #/definitions/accountTypeRecord description: Tipo de conta companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial status: type: object allOf: – #/definitions/statusRecord description: Status paymentTerm: type: object allOf: – #/definitions/paymentTermRecord description: Prazo de pagamento inactivationReason: type: object allOf: – #/definitions/inactivationReasonRecord description: Motivo da inativação priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço typePayment: type: object allOf: – #/definitions/typePaymentRecord description: Tipo de Pagamento representative: type: object allOf: – #/definitions/representativeRecord description: Representante seller: type: object allOf: – #/definitions/sellerRecord description: Vendedor fullAccountAddressRecord: description: Record cópia da facade accountAddress type: object properties: id: type: integer format: int64 description: Código de identificação main: type: boolean description: Principal account: type: object allOf: – #/definitions/fullAccountRecord description: Conta address: type: object allOf: – #/definitions/addressRecord description: Endereço fullAccountPhoneRecord: description: Record cópia da facade accountPhone type: object properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM number: type: string maxLength: 255 description: Número type: type: integer format: int64 description: Tipo operator: type: integer format: int64 description: Operadora main: type: boolean description: Principal account: type: object allOf: – #/definitions/fullAccountRecord description: Conta fullAccountHistoryIntegrationRecord: description: Record cópia da facade accountHistoryIntegration type: object properties: id: type: integer format: int64 description: Id de identificação dateTime: type: string format: date-time description: Data e hora status: type: integer format: int64 description: Status onde 1: Não Integrado 2: Integrado: 3: Falha ao integrar minimum: 0 maximum: 2 content: type: string maxLength: 255 description: Conteúdo account: type: object allOf: – #/definitions/fullAccountRecord description: Conta fullAccountRelationshipsRecord: description: Record cópia da facade accountRelationships type: object properties: id: type: integer format: int64 description: Código de identificação note: type: string maxLength: 255 description: Observações status: type: boolean description: Status fatherAccount: type: object allOf: – #/definitions/fullAccountRecord description: Conta Pai childAccount: type: object allOf: – #/definitions/fullAccountRecord description: Conta Filha relationshipType: type: object allOf: – #/definitions/relationshipTypeRecord description: Tipo do relacionamento fullAccountResponsibleRecord: description: Record cópia da facade accountResponsible type: object properties: id: type: integer format: int64 description: Código de identificação erpOrigin: type: boolean description: Origem ERP user: type: object allOf: – #/definitions/userRecord description: Usuário account: type: object allOf: – #/definitions/fullAccountRecord description: Conta group: type: object allOf: – #/definitions/groupRecord description: Grupo de usuários fullAccountInterestAreasRecord: description: Record cópia da facade accountInterestAreas type: object properties: id: type: integer format: int64 description: Código de identificação interestType: type: integer format: int64 description: Tipo de interesse note: type: string maxLength: 255 description: Observações dateRegister: type: string format: date-time description: Data de Cadastro account: type: object allOf: – #/definitions/fullAccountRecord description: Conta interestAreas: type: object allOf: – #/definitions/interestAreaRecord description: Área de interesse fullAccountIdentificationsRecord: description: Record cópia da facade accountIdentifications type: object properties: id: type: integer format: int64 description: Código de identificação code: type: integer format: int64 description: Outro possível código para a conta description: type: string maxLength: 255 description: Descrição do código account: type: object allOf: – #/definitions/fullAccountRecord description: Conta fullAccountCharacteristicsRecord: description: Record cópia da facade accountCharacteristics type: object properties: id: type: integer format: int64 description: Código de identificação dateRegister: type: string format: date-time description: Data de Cadastro quantity: type: number format: double description: Quantidade observations: type: string maxLength: 255 description: Observações account: type: object allOf: – #/definitions/recordBasicAccount description: Conta characteristic: type: object allOf: – #/definitions/recordCharacteristic description: Características da conta fullContactRecord: description: Record cópia da facade contact type: object properties: id: type: integer format: int64 description: Código de identificação search: type: integer format: int64 description: Pesquisa privateUser: type: integer format: int64 description: Usuário privado sequentialErp: type: string maxLength: 255 description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer format: int64 description: Visibilidade name: type: string maxLength: 255 description: Nome treatment: type: string maxLength: 255 description: Tratamento functionDescription: type: string maxLength: 255 description: Função Descrição gender: type: integer format: int64 description: Gênero Sexual cep: type: string maxLength: 255 description: CEP zipCode: type: string maxLength: 255 description: ZIP Code address: type: string maxLength: 255 description: Endereço number: type: string maxLength: 255 description: Numero complement: type: string maxLength: 255 description: Complemento district: type: string maxLength: 255 description: Bairro cpf: type: string maxLength: 255 description: CPF rg: type: string maxLength: 255 description: RG citizenshipCard: type: string maxLength: 255 description: Cédula Cidadania telephone: type: string maxLength: 255 description: Telefone corporatePhone: type: boolean description: Telefone Corporativo phoneBranch: type: string maxLength: 255 description: Ramal fax: type: string maxLength: 255 description: FAX cell: type: string maxLength: 255 description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer format: int64 description: Operadora email: type: string maxLength: 255 description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveEmailMarketing: type: boolean description: Recebe E-mail Marketing receiveSearch: type: boolean description: Recebe pesquisa skype: type: string maxLength: 255 description: Skype twitter: type: string maxLength: 255 description: Twitter linkedin: type: string maxLength: 255 description: Linkedin instagram: type: string maxLength: 255 description: Instagram facebook: type: string maxLength: 255 description: Facebook birthday: type: string maxLength: 255 description: Aniversário birthDate: type: string format: date-time description: Data de Nascimento decisionLevel: type: integer format: int64 description: Nível de Decisão opinionCompany: type: integer format: int64 description: Parecer Empresa reasonOpinionCompany: type: string maxLength: 255 description: Motivo Parecer Empresa note: type: string maxLength: 255 description: Observações customFields: type: string format: byte description: Campos Customizados city: type: object allOf: – #/definitions/cityRecord description: Cidade department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função origin: type: object allOf: – #/definitions/originRecord description: Origem account: type: object allOf: – #/definitions/fullAccountRecord description: Conta superiorContact: type: object allOf: – #/definitions/fullContactRecord description: Contato Superior companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial activityBranchRecord: description: Ramo de atividade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo company: type: object allOf: – #/definitions/companyRecord description: Empresa companySizeRecord: description: Porte da empresa type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados personTypeRecord: description: Tipo de pessoa type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome icon: type: string maxLength: 255 description: Ícone active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyGroupRecord: description: Grupo de empresa type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Identificação no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa originRecord: description: Origem da conta type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome da origem active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa companyBranchRecord: description: Empresa filial da definição da conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM company: type: object allOf: – #/definitions/companyRecord description: Empresa branch: type: object allOf: – #/definitions/branchRecord description: Filial companyRecord: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM companyErp: type: string maxLength: 255 description: Id de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome da Empresa fantasyName: type: string maxLength: 255 description: Nome fantasia da Empresa cnpj: type: string maxLength: 255 description: CNPJ nit: type: string maxLength: 255 description: NIT branchRecord: description: Objeto referente a filial da Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM branchErp: type: string maxLength: 255 description: Id de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome fantasyName: type: string maxLength: 255 description: Nome fantasia cnpj: type: string maxLength: 255 description: CNPJ headquarters: type: integer format: int64 description: Matriz nit: type: string maxLength: 255 description: NIT recordBasicAccount: description: Conta da definição type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome da conta cnpj: type: string maxLength: 255 description: CNPJ da Conta cpf: type: string maxLength: 255 description: CPF da Conta rg: type: string maxLength: 255 description: RG da Conta statusRecord: description: Status da definição da conta type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome do status active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados icon: type: string maxLength: 255 description: Ícone idErp: type: string maxLength: 255 description: Id no sistema terceiro inactivationReasonRecord: description: Motivo da inativação type: object properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados accountTypeRecord: description: Tipo de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo icon: type: string maxLength: 255 description: Ícone color: type: string maxLength: 255 description: Cor requiredFields: type: string maxLength: 255 description: Campos obrigatórios customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa ratingRecord: description: Rating da conta por definição type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome icon: type: string maxLength: 255 description: Ícone active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados priceTableRecord: description: Tabela de preço padrão para a definição de conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome valueAddition: type: number format: double description: Valor acréscimo active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Filial da Empresa carrierRecord: description: Transportadora type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Filial da empresa carrierDispatchRecord: description: Transportadora de Redespacho type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Filial da empresa representativeRecord: description: Representante type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome sellerRecord: description: Vendedor type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome paymentTermRecord: description: Prazo de pagamento padrão para a definição de conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo generatesInstallments: type: boolean description: Gera parcelas amountInstallments: type: integer format: int64 description: Quantidade de parcelas additionInstallments: type: number format: double description: Acréscimos de parcelas rounding: type: integer format: int64 description: Arredondamento customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa typePaymentRecord: description: Tipo de Pagamento type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Id no sistema terceiro name: type: string maxLength: 255 description: Nome valueAddition: type: number format: double description: Valor de Acréscimo active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial addressRecord: description: Endereço type: object properties: id: type: integer format: int64 description: Código de identificação active: type: boolean description: Ativo name: type: string maxLength: 255 description: Nome address: type: string maxLength: 255 description: Endereço number: type: string maxLength: 255 description: Número complement: type: string maxLength: 255 description: Complemento district: type: string maxLength: 255 description: Bairro cep: type: string maxLength: 255 description: CEP latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude customFields: type: string format: byte description: Campos customizados type: type: object allOf: – #/definitions/addressTypeRecord description: Tipo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial city: type: object allOf: – #/definitions/cityRecord description: Cidade zipCode: type: string maxLength: 255 description: ZIP addressTypeRecord: description: Tipo do endereço type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial cityRecord: description: Cidade type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Id no sistema terceiro idIbge: type: string maxLength: 255 description: Código da cidade no IBGE name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo dddCode: type: string maxLength: 255 description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População Estimada consumptionPotential: type: number format: double description: Potencial de consumo pib: type: number format: double description: PIB customFields: type: string format: byte description: Custom Fields state: type: object allOf: – #/definitions/stateRecord description: Estado stateRecord: description: Estado type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome initials: type: string maxLength: 255 description: Sigla active: type: boolean description: Ativo country: type: object allOf: – #/definitions/countryRecord description: País customFields: type: string format: byte description: Campos customizados idErp: type: string maxLength: 255 description: Id no sistema terceiro countryRecord: description: País type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados countryCode: type: integer format: int64 description: Código do País idErp: type: string maxLength: 255 description: Id no sistema terceiro departmentRecord: description: Departamento do contato type: object properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo usesOccurrence: type: boolean description: Usa Ocorrência customFields: type: string format: byte description: Campos Customizados relationshipTypeRecord: description: Tipo de relacionamento entre contas type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados userRecord: description: Usuário type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 255 description: Código de identificação no sistema terceiro name: type: string maxLength: 255 description: Nome lastName: type: string maxLength: 255 description: Sobrenome descriptionFunction: type: string maxLength: 255 description: Descrição Função photo: type: string maxLength: 255 description: Foto email: type: string maxLength: 255 description: Email active: type: boolean description: Ativo userGroupRecord: description: Grupo Usuário type: object properties: id: type: integer format: int64 description: Id user: type: object allOf: – #/definitions/userRecord description: Usuário group: type: object allOf: – #/definitions/groupRecord description: Grupo groupRecord: description: Grupo de usuários type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome description: type: string maxLength: 255 description: Descrição active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa users: type: array items: type: object allOf: – #/definitions/userGroupRecord description: Usuário idErp: type: integer format: int64 description: Id no Sistema Terceiro interestAreaRecord: description: Área de interesse type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa recordCharacteristic: description: Características type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa functionRecord: description: Objeto referente a Função type: object properties: id: type: integer format: int64 description: Código de identificação company: type: object allOf: – #/definitions/companyRecord description: Empresa name: type: string maxLength: 255 description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos Customizados idErp: type: string maxLength: 255 description: Id no sistema terceiro checkRecord: description: Checagens type: object required: – name – status properties: name: type: string maxLength: 255 description: Nome status: type: string allOf: – #/definitions/statusHealthcheckEnum description: Status notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string maxLength: 255 description: Class of notification notificationOrigin: type: string maxLength: 255 description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string maxLength: 255 description: Notification subject. notificationContent: type: string maxLength: 255 description: Notification content. sourceDomain: type: string maxLength: 255 description: Domain that generates the notification. sourceService: type: string maxLength: 255 description: Service that generates the notification. destinationUser: type: string maxLength: 255 description: Username of the destination user. link: type: string maxLength: 255 description: Notification link _discriminator: type: string maxLength: 255 description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string maxLength: 255 description: Email sender address sendTo: type: array items: type: string maxLength: 255 description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string maxLength: 255 description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string maxLength: 255 description: The domain the blob belongs to. serviceName: type: string maxLength: 255 description: The service the blob belongs to. targetObjectId: type: string maxLength: 255 description: The basic id of the blob. targetCopyId: type: string maxLength: 255 description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string maxLength: 255 description: The user-facing error message, if any. errorCode: type: string maxLength: 255 description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string maxLength: 255 description: Domain of the dependency service service: type: string maxLength: 255 description: Name of the dependency service type: string maxLength: 255 description: Version of the dependency service accountFacade: description: Entidade fachada da Conta type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Código de identificação name: type: string maxLength: 255 description: Nome da conta fantasyName: type: string maxLength: 255 description: Nome fantasia economicGroup: type: string maxLength: 255 description: Grupo Econômico stateRegistration: type: string maxLength: 255 description: Inscrição estadual municipalRegistration: type: string maxLength: 255 description: Inscrição municipal cnpj: type: string maxLength: 255 description: CNPJ da conta rg: type: string maxLength: 255 description: RG da conta cpf: type: string maxLength: 255 description: CPF da conta einNumber: type: string maxLength: 255 description: EIN ssnNumber: type: string maxLength: 255 description: SSN url: type: string maxLength: 255 description: URL do site da conta generalEmail: type: string maxLength: 255 description: E-mail geral financialEmail: type: string maxLength: 255 description: E-mail financeiro employees: type: integer format: int64 description: Funcionários annualIncome: type: number format: double description: Receita anual registerDate: type: string format: date-time description: Data do cadastro customerSince: type: string format: date-time description: Cliente desde birthDate: type: string format: date-time description: Data de nascimento/abertura 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 format: byte description: Campos customizados active: type: boolean description: Status de atividade personType: type: object allOf: – #/definitions/personTypeRecord description: Tipo de pessoa companySize: type: object allOf: – #/definitions/companySizeRecord description: Porte da empresa activityBranch: type: object allOf: – #/definitions/activityBranchRecord description: Ramo de atividade companyGroup: type: object allOf: – #/definitions/companyGroupRecord description: Grupo de empresa origin: type: object allOf: – #/definitions/originRecord description: Origem responsible: type: array items: type: object allOf: – #/definitions/accountResponsibleFacade description: Responsáveis definitions: type: array items: type: object allOf: – #/definitions/accountDefinitionFacade description: Definições nit: type: string maxLength: 255 description: NIT citizenshipCard: type: string maxLength: 255 description: Cédula Cidadania passport: type: string maxLength: 255 description: Passaporte addresses: type: array items: type: object allOf: – #/definitions/accountAddressFacade description: Endereços phones: type: array items: type: object allOf: – #/definitions/accountPhoneFacade description: Telefones historicIntegrations: type: array items: type: object allOf: – #/definitions/accountHistoryIntegrationFacade description: Histórico de Integrações contacts: type: array items: type: object allOf: – #/definitions/contactFacade description: Contatos identifiers: type: array items: type: object allOf: – #/definitions/accountIdentificationsFacade description: Identificadores characteristics: type: array items: type: object allOf: – #/definitions/accountCharacteristicsFacade description: Características accountDefinitionFacade: description: Entidade fachada da Definições da Conta type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 255 description: Id no sistema terceiro salesGoal: type: number format: double description: Meta prevista note: type: string maxLength: 255 description: Observações customFields: type: string format: byte description: Campos customizados receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email clientSince: type: string format: date-time description: Cliente desde rating: type: object allOf: – #/definitions/ratingRecord description: Rating carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora carrierDispatch: type: object allOf: – #/definitions/carrierDispatchRecord description: Redespacho account: type: object allOf: – #/definitions/accountFacade description: Conta accountType: type: object allOf: – #/definitions/accountTypeRecord description: Tipo de conta companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial status: type: object allOf: – #/definitions/statusRecord description: Status paymentTerm: type: object allOf: – #/definitions/paymentTermRecord description: Prazo de pagamento inactivationReason: type: object allOf: – #/definitions/inactivationReasonRecord description: Motivo da inativação priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço typePayment: type: object allOf: – #/definitions/typePaymentRecord description: Tipo de Pagamento representative: type: object allOf: – #/definitions/representativeRecord description: Representante seller: type: object allOf: – #/definitions/sellerRecord description: Vendedor accountAddressFacade: description: Entidade fachada do endereço da conta type: object properties: id: type: integer format: int64 description: Código de identificação main: type: boolean description: Principal account: type: object allOf: – #/definitions/accountFacade description: Conta address: type: object allOf: – #/definitions/addressRecord description: Endereço accountPhoneFacade: description: Entidade fachada da conta de telefone type: object properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM number: type: string maxLength: 255 description: Número type: type: integer format: int64 description: Tipo operator: type: integer format: int64 description: Operadora main: type: boolean description: Principal account: type: object allOf: – #/definitions/accountFacade description: Conta accountHistoryIntegrationFacade: description: Facade referente ao histórico de integração da conta type: object properties: id: type: integer format: int64 description: Id de identificação dateTime: type: string format: date-time description: Data e hora status: type: integer format: int64 description: Status onde 1: Não Integrado 2: Integrado: 3: Falha ao integrar minimum: 0 maximum: 2 content: type: string maxLength: 255 description: Conteúdo account: type: object allOf: – #/definitions/accountFacade description: Conta contactFacade: description: Entidade fachada referente ao contato type: object properties: id: type: integer format: int64 description: Código de identificação search: type: integer format: int64 description: Pesquisa privateUser: type: integer format: int64 description: Usuário privado sequentialErp: type: string maxLength: 255 description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer format: int64 description: Visibilidade name: type: string maxLength: 255 description: Nome treatment: type: string maxLength: 255 description: Tratamento functionDescription: type: string maxLength: 255 description: Função Descrição gender: type: integer format: int64 description: Gênero Sexual cep: type: string maxLength: 255 description: CEP zipCode: type: string maxLength: 255 description: ZIP Code address: type: string maxLength: 255 description: Endereço number: type: string maxLength: 255 description: Numero complement: type: string maxLength: 255 description: Complemento district: type: string maxLength: 255 description: Bairro cpf: type: string maxLength: 255 description: CPF rg: type: string maxLength: 255 description: RG citizenshipCard: type: string maxLength: 255 description: Cédula Cidadania telephone: type: string maxLength: 255 description: Telefone corporatePhone: type: boolean description: Telefone Corporativo phoneBranch: type: string maxLength: 255 description: Ramal fax: type: string maxLength: 255 description: FAX cell: type: string maxLength: 255 description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer format: int64 description: Operadora email: type: string maxLength: 255 description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveEmailMarketing: type: boolean description: Recebe E-mail Marketing receiveSearch: type: boolean description: Recebe pesquisa skype: type: string maxLength: 255 description: Skype twitter: type: string maxLength: 255 description: Twitter linkedin: type: string maxLength: 255 description: Linkedin instagram: type: string maxLength: 255 description: Instagram facebook: type: string maxLength: 255 description: Facebook birthday: type: string maxLength: 255 description: Aniversário birthDate: type: string format: date-time description: Data de Nascimento decisionLevel: type: integer format: int64 description: Nível de Decisão opinionCompany: type: integer format: int64 description: Parecer Empresa reasonOpinionCompany: type: string maxLength: 255 description: Motivo Parecer Empresa note: type: string maxLength: 255 description: Observações customFields: type: string format: byte description: Campos Customizados city: type: object allOf: – #/definitions/cityRecord description: Cidade department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função origin: type: object allOf: – #/definitions/originRecord description: Origem account: type: object allOf: – #/definitions/accountFacade description: Conta superiorContact: type: object allOf: – #/definitions/contactFacade description: Contato Superior companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial accountRelationshipsFacade: description: Entidade fachada referente ao relacionamento de contas type: object properties: id: type: integer format: int64 description: Código de identificação note: type: string maxLength: 255 description: Observações status: type: boolean description: Status fatherAccount: type: object allOf: – #/definitions/accountFacade description: Conta Pai childAccount: type: object allOf: – #/definitions/accountFacade description: Conta Filha relationshipType: type: object allOf: – #/definitions/relationshipTypeRecord description: Tipo do relacionamento accountResponsibleFacade: description: Entidade fachada referente ao responsável da conta type: object properties: id: type: integer format: int64 description: Código de identificação erpOrigin: type: boolean description: Origem ERP user: type: object allOf: – #/definitions/userRecord description: Usuário account: type: object allOf: – #/definitions/accountFacade description: Conta group: type: object allOf: – #/definitions/groupRecord description: Grupo de usuários accountInterestAreasFacade: description: Entidade fachada referente à área de interesse type: object properties: id: type: integer format: int64 description: Código de identificação interestType: type: integer format: int64 description: Tipo de interesse note: type: string maxLength: 255 description: Observações dateRegister: type: string format: date-time description: Data de Cadastro account: type: object allOf: – #/definitions/accountFacade description: Conta interestAreas: type: object allOf: – #/definitions/interestAreaRecord description: Área de interesse accountIdentificationsFacade: description: Entidade fachada referente aos identificadores da conta type: object properties: id: type: integer format: int64 description: Código de identificação code: type: integer format: int64 description: Outro possível código para a conta description: type: string maxLength: 255 description: Descrição do código account: type: object allOf: – #/definitions/accountFacade description: Conta accountCharacteristicsFacade: description: Entidade fachada referente às características da conta type: object properties: id: type: integer format: int64 description: Código de identificação dateRegister: type: string format: date-time description: Data de Cadastro quantity: type: number format: double description: Quantidade observations: type: string maxLength: 255 description: Observações account: type: object allOf: – #/definitions/recordBasicAccount description: Conta characteristic: type: object allOf: – #/definitions/recordCharacteristic description: Características da conta 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