Contas (account)

2.0info: 8.1.1 Contas description: Serviço responsável pelo contas do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: account contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: 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/getHistoryIntegrationByAccount: post: description: Query que retorna o histórico de integração de uma conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – account properties: account: type: string description: responses: 200: description: Ok schema: type: object required: – historyIntegrations properties: historyIntegrations: type: array items: type: object allOf: – #/definitions/recordFullAccountHistoryIntegration minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query que retorna o histórico de integração de uma conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: account description: in: query required: true type: string responses: 200: description: Ok schema: type: object required: – historyIntegrations properties: historyIntegrations: type: array items: type: object allOf: – #/definitions/recordFullAccountHistoryIntegration minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/getAddressByAccount: post: description: Query que retorna os endereços da conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – account properties: account: type: integer format: int64 description: Id da Conta main: type: boolean description: Indicidor se é o endereço principal responses: 200: description: Ok schema: type: object required: – addresses properties: addresses: type: array items: type: object allOf: – #/definitions/recordFullAccountAddress minimum: 1 description: Endereços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query que retorna os endereços da conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: account description: Id da Conta in: query required: true type: integer format: int64 – name: main description: Indicidor se é o endereço principal in: query type: boolean responses: 200: description: Ok schema: type: object required: – addresses properties: addresses: type: array items: type: object allOf: – #/definitions/recordFullAccountAddress minimum: 1 description: Endereços 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/getDefinitionByAccount: post: description: Query que retorna as definições da conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – account properties: account: type: integer format: int64 description: Id da Conta responses: 200: description: Ok schema: type: object required: – definitions properties: definitions: type: array items: type: object allOf: – #/definitions/recordFullAccountDefinition minimum: 1 description: Definições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query que retorna as definições da conta tags: – Queries x-senior-visibility: PUBLIC parameters: – name: account description: Id da Conta in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – definitions properties: definitions: type: array items: type: object allOf: – #/definitions/recordFullAccountDefinition minimum: 1 description: Definições 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/getPhoneByAccount: post: description: Retona os telefones da conta através do id de uma conta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – account properties: account: type: integer format: int64 description: Id da Conta main: type: boolean description: Referente se o telefone é o principal responses: 200: description: Ok schema: type: object required: – telephones properties: telephones: type: array items: type: object allOf: – #/definitions/recordFullAccountPhone minimum: 1 description: Telefone da conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retona os telefones da conta através do id de uma conta tags: – Queries x-senior-visibility: PRIVATE parameters: – name: account description: Id da Conta in: query required: true type: integer format: int64 – name: main description: Referente se o telefone é o principal in: query type: boolean responses: 200: description: Ok schema: type: object required: – telephones properties: telephones: type: array items: type: object allOf: – #/definitions/recordFullAccountPhone minimum: 1 description: Telefone da conta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/healthcheck: post: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkDataDTO minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkDataDTO minimum: 1 description: Verificações para assegurar o status 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 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/exportAccountHistoryIntegration: 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/exportContact: 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/exportAccountRelationships: 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/exportAccountResponsible: 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/exportAccountInterestAreas: 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/exportAccountIdentifications: 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/exportAccountCharacteristics: 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/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: – event – content properties: event: type: string allOf: – #/definitions/enumEventsAccount description: Evento a ser disparado content: type: string description: Conteudo em forma de json desse evento responses: 200: description: Ok schema: type: object required: – status properties: status: type: boolean description: Referente ao status do envio 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/importAccountHistoryIntegration: 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/importContact: 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/importAccountRelationships: 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/importAccountResponsible: 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/importAccountInterestAreas: 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/importAccountIdentifications: 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/importAccountCharacteristics: 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/accountCreated: post: description: Evento de conta criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/recordFullAccount 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 allOf: – #/definitions/recordFullAccountDefinition 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 allOf: – #/definitions/recordFullAccountPhone 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 allOf: – #/definitions/recordFullAccountAddress 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 allOf: – #/definitions/recordFullAccount 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 allOf: – #/definitions/recordFullAccountDefinition 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 allOf: – #/definitions/recordFullAccountPhone 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 allOf: – #/definitions/recordFullAccountAddress 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/importAccountHistoryIntegrationEvent: 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/exportAccountHistoryIntegrationEvent: 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/importContactEvent: 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/exportContactEvent: 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/importAccountRelationshipsEvent: 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/exportAccountRelationshipsEvent: 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/importAccountResponsibleEvent: 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/exportAccountResponsibleEvent: 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/importAccountInterestAreasEvent: 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/exportAccountInterestAreasEvent: 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/importAccountIdentificationsEvent: 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/exportAccountIdentificationsEvent: 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/importAccountCharacteristicsEvent: 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/exportAccountCharacteristicsEvent: 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/accountHistoryIntegration: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountHistoryIntegration responses: 200: description: The created resource schema: #/definitions/accountHistoryIntegration 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/accountHistoryIntegration responses: 200: description: The created resource schema: #/definitions/accountHistoryIntegration 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/accountHistoryIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountHistoryIntegration/{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/accountHistoryIntegration responses: 200: description: Ok schema: #/definitions/accountHistoryIntegration 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/accountHistoryIntegration responses: 200: description: Ok schema: #/definitions/accountHistoryIntegration 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/accountHistoryIntegration 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/accountHistoryIntegration/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountHistoryIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/contact: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact 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/contact responses: 200: description: The created resource schema: #/definitions/contact 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/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/contact/{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/contact responses: 200: description: Ok schema: #/definitions/contact 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/contact responses: 200: description: Ok schema: #/definitions/contact 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/contact 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/contact/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountRelationships: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountRelationships responses: 200: description: The created resource schema: #/definitions/accountRelationships 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/accountRelationships responses: 200: description: The created resource schema: #/definitions/accountRelationships 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/accountRelationships 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountRelationships/{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/accountRelationships responses: 200: description: Ok schema: #/definitions/accountRelationships 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/accountRelationships responses: 200: description: Ok schema: #/definitions/accountRelationships 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/accountRelationships 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/accountRelationships/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountRelationships responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountResponsible: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountResponsible responses: 200: description: The created resource schema: #/definitions/accountResponsible 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/accountResponsible responses: 200: description: The created resource schema: #/definitions/accountResponsible 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/accountResponsible 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountResponsible/{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/accountResponsible responses: 200: description: Ok schema: #/definitions/accountResponsible 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/accountResponsible responses: 200: description: Ok schema: #/definitions/accountResponsible 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/accountResponsible 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/accountResponsible/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountResponsible responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountInterestAreas: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountInterestAreas responses: 200: description: The created resource schema: #/definitions/accountInterestAreas 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/accountInterestAreas responses: 200: description: The created resource schema: #/definitions/accountInterestAreas 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/accountInterestAreas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountInterestAreas/{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/accountInterestAreas responses: 200: description: Ok schema: #/definitions/accountInterestAreas 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/accountInterestAreas responses: 200: description: Ok schema: #/definitions/accountInterestAreas 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/accountInterestAreas 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/accountInterestAreas/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountInterestAreas responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountIdentifications: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountIdentifications responses: 200: description: The created resource schema: #/definitions/accountIdentifications 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/accountIdentifications responses: 200: description: The created resource schema: #/definitions/accountIdentifications 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/accountIdentifications 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountIdentifications/{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/accountIdentifications responses: 200: description: Ok schema: #/definitions/accountIdentifications 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/accountIdentifications responses: 200: description: Ok schema: #/definitions/accountIdentifications 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/accountIdentifications 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/accountIdentifications/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountIdentifications responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountCharacteristics: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountCharacteristics responses: 200: description: The created resource schema: #/definitions/accountCharacteristics 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/accountCharacteristics responses: 200: description: The created resource schema: #/definitions/accountCharacteristics 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/accountCharacteristics 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/entities/accountCharacteristics/{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/accountCharacteristics responses: 200: description: Ok schema: #/definitions/accountCharacteristics 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/accountCharacteristics responses: 200: description: Ok schema: #/definitions/accountCharacteristics 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/accountCharacteristics 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/accountCharacteristics/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountCharacteristics responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumEventsAccount: description: Enum com os nomes de todos os eventos do account type: string enum: – ACCOUNT_CREATED – ACCOUNT_UPDATED – ACCOUNT_DEFINITION_CREATED – ACCOUNT_DEFINITION_UPDATED – ACCOUNT_PHONE_CREATED – ACCOUNT_PHONE_UPDATED – ACCOUNT_ADDRESS_CREATED – ACCOUNT_ADDRESS_UPDATED enumPhoneType: description: Enum do tipo do telefone da conta type: string enum: – LANDLINE – CELL – FAX enumGender: description: Gênero type: string enum: – UNINFORMED – MASCULINE – FEMININE enumVisibility: description: Visibilidade type: string enum: – PUBLIC – PRIVATE enumDecisionLevel: description: Nível de decisão type: string enum: – NONE – USER – FINANCIAL_DECISION_MAKER – TECHNICAL_DECISION_MAKER – RECOMMENDS enumFavorableCompany: description: Informativo se o contato dentro do cliente é favorável a empresa type: string enum: – YES – INDIFFERENT – NO enumOperator: description: Operadora type: string enum: – CLARO – TIM – VIVO – OI enumInterestType: description: Tipo de interesse type: string enum: – HAS_INTEREST – ALREADY_HAVE – HAS_POTENTIAL – NO_INTEREST upDown: description: Up or 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 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 recordFullAccountHistoryIntegration: description: Record referente a facade accountHistoryIntegration type: object required: – status – content – account 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 0: Não Integrado; 1: Integrado: 2: Falha ao integrar minimum: 0 maximum: 2 content: type: string description: Conteudo account: type: integer format: int64 description: Id da conta referente a esse histórico recordFullAccount: description: Record de conta criada type: object required: – id – name – registerDate – active – 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 stateRegistration: type: string maxLength: 15 description: Inscrição estadual municipalRegistration: type: string maxLength: 15 description: Inscrição municipal 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 einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN birthDate: type: string format: date description: Data de nascimento/abertura active: type: boolean description: Status de atividade customFields: type: string description: Campos customizados activityBranch: type: object allOf: – #/definitions/recordActivityBranch description: Ramo de atividade companySize: type: object allOf: – #/definitions/recordCompanySize description: Porte da empresa personType: type: object allOf: – #/definitions/recordPersonType description: Tipo de poessoa companyGroup: type: object allOf: – #/definitions/recordCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recordOrigin description: Origem accountDefinition: type: object allOf: – #/definitions/recordBasicAccountDefinition description: Definição da conta accountResponsible: type: object allOf: – #/definitions/recordAccountResponsible description: Responsável da conta recordActivityBranch: description: Ramo de atividade type: object required: – id 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 description: Nome da Empresa/Filial recordCompanySize: description: Porte da empresa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do porte da empresa recordPersonType: description: Tipo de pessoa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do tipo de Pessoa recordCompanyGroup: description: Grupo de empresa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome grupo da empresa recordOrigin: description: Origem da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome da origem recordBasicAccountDefinition: description: Definição da conta discriminator: _discriminator type: object required: – accountType – rating – status – _discriminator properties: id: type: integer format: int64 description: Código de identificação salesGoal: type: number format: double description: Previsão de meta de vendas para o cliente maximum: 9999999999.99 note: type: string maxLength: 80 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 companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial accountType: type: object allOf: – #/definitions/recordAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recordRating description: Rating da conta status: type: object allOf: – #/definitions/recordStatus description: Status inactivationReason: type: object allOf: – #/definitions/recordInactivationReason description: Motivo da inativação priceTable: type: object allOf: – #/definitions/recordPriceTable description: Tabela de preço carrier: type: object allOf: – #/definitions/recordCarrier description: Transportadora padrão carrierDispatch: type: object allOf: – #/definitions/recordCarrierDispatch description: Transportadore de redespacho padrão representative: type: object allOf: – #/definitions/recordRepresentative description: Representante padrão seller: type: object allOf: – #/definitions/recordSeller description: Vendedor padrão paymentTerm: type: object allOf: – #/definitions/recordPaymentTerm description: Prazo de pagamento padrão _discriminator: type: string description: recordAccountResponsible: description: Responsável da conta type: object required: – id 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 recordCompanyBranch: description: Empresa filial da definição da conta type: object required: – company – branch properties: id: type: integer format: int64 description: Código de identificação no CRM company: type: object allOf: – #/definitions/recordCompany description: Objeto da Empresa branch: type: object allOf: – #/definitions/recordBranch description: Objeto da filial da Empresa recordCompany: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro name: type: string maxLength: 80 description: Nome da Empresa fantasyName: type: string maxLength: 80 description: Nome fantasia da Empresa recordBranch: description: Objeto referente a filial da Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro name: type: string maxLength: 80 description: Nome da Empresa fantasyName: type: string maxLength: 80 description: Nome fantasia da Empresa 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: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome da conta 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 recordStatus: description: Status da definição da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do status recordInactivationReason: 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 name: type: string description: Motivo da inativação recordAccountType: description: Tipo de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do tipo da Conta recordRating: description: Rating da conta por definição type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do Rating da conta recordPriceTable: description: Tabela de preço padrão para a definição de conta type: object required: – id 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 description: Nome da tabela de preços recordCarrier: description: Transportadora padrão para a definição de conta type: object required: – id 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 description: Nome da operadora recordCarrierDispatch: description: Transportadore de redespacho padrão para a definição de conta type: object required: – id 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 description: Nome da operadora de dispacho recordRepresentative: description: Representante padrão para a definição de conta type: object required: – id 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 description: Nome do representante recordSeller: description: Vendedor padrão para a definição de conta type: object required: – id 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 description: Nome do vendedor recordPaymentTerm: description: Prazo de pagamento padrão para a definição de conta type: object required: – id 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 description: Nome do termo de pagamento recordFullAccountPhone: description: Telefone da conta type: object required: – id – account – number – type – main properties: id: type: integer format: int64 description: Código de dentificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do telefone number: type: string description: Número de telefone type: type: integer format: int64 description: Tipo de telefone operator: type: integer format: int64 description: Operadora da conta main: type: boolean description: Telefone principal recordFullAccountAddress: description: Endereço da conta type: object required: – id – account – type – main – address – active – district – cepCode – city properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do endereço type: type: object allOf: – #/definitions/recordAddressType description: Tipo de endereço main: type: boolean description: Endereço principal address: type: string maxLength: 80 description: Endereço active: type: boolean description: Status de atividade number: type: string description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro cepCode: type: string maxLength: 9 description: CEP latitude: type: string description: Latitude longitude: type: string description: Longitude city: type: object allOf: – #/definitions/recordCity description: Cidade zipCode: type: string maxLength: 16 description: ZIP code customFields: type: string description: Campos customizados recordFullAccountDefinition: description: Definição da conta allOf: – #/definitions/recordBasicAccountDefinition – type: object required: – account properties: account: type: object allOf: – #/definitions/recordBasicAccount description: Conta recordAddressType: description: Tipo de endereço type: object required: – id – name properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome recordCity: description: Cidade type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id do ERP no CRM ibgeCode: type: string maxLength: 7 description: Código da cidade no IBGE name: type: string maxLength: 50 description: Nome da cidade state: type: object allOf: – #/definitions/recordState description: Estado recordState: description: Estado type: object required: – id properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id do ERP no CRM name: type: string maxLength: 50 description: Nome initials: type: string description: Inicial country: type: object allOf: – #/definitions/recordCountry description: País recordCountry: description: País type: object required: – id properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id do ERP no CRM name: type: string description: Nome recordOriginContact: description: Origem do contato type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recordDepartment: description: Departamento do contato type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recordRole: description: Função do contato no cliente type: object required: – id properties: id: type: integer format: int64 description: Código de identificação recordSuperiorContact: description: Superior do contato em questão no cliente 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 recordRelationshipType: description: Tipo de relacionamento entre contas type: object properties: id: type: integer format: int64 description: Código de identificação recordUser: description: Usuário 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 recordGroup: description: Grupo de usuários type: object properties: id: type: integer format: int64 description: Código de identificação recordInterestArea: description: Área de interesse type: object properties: id: type: integer format: int64 description: Código de identificação recordCharacteristic: description: Características type: object properties: id: type: integer format: int64 description: Código de identificação recordAccountPhone: description: Telefone da conta type: object required: – number – type – main properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM number: type: string description: Número de telefone da conta type: type: string allOf: – #/definitions/enumPhoneType description: Tipo de telefone da conta operator: type: string allOf: – #/definitions/enumOperator description: Operadora de telefone da conta main: type: boolean description: É o principal telefone da conta account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do telefone recordAccountAddress: description: Endereço da conta type: object required: – main – type – address – district – city – latitude – longitude – active properties: id: type: integer format: int64 description: Código de identificação main: type: boolean description: É o endereço principal da conta type: type: object allOf: – #/definitions/recordAddressType description: Tipo de endereço address: type: string maxLength: 80 description: Endereço number: type: string description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro city: type: object allOf: – #/definitions/recordCity 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 account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do endereco checkDataDTO: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck 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 nit: type: string description: NIT citizenshipCard: type: string description: Identificação de cidadania passport: type: string description: Passaporte activityBranch: type: object allOf: – #/definitions/recordActivityBranch 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/recordCompanySize 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/recordPersonType description: Tipo de pessoa einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN companyGroup: type: object allOf: – #/definitions/recordCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recordOrigin 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 default: 1 customFields: type: string description: Campos customizados accountPhone: type: object allOf: – #/definitions/recordAccountPhone description: Telefone da conta accountAddress: type: object allOf: – #/definitions/recordAccountAddress description: Endereço da conta 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/recordCompanyBranch description: Empresa Filial da definição da conta account: type: object allOf: – #/definitions/recordBasicAccount description: A conta da definição status: type: object allOf: – #/definitions/recordStatus description: Status da definição da conta, inactivationReason: type: object allOf: – #/definitions/recordInactivationReason description: Motivo da inativação da definição da conta accountType: type: object allOf: – #/definitions/recordAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recordRating description: Rating da conta por definição priceTable: type: object allOf: – #/definitions/recordPriceTable description: Tabela de preço padrão para a definição de conta carrier: type: object allOf: – #/definitions/recordCarrier description: Transportadora padrão para a definição de conta carrierDispatch: type: object allOf: – #/definitions/recordCarrierDispatch description: Transportadora de redespacho padrão para a definição de conta representative: type: object allOf: – #/definitions/recordRepresentative description: Representante padrão para a definição de conta seller: type: object allOf: – #/definitions/recordSeller description: Vendedor padrão para a definição de conta paymentTerm: type: object allOf: – #/definitions/recordPaymentTerm 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 – number – type – main properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM account: type: object allOf: – #/definitions/recordBasicAccount description: A conta da definição number: type: string description: Número de telefone da conta type: type: string allOf: – #/definitions/enumPhoneType description: Tipo de telefone da conta operator: type: string allOf: – #/definitions/enumOperator description: Operadora de telefone da conta main: type: boolean description: É o principal telefone da conta accountAddress: description: Entidade fachada do endereço da conta type: object required: – account – main – type – address – district – city – latitude – longitude – active properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do endereço main: type: boolean description: É o endereço principal da conta type: type: object allOf: – #/definitions/recordAddressType description: Tipo de endereço address: type: string maxLength: 80 description: Endereço number: type: string description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro city: type: object allOf: – #/definitions/recordCity 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 accountHistoryIntegration: description: Facade referente ao histórico de integração da conta type: object required: – status – content – account 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 description: Conteudo account: type: integer format: int64 description: Id da conta referente a esse histórico contact: description: Entidade fachada referente ao contato type: object required: – visibility – companyBranch – name – treatment – active properties: id: type: integer format: int64 description: Código de identificação gender: type: string allOf: – #/definitions/enumGender description: Gênero do contato visibility: type: string allOf: – #/definitions/enumVisibility description: Visibilidade do contato no sistema decisionLevel: type: string allOf: – #/definitions/enumDecisionLevel description: Nível de decisão do contato dentro do cliente favorableCompany: type: string allOf: – #/definitions/enumFavorableCompany description: Informativo se o contato dentro do cliente é favorável a empresa isCorporatePhone: type: boolean description: Indicador se o telefone do contato é corporativo isCorporateMobile: type: boolean description: Indicador se o celular do contato é corporativo isWhatsapp: type: boolean description: Indicador se o celular do contato tem Whatsapp isCorporateEmail: type: boolean description: Indicador se o email do contato é corporativo receiveCampaign: type: boolean description: Indicador se o contato recebe campanhas receiveSurvey: type: boolean description: Indicador se o contato recebe pesquisas companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial contato originContact: type: object allOf: – #/definitions/recordOriginContact description: Origem do contato department: type: object allOf: – #/definitions/recordDepartment description: Departamento do contato role: type: object allOf: – #/definitions/recordRole description: Função do contato no cliente superiorContact: type: object allOf: – #/definitions/recordSuperiorContact description: Superior do contato em questão no cliente account: type: object allOf: – #/definitions/recordBasicAccount description: Conta (cliente) que o contato possuí vinculo city: type: object allOf: – #/definitions/recordCity description: Cidade do contato operator: type: string allOf: – #/definitions/enumOperator description: Telefone do contato name: type: string maxLength: 50 description: Nome do contato treatment: type: string maxLength: 25 description: Nome de tratamento do contato email: type: string maxLength: 50 description: Email do contato phone: type: string maxLength: 25 description: Telefone do contato phoneBranch: type: string maxLength: 15 description: Ramal de telefone do contato birthDate: type: string format: date description: Data de nascimento do contato cpf: type: string maxLength: 15 description: CPF do contato rg: type: string maxLength: 15 description: RG do contato reasonFavorableCompany: type: string maxLength: 50 description: Motivo do parecer favorável do cliente para com a empresa zipCode: type: string maxLength: 16 description: Zip code do contato, quando endereço exterior cep: type: string maxLength: 9 description: CEP do endereço do contato address: type: string maxLength: 80 description: Endereço do contato complement: type: string maxLength: 50 description: Complemento do endereço do contato district: type: string maxLength: 50 description: Bairro do contato number: type: string maxLength: 10 description: Número do endereço do contato mobile: type: string maxLength: 25 description: Número de celular do contato facebook: type: string maxLength: 50 description: Endereço do Facebook do contato twitter: type: string maxLength: 50 description: Endereço do Twitter do contato skype: type: string maxLength: 50 description: Skype do contato note: type: string description: Observações internas do contato active: type: boolean description: Indicador se o registro do contato está ativo no sistema accountRelationships: description: Entidade fachada referente ao relacionamento de contas type: object required: – relationshipType – childAccount – fatherAccount – status properties: id: type: integer format: int64 description: Código de identificação relationshipType: type: object allOf: – #/definitions/recordRelationshipType description: Tipo do relacionamento entre as contas childAccount: type: object allOf: – #/definitions/recordBasicAccount description: Conta filha fatherAccount: type: object allOf: – #/definitions/recordBasicAccount description: Conta pai status: type: boolean description: Indicador se o registro de vínculo entre contas está ativo no sistema startDate: type: string format: date description: Data inicial da relação entre as contas startHour: type: string description: Hora inicial da relação entre as contas endDate: type: string format: date description: Data final da relação entre as contas endHour: type: string description: Hora final da relação entre as contas note: type: string description: Observações accountResponsible: description: Entidade fachada referente ao responsável da conta type: object required: – account properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta responsible: type: object allOf: – #/definitions/recordUser description: Responsável group: type: array items: type: object allOf: – #/definitions/recordGroup description: Grupo de usuários accountInterestAreas: description: Entidade fachada referente à área de interesse type: object required: – interestAreas – account – interestType properties: id: type: integer format: int64 description: Código de identificação interestAreas: type: object allOf: – #/definitions/recordInterestArea description: Área de interesse account: type: object allOf: – #/definitions/recordBasicAccount description: Conta que será vinculada à área de interesse interestType: type: string allOf: – #/definitions/enumInterestType description: Tipo de interesse da conta note: type: string description: Observações accountIdentifications: description: Entidade fachada referente aos identificadores da conta type: object required: – code – description – account 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/recordBasicAccount description: Conta accountCharacteristics: description: Entidade fachada referente às características da conta type: object required: – account – characteristics properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta characteristics: type: array items: type: object allOf: – #/definitions/recordCharacteristic minimum: 1 description: Características da conta 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