2.0info: 9.7.0 Contas description: Serviço responsável pelo contas do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: account contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/crmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /account/queries/updateAccountReceiveEmailMarketing: post: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string description: Dados em formato Base64 para decodificação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Dados em formato Base64 para decodificação in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /account/queries/updateContactReceiveEmailMarketing: post: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string description: Dados em formato Base64 para decodificação responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError get: description: Atualiza o campo receiveEmailMarketing do contato informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: data description: Dados em formato Base64 para decodificação in: query required: true type: string responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /account/queries/getAccountContactByPhone: post: description: Retorna o contato de uma conta a partir de um telefone tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – phoneNumber properties: phoneNumber: type: string description: Número de telefone responses: 200: description: Ok schema: type: object required: – accounts – contacts properties: accounts: type: array items: type: object allOf: – #/definitions/fullAccountRecord minimum: 1 description: Contas contacts: type: array items: type: object allOf: – #/definitions/fullContactRecord minimum: 1 description: Contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o contato de uma conta a partir de um telefone tags: – Queries x-senior-visibility: PRIVATE parameters: – name: phoneNumber description: Número de telefone in: query required: true type: string responses: 200: description: Ok schema: type: object required: – accounts – contacts properties: accounts: type: array items: type: object allOf: – #/definitions/fullAccountRecord minimum: 1 description: Contas contacts: type: array items: type: object allOf: – #/definitions/fullContactRecord minimum: 1 description: Contatos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /account/queries/healthcheck: post: description: 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 properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço 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 properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço 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/eventsAccountEnum description: Evento a ser disparado content: type: string description: Conteúdo 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 disparado quando um conta é criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountUpdated: post: description: Evento disparado quando um conta é atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionCreated: post: description: Evento disparado quando uma definição da conta é criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountDefinitionRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountDefinitionUpdated: post: description: Evento disparado quando uma definição da conta é atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountDefinitionRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneCreated: post: description: Evento disparado quando um telefone da conta é criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountPhoneRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountPhoneUpdated: post: description: Evento disparado quando um telefone da conta é atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountPhoneRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressCreated: post: description: Evento disparado quando um endereço da conta é criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountAddressRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/accountAddressUpdated: post: description: Evento disparado quando um endereço da conta é atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/fullAccountAddressRecord responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /account/events/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: upDown: description: Up or down type: string enum: – UP – DOWN eventsAccountEnum: 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 comparatorEnum: description: Enum com os comparadores dos filtros das queries type: string enum: – EQ – NEQ – IN – NOT_IN – LIKE – NOT_LIKE – LT – LTE – GT – GTE 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 fullAccountRecord: description: Record cópia da facade account type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia economicGroup: type: string description: Grupo Econômico stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal cnpj: type: string description: CNPJ da conta rg: type: string description: RG da conta cpf: type: string description: CPF da conta einNumber: type: string description: EIN ssnNumber: type: string description: SSN url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro employees: type: integer format: int64 description: Funcionários annualIncome: type: number format: double description: Receita anual registerDate: type: string format: date-time description: Data do cadastro customerSince: type: string format: date-time description: Cliente desde birthDate: type: string format: date-time description: Data de nascimento/abertura receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email customFields: type: string format: byte description: Campos customizados active: type: boolean description: Status de atividade personType: type: object allOf: – #/definitions/personTypeRecord description: Tipo de pessoa companySize: type: object allOf: – #/definitions/companySizeRecord description: Porte da empresa activityBranch: type: object allOf: – #/definitions/activityBranchRecord description: Ramo de atividade companyGroup: type: object allOf: – #/definitions/companyGroupRecord description: Grupo de empresa origin: type: object allOf: – #/definitions/originRecord description: Origem definitions: type: array items: type: object allOf: – #/definitions/fullAccountDefinitionRecord description: Definições nit: type: string description: NIT citizenshipCard: type: string description: Cédula Cidadania passport: type: string description: Passaporte addresses: type: array items: type: object allOf: – #/definitions/fullAccountAddressRecord description: Endereços phones: type: array items: type: object allOf: – #/definitions/fullAccountPhoneRecord description: Telefones fullAccountDefinitionRecord: description: Record cópia da facade accountDefinition type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id no sistema terceiro salesGoal: type: number format: double description: Meta prevista note: type: string description: Observações customFields: type: string format: byte description: Campos customizados receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email clientSince: type: string format: date-time description: Cliente desde rating: type: object allOf: – #/definitions/ratingRecord description: Rating carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora carrierDispatch: type: object allOf: – #/definitions/carrierDispatchRecord description: Redespacho account: type: object allOf: – #/definitions/fullAccountRecord description: Conta accountType: type: object allOf: – #/definitions/accountTypeRecord description: Tipo de conta companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial status: type: object allOf: – #/definitions/statusRecord description: Status paymentTerm: type: object allOf: – #/definitions/paymentTermRecord description: Prazo de pagamento inactivationReason: type: object allOf: – #/definitions/inactivationReasonRecord description: Motivo da inativação priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço typePayment: type: object allOf: – #/definitions/typePaymentRecord description: Tipo de Pagamento representative: type: object allOf: – #/definitions/representativeRecord description: Representante seller: type: object allOf: – #/definitions/sellerRecord description: Vendedor fullAccountAddressRecord: description: Record cópia da facade accountAddress type: object properties: id: type: integer format: int64 description: Código de identificação main: type: boolean description: Principal account: type: object allOf: – #/definitions/fullAccountRecord description: Conta address: type: object allOf: – #/definitions/addressRecord description: Endereço fullAccountPhoneRecord: description: Record cópia da facade accountPhone type: object properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM number: type: string description: Número type: type: integer format: int64 description: Tipo operator: type: integer format: int64 description: Operadora main: type: boolean description: Principal account: type: object allOf: – #/definitions/fullAccountRecord description: Conta fullContactRecord: description: Record cópia da facade contact type: object properties: id: type: integer format: int64 description: Código de identificação search: type: integer format: int64 description: Pesquisa privateUser: type: integer format: int64 description: Usuário privado sequentialErp: type: string description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer format: int64 description: Visibilidade name: type: string description: Nome treatment: type: string description: Tratamento functionDescription: type: string description: Função Descrição gender: type: integer format: int64 description: Gênero Sexual cep: type: string description: CEP zipCode: type: string description: ZIP Code address: type: string description: Endereço number: type: string description: Numero complement: type: string description: Complemento district: type: string description: Bairro cpf: type: string description: CPF rg: type: string description: RG citizenshipCard: type: string description: Cédula Cidadania telephone: type: string description: Telefone corporatePhone: type: boolean description: Telefone Corporativo phoneBranch: type: string description: Ramal fax: type: string description: FAX cell: type: string description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer format: int64 description: Operadora email: type: string description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveSearch: type: boolean description: Recebe pesquisa skype: type: string description: Skype twitter: type: string description: Twitter facebook: type: string description: Facebook birthday: type: string description: Aniversário birthDate: type: string format: date-time description: Data de Nascimento decisionLevel: type: integer format: int64 description: Nível de Decisão opinionCompany: type: integer format: int64 description: Parecer Empresa reasonOpinionCompany: type: string description: Motivo Parecer Empresa note: type: string description: Observações customFields: type: string format: byte description: Campos Customizados city: type: object allOf: – #/definitions/cityRecord description: Cidade department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função origin: type: object allOf: – #/definitions/originRecord description: Origem account: type: object allOf: – #/definitions/fullAccountRecord description: Conta superiorContact: type: object allOf: – #/definitions/fullContactRecord description: Contato Superior companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial activityBranchRecord: description: Ramo de atividade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo company: type: object allOf: – #/definitions/companyRecord description: Empresa companySizeRecord: description: Porte da empresa type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados personTypeRecord: description: Tipo de pessoa type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyGroupRecord: description: Grupo de empresa type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa originRecord: description: Origem da conta type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome da origem active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa companyBranchRecord: description: Empresa filial da definição da conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM company: type: object allOf: – #/definitions/companyRecord description: Empresa branch: type: object allOf: – #/definitions/branchRecord description: Filial companyRecord: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM companyErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome da Empresa fantasyName: type: string description: Nome fantasia da Empresa cnpj: type: string description: CNPJ nit: type: string description: NIT branchRecord: description: Objeto referente a filial da Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM branchErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ headquarters: type: integer format: int64 description: Matriz nit: type: string description: NIT recordBasicAccount: description: Conta da definição type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da conta cnpj: type: string description: CNPJ da Conta cpf: type: string description: CPF da Conta rg: type: string description: RG da Conta statusRecord: description: Status da definição da conta type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do status active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados icon: type: string description: Ícone idErp: type: string description: Id no sistema terceiro inactivationReasonRecord: description: Motivo da inativação type: object properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados accountTypeRecord: description: Tipo de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo icon: type: string description: Ícone color: type: string description: Cor requiredFields: type: string description: Campos obrigatórios customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa ratingRecord: description: Rating da conta por definição type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados priceTableRecord: description: Tabela de preço padrão para a definição de conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome valueAddition: type: number format: double description: Valor acréscimo active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Filial da Empresa carrierRecord: description: Transportadora type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Filial da empresa carrierDispatchRecord: description: Transportadora de Redespacho type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Filial da empresa representativeRecord: description: Representante type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome sellerRecord: description: Vendedor type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome paymentTermRecord: description: Prazo de pagamento padrão para a definição de conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo generatesInstallments: type: boolean description: Gera parcelas amountInstallments: type: integer format: int64 description: Quantidade de parcelas additionInstallments: type: number format: double description: Acréscimos de parcelas rounding: type: integer format: int64 description: Arredondamento customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa typePaymentRecord: description: Tipo de Pagamento type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id no sistema terceiro name: type: string description: Nome valueAddition: type: number format: double description: Valor de Acréscimo active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial addressRecord: description: Endereço type: object properties: id: type: integer format: int64 description: Código de identificação active: type: boolean description: Ativo name: type: string description: Nome address: type: string description: Endereço number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro cep: type: string description: CEP latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude customFields: type: string format: byte description: Campos customizados type: type: object allOf: – #/definitions/addressTypeRecord description: Tipo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial city: type: object allOf: – #/definitions/cityRecord description: Cidade zipCode: type: string description: ZIP addressTypeRecord: description: Tipo do endereço type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial cityRecord: description: Cidade type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id no sistema terceiro idIbge: type: string description: Código da cidade no IBGE name: type: string description: Nome active: type: boolean description: Ativo dddCode: type: string description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População Estimada consumptionPotential: type: number format: double description: Potencial de consumo pib: type: number format: double description: PIB customFields: type: string format: byte description: Custom Fields state: type: object allOf: – #/definitions/stateRecord description: Estado stateRecord: description: Estado type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Ativo country: type: object allOf: – #/definitions/countryRecord description: País customFields: type: string format: byte description: Campos customizados idErp: type: string description: Id no sistema terceiro countryRecord: description: País type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados countryCode: type: integer format: int64 description: Código do País idErp: type: string description: Id no sistema terceiro departmentRecord: description: Departamento do contato type: object properties: id: type: integer format: int64 description: Código de identificação companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial name: type: string description: Nome active: type: boolean description: Ativo usesOccurrence: type: boolean description: Usa Ocorrência customFields: type: string format: byte description: Campos Customizados relationshipTypeRecord: description: Tipo de relacionamento entre contas type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados userRecord: description: Usuário type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome descriptionFunction: type: string description: Descrição Função photo: type: string description: Foto email: type: string description: Email active: type: boolean description: Ativo userGroupRecord: description: Grupo Usuário type: object properties: id: type: integer format: int64 description: Id user: type: object allOf: – #/definitions/userRecord description: Usuário group: type: object allOf: – #/definitions/groupRecord description: Grupo groupRecord: description: Grupo de usuários type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa users: type: array items: type: object allOf: – #/definitions/userGroupRecord description: Usuário idErp: type: integer format: int64 description: Id no Sistema Terceiro interestAreaRecord: description: Área de interesse type: object properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa recordCharacteristic: description: Características type: object properties: id: type: integer format: int64 description: Código de identificação functionRecord: description: Objeto referente a Função type: object properties: id: type: integer format: int64 description: Código de identificação company: type: object allOf: – #/definitions/companyRecord description: Empresa name: type: string description: Nome active: type: boolean description: Ativo customFields: type: string format: byte description: Campos Customizados idErp: type: string description: Id no sistema terceiro account: description: Entidade fachada da Conta type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia economicGroup: type: string description: Grupo Econômico stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal cnpj: type: string description: CNPJ da conta rg: type: string description: RG da conta cpf: type: string description: CPF da conta einNumber: type: string description: EIN ssnNumber: type: string description: SSN url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro employees: type: integer format: int64 description: Funcionários annualIncome: type: number format: double description: Receita anual registerDate: type: string format: date-time description: Data do cadastro customerSince: type: string format: date-time description: Cliente desde birthDate: type: string format: date-time description: Data de nascimento/abertura receiveEmail: type: boolean description: Recebe email receiveEmailMarketing: type: boolean description: Recebe E-mail Marketing receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email customFields: type: string format: byte description: Campos customizados active: type: boolean description: Status de atividade personType: type: object allOf: – #/definitions/personTypeRecord description: Tipo de pessoa companySize: type: object allOf: – #/definitions/companySizeRecord description: Porte da empresa activityBranch: type: object allOf: – #/definitions/activityBranchRecord description: Ramo de atividade companyGroup: type: object allOf: – #/definitions/companyGroupRecord description: Grupo de empresa origin: type: object allOf: – #/definitions/originRecord description: Origem responsible: type: array items: type: object allOf: – #/definitions/accountResponsible description: Responsáveis definitions: type: array items: type: object allOf: – #/definitions/accountDefinition description: Definições nit: type: string description: NIT citizenshipCard: type: string description: Cédula Cidadania passport: type: string description: Passaporte addresses: type: array items: type: object allOf: – #/definitions/accountAddress description: Endereços phones: type: array items: type: object allOf: – #/definitions/accountPhone description: Telefones historicIntegrations: type: array items: type: object allOf: – #/definitions/accountHistoryIntegration description: Histórico de Integrações contacts: type: array items: type: object allOf: – #/definitions/contact description: Contatos identifiers: type: array items: type: object allOf: – #/definitions/accountIdentifications description: Identificadores accountDefinition: description: Entidade fachada da Definições da Conta type: object properties: id: type: integer format: int64 description: Código de identificação idErp: type: string description: Id no sistema terceiro salesGoal: type: number format: double description: Meta prevista note: type: string description: Observações customFields: type: string format: byte description: Campos customizados receiveEmail: type: boolean description: Recebe email receiveSurvey: type: boolean description: Recebe pesquisa receiveTrackEmail: type: boolean description: Recebe monitora email clientSince: type: string format: date-time description: Cliente desde rating: type: object allOf: – #/definitions/ratingRecord description: Rating carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora carrierDispatch: type: object allOf: – #/definitions/carrierDispatchRecord description: Redespacho account: type: object allOf: – #/definitions/account description: Conta accountType: type: object allOf: – #/definitions/accountTypeRecord description: Tipo de conta companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial status: type: object allOf: – #/definitions/statusRecord description: Status paymentTerm: type: object allOf: – #/definitions/paymentTermRecord description: Prazo de pagamento inactivationReason: type: object allOf: – #/definitions/inactivationReasonRecord description: Motivo da inativação priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço typePayment: type: object allOf: – #/definitions/typePaymentRecord description: Tipo de Pagamento representative: type: object allOf: – #/definitions/representativeRecord description: Representante seller: type: object allOf: – #/definitions/sellerRecord description: Vendedor accountPhone: description: Entidade fachada da conta de telefone type: object properties: id: type: integer format: int64 description: Código de identificação da definição da conta no CRM number: type: string description: Número type: type: integer format: int64 description: Tipo operator: type: integer format: int64 description: Operadora main: type: boolean description: Principal account: type: object allOf: – #/definitions/account description: Conta accountAddress: description: Entidade fachada do endereço da conta type: object properties: id: type: integer format: int64 description: Código de identificação main: type: boolean description: Principal account: type: object allOf: – #/definitions/account description: Conta address: type: object allOf: – #/definitions/addressRecord description: Endereço accountHistoryIntegration: description: Facade referente ao histórico de integração da conta type: object properties: id: type: integer format: int64 description: Id de identificação dateTime: type: string format: date-time description: Data e hora status: type: integer format: int64 description: Status onde 1: Não Integrado 2: Integrado: 3: Falha ao integrar minimum: 0 maximum: 2 content: type: string description: Conteúdo account: type: object allOf: – #/definitions/account description: Conta contact: description: Entidade fachada referente ao contato type: object properties: id: type: integer format: int64 description: Código de identificação search: type: integer format: int64 description: Pesquisa privateUser: type: integer format: int64 description: Usuário privado sequentialErp: type: string description: Sequencial no ERP active: type: boolean description: Ativo visibility: type: integer format: int64 description: Visibilidade name: type: string description: Nome treatment: type: string description: Tratamento functionDescription: type: string description: Função Descrição gender: type: integer format: int64 description: Gênero Sexual cep: type: string description: CEP zipCode: type: string description: ZIP Code address: type: string description: Endereço number: type: string description: Numero complement: type: string description: Complemento district: type: string description: Bairro cpf: type: string description: CPF rg: type: string description: RG citizenshipCard: type: string description: Cédula Cidadania telephone: type: string description: Telefone corporatePhone: type: boolean description: Telefone Corporativo phoneBranch: type: string description: Ramal fax: type: string description: FAX cell: type: string description: Celular corporateCellPhone: type: boolean description: Celular comparativo mobileWhatsapp: type: boolean description: Celular WhatsApp operator: type: integer format: int64 description: Operadora email: type: string description: Email corporateEmail: type: boolean description: Email corporativo receiveCampaign: type: boolean description: Recebe Campanha receiveEmailMarketing: type: boolean description: Recebe E-mail Marketing receiveSearch: type: boolean description: Recebe pesquisa skype: type: string description: Skype twitter: type: string description: Twitter facebook: type: string description: Facebook birthday: type: string description: Aniversário birthDate: type: string format: date-time description: Data de Nascimento decisionLevel: type: integer format: int64 description: Nível de Decisão opinionCompany: type: integer format: int64 description: Parecer Empresa reasonOpinionCompany: type: string description: Motivo Parecer Empresa note: type: string description: Observações customFields: type: string format: byte description: Campos Customizados city: type: object allOf: – #/definitions/cityRecord description: Cidade department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função origin: type: object allOf: – #/definitions/originRecord description: Origem account: type: object allOf: – #/definitions/account description: Conta superiorContact: type: object allOf: – #/definitions/contact description: Contato Superior companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa Filial accountRelationships: description: Entidade fachada referente ao relacionamento de contas type: object properties: id: type: integer format: int64 description: Código de identificação note: type: string description: Observações status: type: boolean description: Status fatherAccount: type: object allOf: – #/definitions/account description: Conta Pai childAccount: type: object allOf: – #/definitions/account description: Conta Filha relationshipType: type: object allOf: – #/definitions/relationshipTypeRecord description: Tipo do relacionamento accountResponsible: description: Entidade fachada referente ao responsável da conta type: object properties: id: type: integer format: int64 description: Código de identificação erpOrigin: type: boolean description: Origem ERP user: type: object allOf: – #/definitions/userRecord description: Usuário account: type: object allOf: – #/definitions/account description: Conta group: type: object allOf: – #/definitions/groupRecord description: Grupo de usuários accountInterestAreas: description: Entidade fachada referente à área de interesse type: object properties: id: type: integer format: int64 description: Código de identificação interestType: type: integer format: int64 description: Tipo de interesse note: type: string description: Observações dateRegister: type: string format: date-time description: Data de Cadastro account: type: object allOf: – #/definitions/account description: Conta interestAreas: type: object allOf: – #/definitions/interestAreaRecord description: Área de interesse accountIdentifications: description: Entidade fachada referente aos identificadores da conta type: object properties: id: type: integer format: int64 description: Código de identificação code: type: integer format: int64 description: Outro possível código para a conta description: type: string description: Descrição do código account: type: object allOf: – #/definitions/account description: Conta accountCharacteristics: description: Entidade fachada referente às características da conta type: object 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 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