2.0info: 2.22.0 Cadastros básicos description: Serviço responsável pelos cadastros básicos do CRM x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: basic_records 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: /basic_records/queries/healthcheck: post: description: Query para o CRM verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PUBLIC 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/healthCheckStatusEnum description: Status atual da aplicaçã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: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/healthCheckStatusEnum description: Status atual da aplicação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/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 /basic_records/queries/exportActivityBranches: 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 /basic_records/queries/exportCompanyGroups: 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 /basic_records/queries/exportPriceTable: 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 /basic_records/queries/exportActionType: 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 /basic_records/queries/exportCarrier: 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 /basic_records/queries/exportPaymentTerms: 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 /basic_records/queries/exportOpportunityType: 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 /basic_records/queries/exportPaymentType: 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 /basic_records/queries/exportDeposit: 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 /basic_records/queries/exportProduct: 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 /basic_records/queries/exportService: 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 /basic_records/queries/exportAccountType: 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 /basic_records/queries/exportCities: 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 /basic_records/queries/exportStates: 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 /basic_records/queries/exportCountries: 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 /basic_records/queries/exportAccountOrigins: 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 /basic_records/queries/exportAccountStatus: 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 /basic_records/queries/exportAddressTypes: 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 /basic_records/queries/exportAppointmentCategories: 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 /basic_records/queries/exportBusinessTypes: 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 /basic_records/queries/exportCompanySize: 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 /basic_records/queries/exportInactivationReason: 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 /basic_records/queries/exportEventTypes: 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 /basic_records/queries/exportEventsStatus: 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 /basic_records/queries/exportInterestAreas: 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 /basic_records/queries/exportLocations: 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 /basic_records/queries/exportLossReasons: 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 /basic_records/queries/exportOpportunityOrigins: 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 /basic_records/queries/exportFollowType: 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 /basic_records/queries/exportProductCategories: 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 /basic_records/queries/exportRatings: 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 /basic_records/queries/exportRegions: 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 /basic_records/queries/exportSalesReasons: 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 /basic_records/queries/exportRelationshipTypes: 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 /basic_records/queries/exportServiceCategories: 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 /basic_records/queries/exportMeasurementUnit: 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 /basic_records/queries/exportUserGroups: 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 /basic_records/queries/exportUser: 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 /basic_records/queries/exportCompanyBranch: 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 /basic_records/queries/exportCompany: 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 /basic_records/queries/exportBranch: 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 /basic_records/queries/exportFunction: 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 /basic_records/queries/exportDepartment: 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 /basic_records/queries/exportContactOrigin: 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 /basic_records/queries/exportOccurrenceType: 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 /basic_records/queries/exportOccurrenceSubtype: 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 /basic_records/queries/exportPersonType: 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 /basic_records/queries/exportOccurrenceStatus: 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 /basic_records/queries/exportOccurrenceOrigin: 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 /basic_records/queries/exportRegionCity: 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 /basic_records/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 /basic_records/actions/publishEvent: post: description: Dispara um evento do basic records 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/enumEventsBasicRecords description: Evento a ser disparado content: type: string description: Conteúdo serializado 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 /basic_records/actions/uploadFile: post: description: Faz o upload de um arquivo tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object properties: id: type: array items: type: integer format: int64 description: IDs dos arquivos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/actions/importActivityBranches: 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 /basic_records/actions/importCompanyGroups: 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 /basic_records/actions/importPriceTable: 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 /basic_records/actions/importActionType: 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 /basic_records/actions/importCarrier: 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 /basic_records/actions/importPaymentTerms: 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 /basic_records/actions/importOpportunityType: 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 /basic_records/actions/importPaymentType: 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 /basic_records/actions/importDeposit: 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 /basic_records/actions/importProduct: 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 /basic_records/actions/importService: 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 /basic_records/actions/importAccountType: 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 /basic_records/actions/importCities: 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 /basic_records/actions/importStates: 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 /basic_records/actions/importCountries: 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 /basic_records/actions/importAccountOrigins: 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 /basic_records/actions/importAccountStatus: 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 /basic_records/actions/importAddressTypes: 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 /basic_records/actions/importAppointmentCategories: 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 /basic_records/actions/importBusinessTypes: 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 /basic_records/actions/importCompanySize: 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 /basic_records/actions/importInactivationReason: 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 /basic_records/actions/importEventTypes: 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 /basic_records/actions/importEventsStatus: 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 /basic_records/actions/importInterestAreas: 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 /basic_records/actions/importLocations: 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 /basic_records/actions/importLossReasons: 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 /basic_records/actions/importOpportunityOrigins: 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 /basic_records/actions/importFollowType: 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 /basic_records/actions/importProductCategories: 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 /basic_records/actions/importRatings: 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 /basic_records/actions/importRegions: 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 /basic_records/actions/importSalesReasons: 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 /basic_records/actions/importRelationshipTypes: 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 /basic_records/actions/importServiceCategories: 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 /basic_records/actions/importMeasurementUnit: 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 /basic_records/actions/importUserGroups: 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 /basic_records/actions/importUser: 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 /basic_records/actions/importCompanyBranch: 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 /basic_records/actions/importCompany: 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 /basic_records/actions/importBranch: 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 /basic_records/actions/importFunction: 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 /basic_records/actions/importDepartment: 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 /basic_records/actions/importContactOrigin: 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 /basic_records/actions/importOccurrenceType: 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 /basic_records/actions/importOccurrenceSubtype: 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 /basic_records/actions/importPersonType: 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 /basic_records/actions/importOccurrenceStatus: 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 /basic_records/actions/importOccurrenceOrigin: 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 /basic_records/actions/importRegionCity: 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 /basic_records/events/activityBranchesCreated: post: description: Evento de ramo de atividade criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – activityBranches properties: activityBranches: type: object allOf: – #/definitions/activityBranchesRecord description: Ramo de atividade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/companyGroupsCreated: post: description: Evento de grupo de empresa criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – companyGroups properties: companyGroups: type: object allOf: – #/definitions/companyGroupsRecord description: Grupo de empresa responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/priceTableCreated: post: description: Evento de tabela de preço criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – priceTable properties: priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/carrierCreated: post: description: Evento de transportadora criada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – carrier properties: carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTermsCreated: post: description: Evento de prazo de pagamento criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentTerms properties: paymentTerms: type: object allOf: – #/definitions/paymentTermsRecord description: Prazo de pagamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/opportunityTypeCreated: post: description: Evento de tipo de oportunidade criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – opportunityType properties: opportunityType: type: object allOf: – #/definitions/opportunityTypeRecord description: Tipo de oportunidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTypeCreated: post: description: Evento de tipo de pagamento criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentType properties: paymentType: type: object allOf: – #/definitions/paymentTypeRecord description: Tipo de pagament responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/depositCreated: post: description: Evento de depósito criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – deposit properties: deposit: type: object allOf: – #/definitions/depositRecord description: Depósito responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/productCreated: post: description: Evento de produto criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – product properties: product: type: object allOf: – #/definitions/productRecord description: Produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/serviceCreated: post: description: Evento de serviço criado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – service properties: service: type: object allOf: – #/definitions/serviceRecord description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/activityBranchesUpdated: post: description: Evento de ramo de atividade atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – activityBranches properties: activityBranches: type: object allOf: – #/definitions/activityBranchesRecord description: Ramo de atividade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/companyGroupsUpdated: post: description: Evento de grupo de empresa atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – companyGroups properties: companyGroups: type: object allOf: – #/definitions/companyGroupsRecord description: Grupo de empresa responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/priceTableUpdated: post: description: Evento de tabela de preço atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – priceTable properties: priceTable: type: object allOf: – #/definitions/priceTableRecord description: Tabela de preço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/carrierUpdated: post: description: Evento de transportadora atualizada x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – carrier properties: carrier: type: object allOf: – #/definitions/carrierRecord description: Transportadora responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTermsUpdated: post: description: Evento de prazo de pagamento atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentTerms properties: paymentTerms: type: object allOf: – #/definitions/paymentTermsRecord description: Prazo de pagamento responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/opportunityTypeUpdated: post: description: Evento de tipo de oportunidade atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – opportunityType properties: opportunityType: type: object allOf: – #/definitions/opportunityTypeRecord description: Tipo de oportunidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/paymentTypeUpdated: post: description: Evento de tipo de pagamento atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – paymentType properties: paymentType: type: object allOf: – #/definitions/paymentTypeRecord description: Tipo de pagament responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/depositUpdated: post: description: Evento de depósito atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – deposit properties: deposit: type: object allOf: – #/definitions/depositRecord description: Depósito responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/productUpdated: post: description: Evento de produto atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – product properties: product: type: object allOf: – #/definitions/productRecord description: Produto responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/serviceUpdated: post: description: Evento de serviço atualizado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – service properties: service: type: object allOf: – #/definitions/serviceRecord description: Serviço responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /basic_records/events/importActivityBranchesEvent: 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 /basic_records/events/exportActivityBranchesEvent: 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 /basic_records/events/importCompanyGroupsEvent: 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 /basic_records/events/exportCompanyGroupsEvent: 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 /basic_records/events/importPriceTableEvent: 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 /basic_records/events/exportPriceTableEvent: 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 /basic_records/events/importActionTypeEvent: 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 /basic_records/events/exportActionTypeEvent: 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 /basic_records/events/importCarrierEvent: 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 /basic_records/events/exportCarrierEvent: 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 /basic_records/events/importPaymentTermsEvent: 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 /basic_records/events/exportPaymentTermsEvent: 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 /basic_records/events/importOpportunityTypeEvent: 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 /basic_records/events/exportOpportunityTypeEvent: 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 /basic_records/events/importPaymentTypeEvent: 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 /basic_records/events/exportPaymentTypeEvent: 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 /basic_records/events/importDepositEvent: 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 /basic_records/events/exportDepositEvent: 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 /basic_records/events/importProductEvent: 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 /basic_records/events/exportProductEvent: 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 /basic_records/events/importServiceEvent: 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 /basic_records/events/exportServiceEvent: 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 /basic_records/events/importAccountTypeEvent: 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 /basic_records/events/exportAccountTypeEvent: 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 /basic_records/events/importCitiesEvent: 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 /basic_records/events/exportCitiesEvent: 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 /basic_records/events/importStatesEvent: 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 /basic_records/events/exportStatesEvent: 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 /basic_records/events/importCountriesEvent: 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 /basic_records/events/exportCountriesEvent: 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 /basic_records/events/importAccountOriginsEvent: 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 /basic_records/events/exportAccountOriginsEvent: 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 /basic_records/events/importAccountStatusEvent: 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 /basic_records/events/exportAccountStatusEvent: 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 /basic_records/events/importAddressTypesEvent: 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 /basic_records/events/exportAddressTypesEvent: 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 /basic_records/events/importAppointmentCategoriesEvent: 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 /basic_records/events/exportAppointmentCategoriesEvent: 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 /basic_records/events/importBusinessTypesEvent: 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 /basic_records/events/exportBusinessTypesEvent: 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 /basic_records/events/importCompanySizeEvent: 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 /basic_records/events/exportCompanySizeEvent: 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 /basic_records/events/importInactivationReasonEvent: 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 /basic_records/events/exportInactivationReasonEvent: 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 /basic_records/events/importEventTypesEvent: 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 /basic_records/events/exportEventTypesEvent: 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 /basic_records/events/importEventsStatusEvent: 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 /basic_records/events/exportEventsStatusEvent: 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 /basic_records/events/importInterestAreasEvent: 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 /basic_records/events/exportInterestAreasEvent: 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 /basic_records/events/importLocationsEvent: 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 /basic_records/events/exportLocationsEvent: 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 /basic_records/events/importLossReasonsEvent: 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 /basic_records/events/exportLossReasonsEvent: 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 /basic_records/events/importOpportunityOriginsEvent: 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 /basic_records/events/exportOpportunityOriginsEvent: 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 /basic_records/events/importFollowTypeEvent: 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 /basic_records/events/exportFollowTypeEvent: 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 /basic_records/events/importProductCategoriesEvent: 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 /basic_records/events/exportProductCategoriesEvent: 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 /basic_records/events/importRatingsEvent: 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 /basic_records/events/exportRatingsEvent: 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 /basic_records/events/importRegionsEvent: 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 /basic_records/events/exportRegionsEvent: 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 /basic_records/events/importSalesReasonsEvent: 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 /basic_records/events/exportSalesReasonsEvent: 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 /basic_records/events/importRelationshipTypesEvent: 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 /basic_records/events/exportRelationshipTypesEvent: 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 /basic_records/events/importServiceCategoriesEvent: 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 /basic_records/events/exportServiceCategoriesEvent: 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 /basic_records/events/importMeasurementUnitEvent: 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 /basic_records/events/exportMeasurementUnitEvent: 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 /basic_records/events/importUserGroupsEvent: 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 /basic_records/events/exportUserGroupsEvent: 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 /basic_records/events/importUserEvent: 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 /basic_records/events/exportUserEvent: 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 /basic_records/events/importCompanyBranchEvent: 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 /basic_records/events/exportCompanyBranchEvent: 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 /basic_records/events/importCompanyEvent: 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 /basic_records/events/exportCompanyEvent: 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 /basic_records/events/importBranchEvent: 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 /basic_records/events/exportBranchEvent: 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 /basic_records/events/importFunctionEvent: 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 /basic_records/events/exportFunctionEvent: 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 /basic_records/events/importDepartmentEvent: 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 /basic_records/events/exportDepartmentEvent: 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 /basic_records/events/importContactOriginEvent: 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 /basic_records/events/exportContactOriginEvent: 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 /basic_records/events/importOccurrenceTypeEvent: 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 /basic_records/events/exportOccurrenceTypeEvent: 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 /basic_records/events/importOccurrenceSubtypeEvent: 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 /basic_records/events/exportOccurrenceSubtypeEvent: 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 /basic_records/events/importPersonTypeEvent: 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 /basic_records/events/exportPersonTypeEvent: 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 /basic_records/events/importOccurrenceStatusEvent: 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 /basic_records/events/exportOccurrenceStatusEvent: 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 /basic_records/events/importOccurrenceOriginEvent: 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 /basic_records/events/exportOccurrenceOriginEvent: 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 /basic_records/events/importRegionCityEvent: 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 /basic_records/events/exportRegionCityEvent: 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 /basic_records/entities/activityBranches: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 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/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 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/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/activityBranches/{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/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 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/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 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/activityBranches 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 /basic_records/entities/activityBranches/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activityBranches responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companyGroups: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 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/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 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/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companyGroups/{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/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 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/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 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/companyGroups 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 /basic_records/entities/companyGroups/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyGroups responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/priceTable: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 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/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 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/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/priceTable/{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/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 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/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 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/priceTable 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 /basic_records/entities/priceTable/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/priceTable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/actionType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/actionType responses: 200: description: The created resource schema: #/definitions/actionType 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/actionType responses: 200: description: The created resource schema: #/definitions/actionType 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/actionType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/actionType/{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/actionType responses: 200: description: Ok schema: #/definitions/actionType 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/actionType responses: 200: description: Ok schema: #/definitions/actionType 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/actionType 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 /basic_records/entities/actionType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/actionType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/carrier: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/carrier responses: 200: description: The created resource schema: #/definitions/carrier 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/carrier responses: 200: description: The created resource schema: #/definitions/carrier 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/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/carrier/{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/carrier responses: 200: description: Ok schema: #/definitions/carrier 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/carrier responses: 200: description: Ok schema: #/definitions/carrier 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/carrier 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 /basic_records/entities/carrier/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/carrier responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentTerms: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 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/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 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/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentTerms/{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/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 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/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 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/paymentTerms 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 /basic_records/entities/paymentTerms/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentTerms responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/opportunityType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 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/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 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/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/opportunityType/{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/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 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/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 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/opportunityType 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 /basic_records/entities/opportunityType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 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/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 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/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/paymentType/{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/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 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/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 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/paymentType 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 /basic_records/entities/paymentType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/deposit: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposit responses: 200: description: The created resource schema: #/definitions/deposit 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/deposit responses: 200: description: The created resource schema: #/definitions/deposit 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/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/deposit/{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/deposit responses: 200: description: Ok schema: #/definitions/deposit 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/deposit responses: 200: description: Ok schema: #/definitions/deposit 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/deposit 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 /basic_records/entities/deposit/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deposit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/product: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 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/product responses: 200: description: The created resource schema: #/definitions/product 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/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/product/{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/product responses: 200: description: Ok schema: #/definitions/product 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/product responses: 200: description: Ok schema: #/definitions/product 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/product 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 /basic_records/entities/product/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/service: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/service responses: 200: description: The created resource schema: #/definitions/service 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/service responses: 200: description: The created resource schema: #/definitions/service 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/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/service/{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/service responses: 200: description: Ok schema: #/definitions/service 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/service responses: 200: description: Ok schema: #/definitions/service 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/service 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 /basic_records/entities/service/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/service responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountType responses: 200: description: The created resource schema: #/definitions/accountType 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/accountType responses: 200: description: The created resource schema: #/definitions/accountType 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/accountType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountType/{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/accountType responses: 200: description: Ok schema: #/definitions/accountType 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/accountType responses: 200: description: Ok schema: #/definitions/accountType 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/accountType 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 /basic_records/entities/accountType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/cities: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/cities responses: 200: description: The created resource schema: #/definitions/cities 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/cities responses: 200: description: The created resource schema: #/definitions/cities 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/cities 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/cities/{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/cities responses: 200: description: Ok schema: #/definitions/cities 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/cities responses: 200: description: Ok schema: #/definitions/cities 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/cities 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 /basic_records/entities/cities/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/cities responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/states: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/states responses: 200: description: The created resource schema: #/definitions/states 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/states responses: 200: description: The created resource schema: #/definitions/states 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/states 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/states/{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/states responses: 200: description: Ok schema: #/definitions/states 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/states responses: 200: description: Ok schema: #/definitions/states 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/states 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 /basic_records/entities/states/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/states responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/countries: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/countries responses: 200: description: The created resource schema: #/definitions/countries 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/countries responses: 200: description: The created resource schema: #/definitions/countries 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/countries 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/countries/{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/countries responses: 200: description: Ok schema: #/definitions/countries 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/countries responses: 200: description: Ok schema: #/definitions/countries 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/countries 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 /basic_records/entities/countries/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/countries responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountOrigins: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountOrigins responses: 200: description: The created resource schema: #/definitions/accountOrigins 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/accountOrigins responses: 200: description: The created resource schema: #/definitions/accountOrigins 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/accountOrigins 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountOrigins/{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/accountOrigins responses: 200: description: Ok schema: #/definitions/accountOrigins 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/accountOrigins responses: 200: description: Ok schema: #/definitions/accountOrigins 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/accountOrigins 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 /basic_records/entities/accountOrigins/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountOrigins responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountStatus: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountStatus responses: 200: description: The created resource schema: #/definitions/accountStatus 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/accountStatus responses: 200: description: The created resource schema: #/definitions/accountStatus 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/accountStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/accountStatus/{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/accountStatus responses: 200: description: Ok schema: #/definitions/accountStatus 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/accountStatus responses: 200: description: Ok schema: #/definitions/accountStatus 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/accountStatus 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 /basic_records/entities/accountStatus/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountStatus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/addressTypes: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/addressTypes responses: 200: description: The created resource schema: #/definitions/addressTypes 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/addressTypes responses: 200: description: The created resource schema: #/definitions/addressTypes 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/addressTypes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/addressTypes/{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/addressTypes responses: 200: description: Ok schema: #/definitions/addressTypes 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/addressTypes responses: 200: description: Ok schema: #/definitions/addressTypes 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/addressTypes 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 /basic_records/entities/addressTypes/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/addressTypes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/appointmentCategories: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/appointmentCategories responses: 200: description: The created resource schema: #/definitions/appointmentCategories 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/appointmentCategories responses: 200: description: The created resource schema: #/definitions/appointmentCategories 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/appointmentCategories 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/appointmentCategories/{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/appointmentCategories responses: 200: description: Ok schema: #/definitions/appointmentCategories 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/appointmentCategories responses: 200: description: Ok schema: #/definitions/appointmentCategories 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/appointmentCategories 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 /basic_records/entities/appointmentCategories/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/appointmentCategories responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/businessTypes: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/businessTypes responses: 200: description: The created resource schema: #/definitions/businessTypes 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/businessTypes responses: 200: description: The created resource schema: #/definitions/businessTypes 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/businessTypes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/businessTypes/{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/businessTypes responses: 200: description: Ok schema: #/definitions/businessTypes 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/businessTypes responses: 200: description: Ok schema: #/definitions/businessTypes 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/businessTypes 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 /basic_records/entities/businessTypes/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/businessTypes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companySize: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companySize responses: 200: description: The created resource schema: #/definitions/companySize 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/companySize responses: 200: description: The created resource schema: #/definitions/companySize 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/companySize 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companySize/{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/companySize responses: 200: description: Ok schema: #/definitions/companySize 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/companySize responses: 200: description: Ok schema: #/definitions/companySize 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/companySize 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 /basic_records/entities/companySize/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companySize responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/inactivationReason: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/inactivationReason responses: 200: description: The created resource schema: #/definitions/inactivationReason 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/inactivationReason responses: 200: description: The created resource schema: #/definitions/inactivationReason 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/inactivationReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/inactivationReason/{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/inactivationReason responses: 200: description: Ok schema: #/definitions/inactivationReason 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/inactivationReason responses: 200: description: Ok schema: #/definitions/inactivationReason 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/inactivationReason 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 /basic_records/entities/inactivationReason/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/inactivationReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/eventTypes: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventTypes responses: 200: description: The created resource schema: #/definitions/eventTypes 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/eventTypes responses: 200: description: The created resource schema: #/definitions/eventTypes 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/eventTypes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/eventTypes/{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/eventTypes responses: 200: description: Ok schema: #/definitions/eventTypes 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/eventTypes responses: 200: description: Ok schema: #/definitions/eventTypes 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/eventTypes 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 /basic_records/entities/eventTypes/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventTypes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/eventsStatus: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/eventsStatus responses: 200: description: The created resource schema: #/definitions/eventsStatus 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/eventsStatus responses: 200: description: The created resource schema: #/definitions/eventsStatus 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/eventsStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/eventsStatus/{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/eventsStatus responses: 200: description: Ok schema: #/definitions/eventsStatus 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/eventsStatus responses: 200: description: Ok schema: #/definitions/eventsStatus 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/eventsStatus 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 /basic_records/entities/eventsStatus/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/eventsStatus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/interestAreas: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/interestAreas responses: 200: description: The created resource schema: #/definitions/interestAreas 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/interestAreas responses: 200: description: The created resource schema: #/definitions/interestAreas 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/interestAreas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/interestAreas/{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/interestAreas responses: 200: description: Ok schema: #/definitions/interestAreas 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/interestAreas responses: 200: description: Ok schema: #/definitions/interestAreas 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/interestAreas 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 /basic_records/entities/interestAreas/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/interestAreas responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/locations: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/locations responses: 200: description: The created resource schema: #/definitions/locations 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/locations responses: 200: description: The created resource schema: #/definitions/locations 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/locations 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/locations/{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/locations responses: 200: description: Ok schema: #/definitions/locations 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/locations responses: 200: description: Ok schema: #/definitions/locations 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/locations 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 /basic_records/entities/locations/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/locations responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/lossReasons: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lossReasons responses: 200: description: The created resource schema: #/definitions/lossReasons 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/lossReasons responses: 200: description: The created resource schema: #/definitions/lossReasons 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/lossReasons 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/lossReasons/{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/lossReasons responses: 200: description: Ok schema: #/definitions/lossReasons 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/lossReasons responses: 200: description: Ok schema: #/definitions/lossReasons 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/lossReasons 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 /basic_records/entities/lossReasons/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lossReasons responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/opportunityOrigins: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityOrigins responses: 200: description: The created resource schema: #/definitions/opportunityOrigins 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/opportunityOrigins responses: 200: description: The created resource schema: #/definitions/opportunityOrigins 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/opportunityOrigins 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/opportunityOrigins/{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/opportunityOrigins responses: 200: description: Ok schema: #/definitions/opportunityOrigins 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/opportunityOrigins responses: 200: description: Ok schema: #/definitions/opportunityOrigins 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/opportunityOrigins 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 /basic_records/entities/opportunityOrigins/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityOrigins responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/followType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/followType responses: 200: description: The created resource schema: #/definitions/followType 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/followType responses: 200: description: The created resource schema: #/definitions/followType 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/followType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/followType/{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/followType responses: 200: description: Ok schema: #/definitions/followType 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/followType responses: 200: description: Ok schema: #/definitions/followType 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/followType 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 /basic_records/entities/followType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/followType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/productCategories: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/productCategories responses: 200: description: The created resource schema: #/definitions/productCategories 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/productCategories responses: 200: description: The created resource schema: #/definitions/productCategories 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/productCategories 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/productCategories/{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/productCategories responses: 200: description: Ok schema: #/definitions/productCategories 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/productCategories responses: 200: description: Ok schema: #/definitions/productCategories 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/productCategories 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 /basic_records/entities/productCategories/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/productCategories responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/ratings: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ratings responses: 200: description: The created resource schema: #/definitions/ratings 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/ratings responses: 200: description: The created resource schema: #/definitions/ratings 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/ratings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/ratings/{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/ratings responses: 200: description: Ok schema: #/definitions/ratings 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/ratings responses: 200: description: Ok schema: #/definitions/ratings 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/ratings 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 /basic_records/entities/ratings/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ratings responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/regions: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/regions responses: 200: description: The created resource schema: #/definitions/regions 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/regions responses: 200: description: The created resource schema: #/definitions/regions 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/regions 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/regions/{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/regions responses: 200: description: Ok schema: #/definitions/regions 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/regions responses: 200: description: Ok schema: #/definitions/regions 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/regions 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 /basic_records/entities/regions/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/regions responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/salesReasons: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/salesReasons responses: 200: description: The created resource schema: #/definitions/salesReasons 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/salesReasons responses: 200: description: The created resource schema: #/definitions/salesReasons 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/salesReasons 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/salesReasons/{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/salesReasons responses: 200: description: Ok schema: #/definitions/salesReasons 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/salesReasons responses: 200: description: Ok schema: #/definitions/salesReasons 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/salesReasons 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 /basic_records/entities/salesReasons/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/salesReasons responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/relationshipTypes: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/relationshipTypes responses: 200: description: The created resource schema: #/definitions/relationshipTypes 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/relationshipTypes responses: 200: description: The created resource schema: #/definitions/relationshipTypes 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/relationshipTypes 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/relationshipTypes/{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/relationshipTypes responses: 200: description: Ok schema: #/definitions/relationshipTypes 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/relationshipTypes responses: 200: description: Ok schema: #/definitions/relationshipTypes 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/relationshipTypes 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 /basic_records/entities/relationshipTypes/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/relationshipTypes responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/serviceCategories: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/serviceCategories responses: 200: description: The created resource schema: #/definitions/serviceCategories 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/serviceCategories responses: 200: description: The created resource schema: #/definitions/serviceCategories 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/serviceCategories 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/serviceCategories/{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/serviceCategories responses: 200: description: Ok schema: #/definitions/serviceCategories 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/serviceCategories responses: 200: description: Ok schema: #/definitions/serviceCategories 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/serviceCategories 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 /basic_records/entities/serviceCategories/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/serviceCategories responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/measurementUnit: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/measurementUnit responses: 200: description: The created resource schema: #/definitions/measurementUnit 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/measurementUnit responses: 200: description: The created resource schema: #/definitions/measurementUnit 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/measurementUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/measurementUnit/{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/measurementUnit responses: 200: description: Ok schema: #/definitions/measurementUnit 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/measurementUnit responses: 200: description: Ok schema: #/definitions/measurementUnit 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/measurementUnit 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 /basic_records/entities/measurementUnit/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/measurementUnit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/userGroups: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/userGroups responses: 200: description: The created resource schema: #/definitions/userGroups 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/userGroups responses: 200: description: The created resource schema: #/definitions/userGroups 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/userGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/userGroups/{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/userGroups responses: 200: description: Ok schema: #/definitions/userGroups 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/userGroups responses: 200: description: Ok schema: #/definitions/userGroups 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/userGroups 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 /basic_records/entities/userGroups/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/userGroups responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/user: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/user responses: 200: description: The created resource schema: #/definitions/user 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/user responses: 200: description: The created resource schema: #/definitions/user 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/user 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/user/{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/user responses: 200: description: Ok schema: #/definitions/user 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/user responses: 200: description: Ok schema: #/definitions/user 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/user 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 /basic_records/entities/user/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/user responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companyBranch: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 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/companyBranch responses: 200: description: The created resource schema: #/definitions/companyBranch 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/companyBranch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/companyBranch/{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/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 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/companyBranch responses: 200: description: Ok schema: #/definitions/companyBranch 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/companyBranch 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 /basic_records/entities/companyBranch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyBranch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/company: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 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/company responses: 200: description: The created resource schema: #/definitions/company 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/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/company/{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/company responses: 200: description: Ok schema: #/definitions/company 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/company responses: 200: description: Ok schema: #/definitions/company 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/company 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 /basic_records/entities/company/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/branch: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/branch responses: 200: description: The created resource schema: #/definitions/branch 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/branch responses: 200: description: The created resource schema: #/definitions/branch 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/branch 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/branch/{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/branch responses: 200: description: Ok schema: #/definitions/branch 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/branch responses: 200: description: Ok schema: #/definitions/branch 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/branch 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 /basic_records/entities/branch/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/branch responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/function: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/function responses: 200: description: The created resource schema: #/definitions/function 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/function responses: 200: description: The created resource schema: #/definitions/function 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/function 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/function/{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/function responses: 200: description: Ok schema: #/definitions/function 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/function responses: 200: description: Ok schema: #/definitions/function 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/function 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 /basic_records/entities/function/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/function responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/department: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/department responses: 200: description: The created resource schema: #/definitions/department 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/department responses: 200: description: The created resource schema: #/definitions/department 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/department 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/department/{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/department responses: 200: description: Ok schema: #/definitions/department 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/department responses: 200: description: Ok schema: #/definitions/department 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/department 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 /basic_records/entities/department/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/department responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/contactOrigin: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contactOrigin responses: 200: description: The created resource schema: #/definitions/contactOrigin 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/contactOrigin responses: 200: description: The created resource schema: #/definitions/contactOrigin 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/contactOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/contactOrigin/{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/contactOrigin responses: 200: description: Ok schema: #/definitions/contactOrigin 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/contactOrigin responses: 200: description: Ok schema: #/definitions/contactOrigin 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/contactOrigin 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 /basic_records/entities/contactOrigin/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contactOrigin responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/occurrenceType responses: 200: description: The created resource schema: #/definitions/occurrenceType 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/occurrenceType responses: 200: description: The created resource schema: #/definitions/occurrenceType 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/occurrenceType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceType/{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/occurrenceType responses: 200: description: Ok schema: #/definitions/occurrenceType 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/occurrenceType responses: 200: description: Ok schema: #/definitions/occurrenceType 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/occurrenceType 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 /basic_records/entities/occurrenceType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/occurrenceType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceSubtype: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/occurrenceSubtype responses: 200: description: The created resource schema: #/definitions/occurrenceSubtype 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/occurrenceSubtype responses: 200: description: The created resource schema: #/definitions/occurrenceSubtype 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/occurrenceSubtype 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceSubtype/{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/occurrenceSubtype responses: 200: description: Ok schema: #/definitions/occurrenceSubtype 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/occurrenceSubtype responses: 200: description: Ok schema: #/definitions/occurrenceSubtype 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/occurrenceSubtype 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 /basic_records/entities/occurrenceSubtype/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/occurrenceSubtype responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/personType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personType responses: 200: description: The created resource schema: #/definitions/personType 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/personType responses: 200: description: The created resource schema: #/definitions/personType 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/personType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/personType/{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/personType responses: 200: description: Ok schema: #/definitions/personType 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/personType responses: 200: description: Ok schema: #/definitions/personType 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/personType 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 /basic_records/entities/personType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceStatus: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/occurrenceStatus responses: 200: description: The created resource schema: #/definitions/occurrenceStatus 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/occurrenceStatus responses: 200: description: The created resource schema: #/definitions/occurrenceStatus 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/occurrenceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceStatus/{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/occurrenceStatus responses: 200: description: Ok schema: #/definitions/occurrenceStatus 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/occurrenceStatus responses: 200: description: Ok schema: #/definitions/occurrenceStatus 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/occurrenceStatus 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 /basic_records/entities/occurrenceStatus/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/occurrenceStatus responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceOrigin: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/occurrenceOrigin responses: 200: description: The created resource schema: #/definitions/occurrenceOrigin 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/occurrenceOrigin responses: 200: description: The created resource schema: #/definitions/occurrenceOrigin 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/occurrenceOrigin 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/occurrenceOrigin/{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/occurrenceOrigin responses: 200: description: Ok schema: #/definitions/occurrenceOrigin 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/occurrenceOrigin responses: 200: description: Ok schema: #/definitions/occurrenceOrigin 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/occurrenceOrigin 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 /basic_records/entities/occurrenceOrigin/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/occurrenceOrigin responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/regionCity: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/regionCity responses: 200: description: The created resource schema: #/definitions/regionCity 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/regionCity responses: 200: description: The created resource schema: #/definitions/regionCity 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/regionCity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /basic_records/entities/regionCity/{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/regionCity responses: 200: description: Ok schema: #/definitions/regionCity 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/regionCity responses: 200: description: Ok schema: #/definitions/regionCity 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/regionCity 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 /basic_records/entities/regionCity/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/regionCity responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthCheckStatusEnum: description: Up or down type: string enum: – UP – DOWN enumEventsBasicRecords: description: Nome de todos os eventos do basic records type: string enum: – ACTIVITY_BRANCHES_CREATED – ACTIVITY_BRANCHES_UPDATED – COMPANY_GROUPS_CREATED – COMPANY_GROUPS_UPDATED – PRICE_TABLE_CREATED – PRICE_TABLE_UPDATED – CARRIER_CREATED – CARRIER_UPDATED – PAYMENT_TERMS_CREATED – PAYMENT_TERMS_UPDATED – OPPORTUNITY_TYPE_CREATED – OPPORTUNITY_TYPE_UPDATED – PAYMENT_TYPE_CREATED – PAYMENT_TYPE_UPDATED – DEPOSIT_CREATED – DEPOSIT_UPDATED – PRODUCT_CREATED – PRODUCT_UPDATED – SERVICE_CREATED – SERVICE_UPDATED endpointsEnum: description: Nome de todos os endpoints type: string enum: – MEASUREMENT_UNIT – USER_GROUPS – USER_GROUP_LINKS – PRODUCT – SERVICE – OPPORTUNITY_TYPE – PAYMENT_TERMS – PAYMENT_TYPE – PRICE_TABLE – CARRIER – COUNTRIES – COMPANY_BRANCH – COMPANY – FILIAL – CITIES 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 companyBranchRecord: description: Empresa filial da definição da conta type: object properties: id: type: integer format: int64 description: Identificador company: type: object allOf: – #/definitions/companyRecord description: Objeto da Empresa branch: type: object allOf: – #/definitions/branchRecord description: Objeto da filial da Empresa companyRecord: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM idErp: 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 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 idErp: 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 stateRegistration: type: string description: Inscrição Estadual municipalRegistration: type: string description: Inscrição Municipal email: type: string description: Email telephone: type: string description: Telefone nit: type: string description: NIT productCategoryRecord: description: Categorias do produto type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa unitMeasurementRecord: description: Unidade de medida type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome acronym: type: string description: Sigla active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados serviceCategoryRecord: description: Categoria de serviço type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa activityBranchesRecord: description: Ramo de atividade type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do ramo de atividade active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados companyGroupsRecord: description: Grupo de empresas type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/companyRecord description: Empresa active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados priceTableRecord: description: Tabela de preço type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo da tabela de preços companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string format: byte description: Campos customizados carrierRecord: description: Transportadora type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo da transportadora companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se a transportadora está ativa no sistema default: true customFields: type: string format: byte description: Campos customizados paymentTermsRecord: description: Prazo de pagamento type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do prazo de pagamento company: type: object allOf: – #/definitions/companyRecord description: Empresa active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados opportunityTypeRecord: description: Tipo de oportunidade type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do tipo de oportunidade companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema default: true note: type: string description: Observação customFields: type: string format: byte description: Campos customizados paymentTypeRecord: description: Tipo de pagamento type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do tipo de pagamento companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema default: true customFields: type: string format: byte description: Campos customizados depositRecord: description: Depósito type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Descritivo do depósito companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Indicador se o depósito está ativa no sistema default: true customFields: type: string format: byte description: Campos customizados productRecord: description: Produto type: object properties: id: type: integer format: int64 description: Identificador company: type: object allOf: – #/definitions/companyRecord description: Empresa name: type: string description: Descritivo do produto partNumber: type: string description: Identificador do produto no sistema terceiro derivationPartNumber: type: string description: Identificador da derivação do produto no sistema terceiro derivationName: type: string description: Descritivo da derivação do produto productCategory: type: object allOf: – #/definitions/productCategoryRecord description: Categoria do produto unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida active: type: boolean description: Indicador se o produto está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo default: true salePrice: type: number format: double description: Valor de venda do produto maximum: 999999999999999.999999 maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 defaultQuantity: type: number format: double description: Quantidade padrão do produto no pedido maximum: 99999999999999.999999 correctionFactor: type: number format: double description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão maximum: 999.99 saleType: type: integer format: int64 description: Informativo do tipo de venda padrão para o produto ipi: type: number format: double description: Porcentagem de IPI, somente descritivo maximum: 99999999.99 icms: type: number format: double description: Porcentagem de ICMS, somente descritivo maximum: 99999999.99 weight: type: number format: double description: Peso unitário do produto maximum: 999999999999.99999 note: type: string description: Obervações do tipo de oportunidade customFields: type: string format: byte description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma ncm: type: string description: NCM serviceRecord: description: Serviço type: object required: – serviceCategory properties: id: type: integer format: int64 description: Identificador company: type: object allOf: – #/definitions/companyRecord description: Empresa partNumber: type: string description: Identificador do produto no sistema terceiro name: type: string description: Descritivo do serviço serviceCategory: type: object allOf: – #/definitions/serviceCategoryRecord description: Categoria do serviço unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida active: type: boolean description: Indicador se o serviço está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo default: true salePrice: type: number format: double description: Valor de venda do serviço maximum: 999999999999999.999999 maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 note: type: string description: Obervações do tipo de oportunidade customFields: type: string format: byte description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma stateRecord: description: Estado type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome initials: type: string description: Iniciais active: type: boolean description: Ativo default: true 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: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados code: type: integer format: int64 description: Código idErp: type: string description: Id no sistema terceiro addressRecord: description: Endereço type: object properties: id: type: integer format: int64 description: Identificador active: type: boolean description: Ativo default: true name: type: string description: Nome address: type: string description: Endereco number: type: string description: Número complement: type: string description: Complemento district: type: string description: Bairro cep: type: string description: Código postal Brasil latitude: type: number format: double description: Latitude maximum: 9999999999.999999 longitude: type: number format: double description: Longitude maximum: 9999999999.999999 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: Código postal exterior addressTypeRecord: description: Record referente ao tipo do endereço type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial cityRecord: description: Record referente a cidade type: object properties: id: type: integer format: int64 description: Identificador idIbge: type: string description: Código IBGE name: type: string description: Nome active: type: boolean description: Ativo default: true dddCode: type: string description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População estimada consumptionPotencial: type: number format: double description: Potêncial de consumo maximum: 9999999999999.999 pib: type: number format: double description: PIB maximum: 9999999999999.999 customFields: type: string format: byte description: Campos customizados state: type: object allOf: – #/definitions/stateRecord description: Estado country: type: object allOf: – #/definitions/countryRecord description: País idErp: type: string description: Id no sistema terceiro groupRecord: description: Grupo type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa idErp: type: string description: ID no sistema terceiro userRecord: description: Usuário type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome functionDescription: type: string description: Descrição da função type: type: integer format: int64 description: Tipo receivesOpportunityHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da oportunidade default: false receivesOccurrenceHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da ocorrência default: false photo: type: string description: Foto email: type: string description: E-mail telephone: type: string description: Telefone cellphone: type: string description: Celular birthday: type: string format: date-time description: Aniversário active: type: boolean description: Ativo default: false visibleCombo: type: boolean description: Se o combo é visível default: false language: type: integer format: int64 description: Idioma legacyId: type: integer format: int64 description: ID no legado department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função subordinateOf: type: object allOf: – #/definitions/userRecord description: Superior userCompanyBranches: type: array items: type: object allOf: – #/definitions/userCompanyBranchRecord description: Empresa/filiais do usuário ids: type: array items: type: object allOf: – #/definitions/idRecord description: IDs groups: type: array items: type: object allOf: – #/definitions/userGroupRecord description: Grupos departmentRecord: description: Departamento type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome active: type: boolean description: Ativo default: true usesOccurrence: type: boolean description: Usa ocorrência default: false customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial functionRecord: description: Função type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados idErp: type: string description: Id no sistema terceiro company: type: object allOf: – #/definitions/companyRecord description: Empresa userCompanyBranchRecord: description: Empresa/filiais do usuário type: object properties: id: type: integer format: int64 description: ID standardCompanyBranch: type: boolean description: Empresa filial padrão user: type: object allOf: – #/definitions/userRecord description: Usuário companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial idRecord: description: IDs type: object properties: id: type: integer format: int64 description: ID code: type: string description: Código description: type: string description: Descrição userGroupRecord: description: Grupo type: object properties: id: type: integer format: int64 description: ID notifiesOccurrence: type: integer format: int64 description: Notifica ocorrência user: type: object allOf: – #/definitions/userRecord description: Usuário group: type: object allOf: – #/definitions/groupRecord description: Grupo occurrenceTypeRecord: description: Tipo de ocorrência type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial sla: type: integer format: int64 description: SLA customFields: type: string format: byte description: Campos customizados regionRecord: description: Microrregião type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa/filial crmFile: description: Arquivo type: object properties: id: type: integer format: int64 description: ID companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial uploadType: type: integer format: int64 description: Tipo de upload fileName: type: string description: Nome do arquivo folder: type: string description: Pasta destination: type: string description: Destino size: type: number format: double description: Tamanho fieldName: type: string description: Nome do campo hash: type: string description: Hash activityBranches: description: Entidade fachada Ramo de atividade type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa companyGroups: description: Entidade fachada Grupo de empresa type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa priceTable: description: Entidade fachada Tabela de preço type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome active: type: boolean description: Se o registro está ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial actionType: description: Entidade fachada Tipo de Ação type: object properties: id: type: integer format: int64 description: ID no CRM companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Se o registro está ativo default: true strategicAction: type: boolean description: Campo Ação Estratégica usesOpportunity: type: boolean description: Campo Usa Oportunidade usesOccurency: type: boolean description: Campo Usa Ocorrência usesContract: type: boolean description: Campo Usa Contract usesEvent: type: boolean description: Campo Usa Evento customFields: type: string format: byte description: Campos customizados carrier: description: Entidade fachada Transportadora type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial paymentTerms: description: Entidade fachada Prazo de pagamento type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true generateInstallments: type: boolean description: Gerar parcela quantityInstallments: type: integer format: int64 description: Quantidade parcelas accrualInstallments: type: string description: Acréscimo Parcelas maximum: 99999999999999.99 rounding: type: integer format: int64 description: Arredondamento customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa opportunityType: description: Entidade fachada Tipo de oportunidade type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Se o registro está ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial paymentType: description: Entidade fachada Tipo de pagamento type: object properties: id: type: integer format: int64 description: ID do CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome addedValue: type: number format: double description: Valor do acréscimo maximum: 99999999999999.99 active: type: boolean description: Se está ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial deposit: description: Entidade fachada Depósito type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Identificador no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial product: description: Entidade fachada Produto type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome derivationName: type: string description: Nome derivado partNumber: type: string description: Identificador no sistema terceiro ncm: type: string description: NCM derivationPartNumber: type: string description: Identificador da derivação do produto no sistema terceiro active: type: boolean description: Indicador se ativo no sistema. default: true salePrice: type: string description: Valor de venda maximum: 999999999999999.999999 maximumDiscount: type: string description: Desconto percentual unitário máximo maximum: 99999.99 defaultQuantity: type: string description: Quantidade padrão do produto no pedido maximum: 99999999999999.999999 correctionFactor: type: string description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão maximum: 999.99 saleType: type: boolean description: É do tipo venda default: false ipi: type: string description: Porcentagem de IPI maximum: 99999999.99 icms: type: string description: Porcentagem de ICMS maximum: 99999999.99 weight: type: string description: Peso unitário maximum: 999999999999.99999 coinId: type: integer format: int64 description: Moeda Id rate: type: string description: Taxa maximum: 99999999999999.999999 note: type: string description: Obervações origin: type: string description: Origem customFields: type: string format: byte description: Campos customizados unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida productCategory: type: object allOf: – #/definitions/productCategoryRecord description: Categoria company: type: object allOf: – #/definitions/companyRecord description: Empresa photo: type: object allOf: – #/definitions/crmFile description: Foto file: type: object allOf: – #/definitions/crmFile description: Arquivo service: description: Entidade fachada Serviço type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome partNumber: type: string description: Identificador no sistema terceiro ncm: type: string description: NCM active: type: boolean description: Ativo default: true salePrice: type: number format: double description: Valor de venda maximum: 999999999999999.999999 note: type: string description: Obervação maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 customFields: type: string format: byte description: Campos customizados serviceCategory: type: object allOf: – #/definitions/serviceCategoryRecord description: Categoria unitMeasurement: type: object allOf: – #/definitions/unitMeasurementRecord description: Unidade de Medida company: type: object allOf: – #/definitions/companyRecord description: Empresa accountType: description: Entidade fachada Tipo da conta type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo icon: type: string description: Ícone color: type: string description: Cor do ícone requiredFields: type: string description: Campos obrigatórios customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa cities: description: Entidade fachada Cidade type: object properties: id: type: integer format: int64 description: Identificador ibgeCode: type: string description: Código IBGE name: type: string description: Nome active: type: boolean description: Ativo default: true dddCode: type: string description: Código DDD population: type: integer format: int64 description: População estimatedPopulation: type: integer format: int64 description: População estimada consumptionPotencial: type: number format: double description: Potêncial de consumo maximum: 9999999999999.999 pib: type: number format: double description: PIB maximum: 9999999999999.999 customFields: type: string format: byte description: Campos customizados state: type: object allOf: – #/definitions/stateRecord description: Estado country: type: object allOf: – #/definitions/countryRecord description: País idErp: type: string description: Id no sistema terceiro states: description: Entidade fachada Estado type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome initials: type: string description: Sigla active: type: boolean description: Ativo default: true 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 countries: description: Entidade fachada País type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados code: type: integer format: int64 description: Código idErp: type: string description: Id no sistema terceiro accountOrigins: description: Entidade fachada Origem da Conta type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Name active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa accountStatus: description: Entidade fachada Status da Conta type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome 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 addressTypes: description: Entidade fachada Tipo do Endereço type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial appointmentCategories: description: Entidade fachada Categorias de Compromissos type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados businessTypes: description: Entidade fachada Modalidade de Negócio type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome note: type: string description: Observação active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial companySize: description: Entidade fachada Porte da Empresa type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados inactivationReason: description: Entidade fachada Motivo de Inativação type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial eventTypes: description: Entidade fachada Tipos de Evento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial eventsStatus: description: Entidade fachada Status de Evento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true icon: type: string description: Ícone customFields: type: string format: byte description: Campos customizados interestAreas: description: Entidade fachada Áreas de Interesse type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa locations: description: Entidade fachada Localizações type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome note: type: string description: Observação active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados address: type: object allOf: – #/definitions/addressRecord description: Endereço lossReasons: description: Entidade fachada Motivo da Perda type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial opportunityOrigins: description: Entidade fachada Origem de Oportunidade type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial followType: description: Entidade fachada referente aos tipos de Follow-Ups type: object properties: id: type: integer format: int64 description: Id de identificação no CRM name: type: string description: Nome slaHours: type: integer format: int64 description: Tempo em horas de SLA para finalização do Follow-Up active: type: boolean description: Ativo default: true module: type: integer format: int64 description: Módulo onde será exibido essa opção de follow. 1 – Oportunidade | 2 – Ocorrência | 3 – Contrato\n | 4 – Tarefa | 5 – Compromisso | 6 – Evento customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial productCategories: description: Entidade fachada Categoria de Produto type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa ratings: description: Entidade fachada Avaliações type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome icon: type: string description: Ícone active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados regions: description: Entidade fachada Regiões type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: integer format: int64 description: Ativo customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial salesReasons: description: Entidade fachada Motivo de Fechamento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial relationshipTypes: description: Entidade fachada Tipo de Relacionamento type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados serviceCategories: description: Entidade fachada Categoria de Serviço type: object properties: id: type: integer format: int64 description: Identificador idErp: type: string description: Id de identificação no sistema terceiro name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa measurementUnit: description: Entidade fachada Unidade de Medida type: object properties: id: type: integer format: int64 description: Identificador name: type: string description: Nome initials: type: string description: Iniciais active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados userGroups: description: Entidade fachada Grupo de Usuários type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome description: type: string description: Descrição active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa idErp: type: string description: ID no sistema terceiro user: description: Entidade fachado Usuário type: object properties: id: type: integer format: int64 description: ID no CRM idErp: type: string description: ID no sistema terceiro name: type: string description: Nome lastName: type: string description: Sobrenome functionDescription: type: string description: Descrição da função type: type: integer format: int64 description: Tipo receivesOpportunityHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da oportunidade default: false receivesOccurrenceHierarchyNotification: type: boolean description: Se recebe notificação de hierarquia da ocorrência default: false photo: type: string description: Foto email: type: string description: E-mail telephone: type: string description: Telefone cellphone: type: string description: Celular birthday: type: string format: date-time description: Aniversário active: type: boolean description: Ativo default: false visibleCombo: type: boolean description: Se o combo é visível default: false language: type: integer format: int64 description: Idioma legacyId: type: integer format: int64 description: ID no legado department: type: object allOf: – #/definitions/departmentRecord description: Departamento function: type: object allOf: – #/definitions/functionRecord description: Função subordinateOf: type: object allOf: – #/definitions/userRecord description: Subordinado De userCompanyBranches: type: array items: type: object allOf: – #/definitions/userCompanyBranchRecord description: Empresa filial ids: type: array items: type: object allOf: – #/definitions/idRecord description: IDs groups: type: array items: type: object allOf: – #/definitions/userGroupRecord description: Grupos companyBranch: description: Entidade fachada Empresa filial type: object properties: id: type: integer format: int64 description: ID no CRM company: type: object allOf: – #/definitions/companyRecord description: Empresa branch: type: object allOf: – #/definitions/branchRecord description: Filial company: description: Entidade fachada 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 fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ address: type: string description: Endereço district: type: string description: Bairro cep: type: string description: Código postal Brasileiro stateRegistration: type: string description: Inscrição Estadual telephone: type: string description: Telefone municipalRegistration: type: string description: Inscrição Municipal url: type: string description: URL email: type: string description: Email responsible: type: string description: Responsável databaseName: type: string description: Nome da base de dados accessUrl: type: string description: URL de acesso city: type: object allOf: – #/definitions/cityRecord description: Cidade nit: type: string description: NIT branch: description: Entidade fachada Filial 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 address: type: string description: Endereço district: type: string description: Bairro cep: type: string description: Código postal Brasileiro stateRegistration: type: string description: Inscrição Estadual telephone: type: string description: Telefone municipalRegistration: type: string description: Inscrição Municipal url: type: string description: URL email: type: string description: Email responsible: type: string description: Responsável headquarters: type: integer format: int64 description: Matriz duplicateInformation: type: integer format: int64 description: Duplicar Informações duplicateAffiliateCompanyInformation: type: integer format: int64 description: Duplicar Informações Empresa Filial duplicateCompanyInformation: type: integer format: int64 description: Duplicar Informações Empresa city: type: object allOf: – #/definitions/cityRecord description: Cidade nit: type: string description: NIT function: description: Entidade fachada Função type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados idErp: type: string description: ID no sistema terceiro company: type: object allOf: – #/definitions/companyRecord description: Empresa department: description: Entidade fachada Departamento type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true useOccurrence: type: boolean description: Se o departamento é usado na ocorrência default: false customFields: type: string format: byte description: Campos customizados companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial contactOrigin: description: Entidade fachada Origem do Contato type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Ativo default: true customFields: type: string format: byte description: Campos customizados company: type: object allOf: – #/definitions/companyRecord description: Empresa occurrenceType: description: Entidade fachada Tipo de Ocorrência type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial sla: type: integer format: int64 description: SLA customFields: type: string format: byte description: Campos customizados occurrenceSubtype: description: Entidade fachada Subtipo de Ocorrência type: object properties: id: type: integer format: int64 description: ID no CRM name: type: string description: Nome active: type: boolean description: Se está ativo companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial sla: type: integer format: int64 description: SLA occurrenceType: type: object allOf: – #/definitions/occurrenceTypeRecord description: Tipo de ocorrência customFields: type: string format: byte description: Campos customizados personType: description: Entidade fachada Tipo de Pessoa type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome icon: type: string description: Ìcone active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados occurrenceStatus: description: Entidade fachada Status da Ocorrência type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial displayOrder: type: integer format: int64 description: Ordem de exibição defaultColor: type: string description: Cor padrão occurrenceStarts: type: boolean description: Se inicia a ocorrência occurrenceEnds: type: boolean description: Se encerra a ocorrência active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados occurrenceOrigin: description: Entidade fachada Origem da Ocorrência type: object properties: id: type: integer format: int64 description: ID name: type: string description: Nome companyBranch: type: object allOf: – #/definitions/companyBranchRecord description: Empresa filial active: type: boolean description: Se está ativo customFields: type: string format: byte description: Campos customizados regionCity: description: Entidade fachada Microrregião Cidade type: object properties: id: type: integer format: int64 description: ID city: type: object allOf: – #/definitions/cityRecord description: Cidade microRegion: type: object allOf: – #/definitions/regionRecord description: Microrregião 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