crm

2.0info: 3.1.1 account 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/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportAccount: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportAccountDefinition: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportAccountPhone: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportAccountAddress: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportCrmAccount: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportCrmAccountDefinition: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportCrmAccountPhone: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/exportCrmAccountAddress: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /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/accountDatasetImport: post: description: Action responsável por receber os CNPJ e processar os dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id – token – empresaFilial properties: id: type: array items: type: string minimum: 1 description: Ids referentes aos CNPJ token: type: string description: Referente ao token de acesso empresaFilial: type: string description: Referente a empresa filial informada url: type: string description: Referente a URL da requisição responses: 200: description: Ok schema: type: object required: – mensagem properties: mensagem: type: string description: Referente ao sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/logMarketingIntelligenceBasic: post: description: Salvar logs basicos no banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/logMarketingIntelligenceAdvanced: post: description: Salvar logs avancados no banco de dados tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – auth – consultaTela – consultaMapa – export properties: auth: type: boolean description: Referente se o usuario esta autenticado ou nao consultaTela: type: boolean description: Referente se a consulta foi via tela consultaMapa: type: boolean description: Referente se a consulta foi via mapa export: type: boolean description: Referente se o usuario exportou dados para o CRM responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importAccount: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importAccountDefinition: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importAccountPhone: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importAccountAddress: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importCrmAccount: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importCrmAccountDefinition: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importCrmAccountPhone: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/actions/importCrmAccountAddress: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/events/importCompany: post: description: Evento para importação de empresas x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – cnpjs – empresaFilial – token properties: cnpjs: type: array items: type: string minimum: 1 description: CNPJs das empresas importadas empresaFilial: type: string description: Empresa token: type: string description: Token de autenticação url: type: string description: Referente a URL da requisição responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountCreated: post: description: Evento de conta criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – account properties: account: type: object allOf: – #/definitions/recAccountCreated description: Conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionCreated: post: description: Evento de definição de conta criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountDefinition properties: accountDefinition: type: object allOf: – #/definitions/recAccountDefinitionCreated description: Definição de conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneCreated: post: description: Evento de telefone criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountPhone properties: accountPhone: type: object allOf: – #/definitions/recAccountPhoneCreated description: Telefone da conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressCreated: post: description: Evento de endereço criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountAddress properties: accountAddress: type: object allOf: – #/definitions/recAccountAddressCreated description: Endereço da conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountUpdated: post: description: Evento de conta atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – account properties: account: type: object allOf: – #/definitions/recAccountUpdated description: Conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionUpdated: post: description: Evento de definição de conta atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountDefinition properties: accountDefinition: type: object allOf: – #/definitions/recAccountDefinitionCreated description: Definição de conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneUpdated: post: description: Evento de telefone atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountPhone properties: accountPhone: type: object allOf: – #/definitions/recAccountPhoneCreated description: Telefone de conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressUpdated: post: description: Evento de endereço atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – accountAddress properties: accountAddress: type: object allOf: – #/definitions/recAccountAddressCreated description: Endereço da conta responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importAccountDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportAccountDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importAccountPhoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportAccountPhoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importAccountAddressEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportAccountAddressEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importCrmAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportCrmAccountEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importCrmAccountDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportCrmAccountDefinitionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importCrmAccountPhoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportCrmAccountPhoneEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/importCrmAccountAddressEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/exportCrmAccountAddressEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/entities/account: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/account responses: 200: description: The created resource schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/account responses: 200: description: The created resource schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/account/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/account responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/account responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/account/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/account responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountDefinition: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountDefinition/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/accountDefinition/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountDefinition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountPhone: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountPhone/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/accountPhone/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountPhone responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountAddress: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountAddress/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/accountAddress/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountAddress responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccount: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccount responses: 200: description: The created resource schema: #/definitions/crmAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccount responses: 200: description: The created resource schema: #/definitions/crmAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/crmAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccount/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccount responses: 200: description: Ok schema: #/definitions/crmAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccount responses: 200: description: Ok schema: #/definitions/crmAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccount 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/crmAccount/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccount responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccountDefinition: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccountDefinition responses: 200: description: The created resource schema: #/definitions/crmAccountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccountDefinition responses: 200: description: The created resource schema: #/definitions/crmAccountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/crmAccountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccountDefinition/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountDefinition responses: 200: description: Ok schema: #/definitions/crmAccountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountDefinition responses: 200: description: Ok schema: #/definitions/crmAccountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/crmAccountDefinition/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccountDefinition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccountPhone: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccountPhone responses: 200: description: The created resource schema: #/definitions/crmAccountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccountPhone responses: 200: description: The created resource schema: #/definitions/crmAccountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/crmAccountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccountPhone/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountPhone responses: 200: description: Ok schema: #/definitions/crmAccountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountPhone responses: 200: description: Ok schema: #/definitions/crmAccountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/crmAccountPhone/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccountPhone responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccountAddress: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccountAddress responses: 200: description: The created resource schema: #/definitions/crmAccountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/crmAccountAddress responses: 200: description: The created resource schema: #/definitions/crmAccountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/crmAccountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/crmAccountAddress/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountAddress responses: 200: description: Ok schema: #/definitions/crmAccountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountAddress responses: 200: description: Ok schema: #/definitions/crmAccountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD 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/entities/crmAccountAddress/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccountAddress responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumPhoneType: description: Enum do tipo do telefone da conta type: string enum: – TelefoneFixo – Celular – Fax enumPhoneOperator: description: Enum da operadora do telefone da conta type: string enum: – Claro – Tim – Vivo – Oi userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR recAccountCreated: description: Record de conta criada type: object required: – name – personType – origin – accountDefinition properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 50 description: Código de identificação name: type: string maxLength: 80 description: Nome da conta fantasyName: type: string maxLength: 80 description: Nome fantasia cnpj: type: string maxLength: 14 description: CNPJ da conta cpf: type: string maxLength: 11 description: CPF da conta rg: type: string maxLength: 15 description: RG da conta activityBranch: type: object allOf: – #/definitions/recActivityBranch description: Ramo de atividade stateRegistration: type: string maxLength: 15 description: Inscrição estadual municipalRegistration: type: string maxLength: 15 description: Inscrição municipal companySize: type: object allOf: – #/definitions/recCompanySize description: Porte da empresa url: type: string maxLength: 80 description: URL do site da conta generalEmail: type: string maxLength: 80 description: E-mail geral financialEmail: type: string maxLength: 80 description: E-mail financeiro registerDate: type: string format: date description: Data do cadastro annualIncome: type: number format: double description: Receita anual maximum: 9999999999999999.99 employees: type: integer format: int64 description: Quantidade de funcionários personType: type: object allOf: – #/definitions/recPersonType description: Tipo de poessoa einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN companyGroup: type: object allOf: – #/definitions/recCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recOrigin description: Origem birthDate: type: string format: date description: Data de nascimento/abertura active: type: integer format: int64 description: Status de atividade minimum: 0 maximum: 1 customFields: type: string description: Campos customizados accountDefinition: type: object allOf: – #/definitions/recAccountDefinition description: Definição da conta accountRenponsible: type: object allOf: – #/definitions/recAccountResponsible description: Responsável da conta recActivityBranch: description: Ramo de atividade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recCompanySize: description: Porte da empresa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recPersonType: description: Tipo de pessoa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recCompanyGroup: description: Grupo de empresa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recOrigin: description: Origem da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recAccountDefinition: description: Definição da conta type: object required: – id – companyBranch – company – companyErp – branch – branchErp properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: integer format: int64 description: Empresa/filial da definição da conta company: type: integer format: int64 description: Código de identificação da empresa da empresa/filial viculada companyErp: type: integer format: int64 description: Código de identificação da empresa no sistema terceiro branch: type: integer format: int64 description: Código de identificação da filial da empresa/filial viculada branchErp: type: integer format: int64 description: Código de identificação da filial no sistema terceiro recAccountResponsible: description: Responsável da conta type: object required: – user – userErp properties: user: type: integer format: int64 description: Código de identificação no CRM userErp: type: integer format: int64 description: Código de identificação no sistema terceiro recAccountDefinitionCreated: description: Definição da conta type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial account: type: object allOf: – #/definitions/recAccount description: Conta da definição status: type: object allOf: – #/definitions/recStatus description: Status inactivationReason: type: object allOf: – #/definitions/recInactivationReason description: Motivo da inativação accountType: type: object allOf: – #/definitions/recAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recRating description: Rating da conta priceTable: type: object allOf: – #/definitions/recPriceTable description: Tabela de preço carrier: type: object allOf: – #/definitions/recCarrier description: Transportadora padrão carrierDispatch: type: object allOf: – #/definitions/recCarrierDispatch description: Transportadore de redespacho padrão representative: type: object allOf: – #/definitions/recRepresentative description: Representante padrão seller: type: object allOf: – #/definitions/recSeller description: Vendedor padrão paymentTerm: type: object allOf: – #/definitions/recPaymentTerm description: Prazo de pagamento padrão salesGoal: type: number format: double description: Previsão de meta de vendas para o cliente maximum: 9999999999.99 note: type: string description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string format: date description: Data de quando a conta virou cliente customFields: type: string description: Campos customizados recCompanyBranch: description: Empresa filial da definição da conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM companyErp: type: string maxLength: 50 description: Código de identificação da empresa no sistema terceiro branchErp: type: string maxLength: 50 description: Código de identificação da filial no sistema terceiro recAccount: 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: 50 description: Código de identificação no sistema terceiro recStatus: description: Status da definição da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recInactivationReason: description: Motivo da inativação da definição da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recAccountType: description: Tipo de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recRating: description: Rating da conta por definição type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recPriceTable: 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: 50 description: Código de identificação no sistema terceiro recCarrier: description: Transportadora 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: 50 description: Código de identificação no sistema terceiro recCarrierDispatch: description: Transportadore de redespacho 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: 50 description: Código de identificação no sistema terceiro recRepresentative: description: Representante 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: 50 description: Código de identificação no sistema terceiro recSeller: description: Vendedor 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: 50 description: Código de identificação no sistema terceiro recPaymentTerm: 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: 50 description: Código de identificação no sistema terceiro recAccountPhoneCreated: description: Telefone da conta type: object required: – account – phoneNumber – phoneType – mainPhone properties: id: type: integer format: int64 description: Código de dentificação account: type: object allOf: – #/definitions/recAccount description: Conta do telefone phoneNumber: type: string description: Número de telefone phoneType: type: integer format: int64 description: Tipo de telefone phoneOperator: type: integer format: int64 description: Operadora da conta mainPhone: type: boolean description: Telefone principal recAccountAddressCreated: description: Endereço da conta type: object required: – account – mainAddress – addressType – address – district – city – active properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recAccount description: Conta do endereço mainAddress: type: boolean description: Endereço principal addressType: type: object allOf: – #/definitions/recAddressType description: Tipo de endereço address: type: string maxLength: 80 description: Endereço number: type: integer format: int64 description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro city: type: object allOf: – #/definitions/recCity description: Cidade cepCode: type: string maxLength: 9 description: CEP zipCode: type: string maxLength: 16 description: ZIP code latitude: type: number format: double description: Latitude maximum: 9999999999.999999 longitude: type: number format: double description: Longitude maximum: 9999999999.999999 active: type: integer format: int64 description: Status de atividade minimum: 0 maximum: 1 customFields: type: string description: Campos customizados recAddressType: description: Tipo de endereço type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recCity: description: Cidade type: object properties: id: type: integer format: int64 description: Código de identificação ibgeCode: type: string maxLength: 7 description: Código da cidade no IBGE name: type: string maxLength: 50 description: Nome da cidade uf: type: string maxLength: 2 description: UF da cidade recAccountUpdated: description: Record de conta atualizada type: object required: – name – origin properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 80 description: Nome da conta fantasyName: type: string maxLength: 80 description: Nome fantasia cnpj: type: string maxLength: 14 description: CNPJ da conta cpf: type: string maxLength: 11 description: CPF da conta rg: type: string maxLength: 15 description: RG da conta activityBranch: type: object allOf: – #/definitions/recActivityBranch description: Ramo de atividade stateRegistration: type: string maxLength: 15 description: Inscrição estadual municipalRegistration: type: string maxLength: 15 description: Inscrição municipal companySize: type: object allOf: – #/definitions/recCompanySize description: Porte da empresa url: type: string maxLength: 80 description: URL do site da conta generalEmail: type: string maxLength: 80 description: E-mail geral financialEmail: type: string maxLength: 80 description: E-mail financeiro registerDate: type: string format: date description: Data do registro annualIncome: type: number format: double description: Receita anual maximum: 9999999999999999.99 employees: type: integer format: int64 description: Quantidade de funcionários personType: type: object allOf: – #/definitions/recPersonType description: Tipo de pessoa einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN companyGroup: type: object allOf: – #/definitions/recCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recOrigin description: Origem birthDate: type: string format: date description: Data de nascimento/abertura active: type: integer format: int64 description: Status de atividade minimum: 0 maximum: 1 customFields: type: string description: Campos customizados account: description: Entidade fachada da Conta type: object required: – name – personType – origin properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 50 description: Código de identificação name: type: string maxLength: 80 description: Nome da conta fantasyName: type: string maxLength: 80 description: Nome fantasia cnpj: type: string maxLength: 14 description: CNPJ da conta cpf: type: string maxLength: 11 description: CPF da conta rg: type: string maxLength: 15 description: RG da conta activityBranch: type: object allOf: – #/definitions/recActivityBranch description: Ramo de atividade stateRegistration: type: string maxLength: 15 description: Inscrição estadual municipalRegistration: type: string maxLength: 15 description: Inscrição municipal companySize: type: object allOf: – #/definitions/recCompanySize description: Porte da empresa url: type: string maxLength: 80 description: URL do site da conta generalEmail: type: string maxLength: 80 description: E-mail geral financialEmail: type: string maxLength: 80 description: E-mail financeiro registerDate: type: string format: date description: Data do cadastro annualIncome: type: number format: double description: Receita anual maximum: 9999999999999999.99 employees: type: integer format: int64 description: Quantidade de funcionários personType: type: object allOf: – #/definitions/recPersonType description: Tipo de pessoa einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN companyGroup: type: object allOf: – #/definitions/recCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recOrigin description: Origem birthDate: type: string format: date description: Data de nascimento/abertura active: type: integer format: int64 description: Status de atividade minimum: 0 maximum: 1 customFields: type: string description: Campos customizados accountDefinition: description: Entidade fachada da Definições da Conta type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa Filial da definição da conta account: type: object allOf: – #/definitions/recAccount description: A conta da definição status: type: object allOf: – #/definitions/recStatus description: Status da definição da conta, inactivationReason: type: object allOf: – #/definitions/recInactivationReason description: Motivo da inativação da definição da conta accountType: type: object allOf: – #/definitions/recAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recRating description: Rating da conta por definição priceTable: type: object allOf: – #/definitions/recPriceTable description: Tabela de preço padrão para a definição de conta carrier: type: object allOf: – #/definitions/recCarrier description: Transportadora padrão para a definição de conta carrierDispatch: type: object allOf: – #/definitions/recCarrierDispatch description: Transportadora de redespacho padrão para a definição de conta representative: type: object allOf: – #/definitions/recRepresentative description: Representante padrão para a definição de conta seller: type: object allOf: – #/definitions/recSeller description: Vendedor padrão para a definição de conta paymentTerm: type: object allOf: – #/definitions/recPaymentTerm description: Prazo de pagamento padrão para a definição de conta salesGoal: type: number format: double description: Previsão de meta de vendas para o cliente maximum: 9999999999.99 note: type: string description: Observações da definição de conta receiveEmail: type: boolean description: Informa se a conta por definição recebe emails do sistema receiveSurvey: type: boolean description: Informa se a conta por definição recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Informa se a conta por definição recebe e monitora emails do sistema clientSince: type: string format: date description: Data de quando a conta virou cliente customFields: type: string description: Campos customizados desse cadastro accountPhone: description: Entidade fachada da conta de telefone type: object required: – account – phoneNumber – phoneType – mainPhone properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM account: type: object allOf: – #/definitions/recAccount description: A conta da definição phoneNumber: type: string description: Número de telefone da conta phoneType: type: string allOf: – #/definitions/enumPhoneType description: Tipo de telefone da conta phoneOperator: type: string allOf: – #/definitions/enumPhoneOperator description: Operadora de telefone da conta mainPhone: type: boolean description: É o principal telefone da conta accountAddress: description: Entidade fachada do endereço da conta type: object required: – account – mainAddress – addressType – address – district – city – latitude – longitude – active properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recAccount description: Conta do endereço mainAddress: type: boolean description: É o endereço principal da conta addressType: type: object allOf: – #/definitions/recAddressType description: Tipo de endereço address: type: string maxLength: 80 description: Endereço number: type: integer format: int64 description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro city: type: object allOf: – #/definitions/recCity description: Cidade cepCode: type: string maxLength: 9 description: CEP zipCode: type: string maxLength: 16 description: ZIP latitude: type: number format: double description: Latitude maximum: 9999999999.999999 longitude: type: number format: double description: Longitude maximum: 9999999999.999999 active: type: integer format: int64 description: Status do endereço minimum: 0 maximum: 1 customFields: type: string description: Campos customizados crmAccount: description: Entidade fachada de criação e atualização de conta type: object required: – name – personType – origin properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 50 description: Código de identificação name: type: string maxLength: 80 description: Nome da conta fantasyName: type: string maxLength: 80 description: Nome fantasia cnpj: type: string maxLength: 14 description: CNPJ da conta cpf: type: string maxLength: 11 description: CPF da conta rg: type: string maxLength: 15 description: RG da conta activityBranch: type: object allOf: – #/definitions/recActivityBranch description: Ramo de atividade stateRegistration: type: string maxLength: 15 description: Inscrição estadual municipalRegistration: type: string maxLength: 15 description: Inscrição municipal companySize: type: object allOf: – #/definitions/recCompanySize description: Porte da empresa url: type: string maxLength: 80 description: URL do site da conta generalEmail: type: string maxLength: 80 description: E-mail geral financialEmail: type: string maxLength: 80 description: E-mail financeiro registerDate: type: string format: date description: Data do cadastro annualIncome: type: number format: double description: Receita anual maximum: 9999999999999999.99 employees: type: integer format: int64 description: Quantidade de funcionários personType: type: object allOf: – #/definitions/recPersonType description: Tipo de poessoa einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN companyGroup: type: object allOf: – #/definitions/recCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recOrigin description: Origem birthDate: type: string format: date description: Data de nascimento/abertura active: type: integer format: int64 description: Status de atividade minimum: 0 maximum: 1 customFields: type: string description: Campos customizados accountDefinition: type: object allOf: – #/definitions/recAccountDefinition description: Definição da conta accountRenponsible: type: object allOf: – #/definitions/recAccountResponsible description: Responsável da conta crmAccountDefinition: description: Entidade fachada de criação e atualização de definição de conta type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/recCompanyBranch description: Empresa/filial account: type: object allOf: – #/definitions/recAccount description: Conta da definição status: type: object allOf: – #/definitions/recStatus description: Status inactivationReason: type: object allOf: – #/definitions/recInactivationReason description: Motivo da inativação accountType: type: object allOf: – #/definitions/recAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recRating description: Rating da conta priceTable: type: object allOf: – #/definitions/recPriceTable description: Tabela de preço carrier: type: object allOf: – #/definitions/recCarrier description: Transportadora padrão carrierDispatch: type: object allOf: – #/definitions/recCarrierDispatch description: Transportadore de redespacho padrão representative: type: object allOf: – #/definitions/recRepresentative description: Representante padrão seller: type: object allOf: – #/definitions/recSeller description: Vendedor padrão paymentTerm: type: object allOf: – #/definitions/recPaymentTerm description: Prazo de pagamento padrão salesGoal: type: number format: double description: Previsão de meta de vendas para o cliente maximum: 9999999999.99 note: type: string description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string format: date description: Data de quando a conta virou cliente customFields: type: string description: Campos customizados crmAccountPhone: description: Entidadeb fachada de criação e atualização de telefone da conta type: object required: – account – phoneNumber – phoneType – mainPhone properties: id: type: integer format: int64 description: Código de dentificação account: type: object allOf: – #/definitions/recAccount description: Conta do telefone phoneNumber: type: string description: Número de telefone phoneType: type: integer format: int64 description: Tipo de telefone phoneOperator: type: integer format: int64 description: Operadora da conta mainPhone: type: boolean description: Telefone principal crmAccountAddress: description: Entidade fachada de criação e atualização de endereço da conta type: object required: – account – mainAddress – addressType – address – district – city – active properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recAccount description: Conta do endereço mainAddress: type: boolean description: Endereço principal addressType: type: object allOf: – #/definitions/recAddressType description: Tipo de endereço address: type: string maxLength: 80 description: Endereço number: type: integer format: int64 description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro city: type: object allOf: – #/definitions/recCity description: Cidade cepCode: type: string maxLength: 9 description: CEP zipCode: type: string maxLength: 16 description: ZIP code latitude: type: number format: double description: Latitude maximum: 9999999999.999999 longitude: type: number format: double description: Longitude maximum: 9999999999.999999 active: type: integer format: int64 description: Status de atividade minimum: 0 maximum: 1 customFields: type: string description: Campos customizados notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE