openapi: 3.0.3 info: title: EPIC description: '' version: 1.0.0 servers: - url: 'http://localhost' paths: /api/v1/dashboard: get: summary: 'Retrieve various metrics for the admin dashboard (Stability Score: 0.1)' operationId: retrieveVariousMetricsForTheAdminDashboardStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Admin Dashboard' '/api/v1/salary-warnings/{salaryWarningId}': get: summary: 'Fetch a Salary warning by its ID' operationId: fetchASalaryWarningByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryWarning [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryWarning [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: salaryWarningId description: '' example: hic required: true schema: type: string /api/v1/salary-warnings: get: summary: 'Fetch a list of Salary warnings with pagination' operationId: fetchAListOfSalaryWarningsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/salary-warnings/search: post: summary: 'Fetch a list of Salary warnings based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfSalaryWarningsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: confirmedBy operator: '=' value: value - field: salaryRuleId operator: '=' value: value - field: employeeId operator: '=' value: value - field: salaryPeriod operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/company-integrations: post: summary: 'Create a new Company integration' operationId: createANewCompanyIntegration description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: eos companyId: type: string description: '' example: sit settings: type: object description: '' example: null properties: { } required: - externalIntegrationId - companyId get: summary: 'Fetch a list of Company integrations with pagination (Stability Score: 0.5)' operationId: fetchAListOfCompanyIntegrationsWithPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-integrations/batch: post: summary: 'Batch create new Company integrations' operationId: batchCreateNewCompanyIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: id companyId: type: string description: '' example: laborum settings: type: object description: '' example: null properties: { } required: - externalIntegrationId - companyId patch: summary: 'Batch update Company integrations' operationId: batchUpdateCompanyIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: null companyId: type: string description: '' example: null settings: type: object description: '' example: null properties: { } delete: summary: 'Batch delete Company integrations by their IDs' operationId: batchDeleteCompanyIntegrationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - sunt items: type: string '/api/v1/company-integrations/{companyIntegrationId}': get: summary: 'Fetch a Company integration by its ID' operationId: fetchACompanyIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company integration by its ID (Stability Score: 0.5)' operationId: updateACompanyIntegrationByItsIDStabilityScore05 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: null companyId: type: string description: '' example: null settings: type: object description: '' example: null properties: { } delete: summary: 'Delete a Company integration by its ID (Stability Score: 0.5)' operationId: deleteACompanyIntegrationByItsIDStabilityScore05 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyIntegrationId description: '' example: iusto required: true schema: type: string /api/v1/company-integrations/search: post: summary: 'Fetch a list of Company integrations based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfCompanyIntegrationsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: externalIntegrationId operator: '=' value: value - field: companyId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/integration-types: get: summary: 'Fetch a list of Integration types with pagination (Stability Score: 0.5)' operationId: fetchAListOfIntegrationTypesWithPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/integration-types/search: post: summary: 'Fetch a list of Integration types based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)' operationId: fetchAListOfIntegrationTypesBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore05 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/users: get: summary: 'Fetch a list of Users with pagination' operationId: fetchAListOfUsersWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' post: summary: '' operationId: postApiV1Users description: '' parameters: [] responses: { } tags: - 'Uncategorized Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: ut email: type: string description: 'Must be a valid email address.' example: bschaefer@example.net required: - name - email /api/v1/users/search: post: summary: 'Fetch a list of Users based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfUsersBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/notifications: get: summary: 'Fetch a list of Notifications with pagination' operationId: fetchAListOfNotificationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/notifications/search: post: summary: 'Fetch a list of Notifications based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfNotificationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: readAt operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/employee-fields: post: summary: 'Create a new Employee field' operationId: createANewEmployeeField description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null parentId: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: false salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: true importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: number enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: 'This field is required when dataType is string.' example: 96.0 minInput: type: number description: 'This field is required when dataType is string.' example: 5.262827656 maxLength: type: number description: '' example: 4857812.8 minLength: type: number description: '' example: 439003.0755778 fieldName: type: string description: 'Must not be greater than 255 characters.' example: fczchmxmqlrpvf combinedFieldIds: type: array description: '' example: - animi items: type: string required: - isShow - fieldName - combinedFieldIds get: summary: 'Fetch a list of Employee fields with pagination' operationId: fetchAListOfEmployeeFieldsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/employee-fields/{employeeFieldId}': get: summary: 'Fetch a Employee field by its ID' operationId: fetchAEmployeeFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmployeeField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmployeeField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Employee field by its ID' operationId: updateAEmployeeFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmployeeField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmployeeField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null parentId: type: string description: '' example: null companyId: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: true fieldName: type: string description: '' example: null fieldType: type: string description: '' example: checkbox enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: string enum: - string - number - date - boolean maxInput: type: number description: '' example: 6239.0 minInput: type: number description: '' example: 87812023.0 maxLength: type: number description: '' example: 4819160.8337844 minLength: type: number description: '' example: 308791.90912342 combinedFieldIds: type: array description: '' example: - consequatur items: type: string required: - combinedFieldIds delete: summary: 'Delete a Employee field by its ID' operationId: deleteAEmployeeFieldByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: combinedFields responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmployeeField [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmployeeField [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: employeeFieldId description: '' example: est required: true schema: type: string /api/v1/log-entities: get: summary: 'Fetch a list of Log entities with pagination' operationId: fetchAListOfLogEntitiesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/log-entities/search: post: summary: 'Fetch a list of Log entities based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfLogEntitiesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: entity operator: '=' value: value - field: entityId operator: '=' value: value - field: action operator: '=' value: value - field: createdBy operator: '=' value: value - field: createdAt operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/variable-types: post: summary: 'Create a new Variable type' operationId: createANewVariableType description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Eius maiores quod et dolor qui occaecati.' required: - description get: summary: 'Fetch a list of Variable types with pagination' operationId: fetchAListOfVariableTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/variable-types/batch: post: summary: 'Batch create new Variable types' operationId: batchCreateNewVariableTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Voluptas et sed consectetur itaque placeat sed id.' required: - description patch: summary: 'Batch update Variable types' operationId: batchUpdateVariableTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Molestiae voluptas accusamus inventore id.' delete: summary: 'Batch delete Variable types by their IDs' operationId: batchDeleteVariableTypesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - et items: type: string '/api/v1/variable-types/{variableTypeId}': get: summary: 'Fetch a Variable type by its ID' operationId: fetchAVariableTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'VariableType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'VariableType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Variable type by its ID' operationId: updateAVariableTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'VariableType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'VariableType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Non repellendus quas autem dolore omnis.' delete: summary: 'Delete a Variable type by its ID' operationId: deleteAVariableTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'VariableType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'VariableType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: variableTypeId description: '' example: quo required: true schema: type: string /api/v1/variable-types/search: post: summary: 'Fetch a list of Variable types based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfVariableTypesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: description operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/salary-rules: post: summary: 'Create a new Salary rule' operationId: createANewSalaryRule description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: fuga selections: type: object description: '' example: null properties: { } warning: type: string description: '' example: quae solutionDescription: type: string description: '' example: molestiae ruleExpression: type: array description: 'Must have at least 1 items.' example: - [] items: type: object properties: type: type: string description: '' example: logical_operator enum: - comparison_operator - logical_operator - logical - logical_missing - logical_diff payCodeIds: type: array description: '' example: - 13 items: type: integer previous_periods: type: integer description: 'This field is required when ruleExpression.*.type is logical_diff. Must be between 1 and 12.' example: 1 diff_type: type: string description: 'This field is required when ruleExpression.*.type is logical_diff.' example: real enum: - real - percentage conditions: type: object description: 'This field is required when ruleExpression.*.type is logical or logical_diff. Must have at least 1 items.' example: null properties: { } required: - type required: - warning - solutionDescription - ruleExpression get: summary: 'Fetch a list of Salary rules with pagination' operationId: fetchAListOfSalaryRulesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' '/api/v1/salary-rules/{salaryRuleId}': get: summary: 'Fetch a Salary rule by its ID' operationId: fetchASalaryRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Salary rule by its ID' operationId: updateASalaryRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: null warning: type: string description: '' example: quia selections: type: object description: '' example: null properties: { } solutionDescription: type: string description: '' example: necessitatibus ruleExpression: type: array description: 'Must have at least 1 items.' example: - [] items: type: object properties: type: type: string description: '' example: logical_operator enum: - comparison_operator - logical_operator - logical - logical_missing - logical_diff payCodeIds: type: array description: '' example: - earum items: type: string previous_periods: type: integer description: 'This field is required when ruleExpression.*.type is logical_diff. Must be between 1 and 12.' example: 1 diff_type: type: string description: 'This field is required when ruleExpression.*.type is logical_diff.' example: real enum: - real - percentage conditions: type: object description: 'This field is required when ruleExpression.*.type is logical or logical_diff. Must have at least 1 items.' example: null properties: { } required: - type required: - ruleExpression delete: summary: 'Delete a Salary rule by its ID' operationId: deleteASalaryRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'SalaryRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'SalaryRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: salaryRuleId description: '' example: veniam required: true schema: type: string /api/v1/salary-rules/search: post: summary: 'Fetch a list of Salary rules based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfSalaryRulesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/org-integrations-mappings: post: summary: 'Create a new Org integrations mapping' operationId: createANewOrgIntegrationsMapping description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: labore organizationId: type: string description: '' example: unde notes: type: string description: '' example: deserunt status: type: string description: '' example: inactive enum: - active - inactive required: - externalIntegrationId - organizationId - notes - status get: summary: 'Fetch a list of Org integrations mappings with pagination' operationId: fetchAListOfOrgIntegrationsMappingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/org-integrations-mappings/batch: post: summary: 'Batch create new Org integrations mappings' operationId: batchCreateNewOrgIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: quasi organizationId: type: string description: '' example: aut notes: type: string description: '' example: quia status: type: string description: '' example: active enum: - active - inactive required: - externalIntegrationId - organizationId - notes - status patch: summary: 'Batch update Org integrations mappings' operationId: batchUpdateOrgIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null notes: type: string description: '' example: sit status: type: string description: '' example: inactive enum: - active - inactive delete: summary: 'Batch delete Org integrations mappings by their IDs' operationId: batchDeleteOrgIntegrationsMappingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - eum items: type: string '/api/v1/org-integrations-mappings/{orgIntegrationsMappingId}': get: summary: 'Fetch a Org integrations mapping by its ID' operationId: fetchAOrgIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' patch: summary: 'Update a Org integrations mapping by its ID' operationId: updateAOrgIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null notes: type: string description: '' example: magnam status: type: string description: '' example: inactive enum: - active - inactive delete: summary: 'Delete a Org integrations mapping by its ID' operationId: deleteAOrgIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' parameters: - in: path name: orgIntegrationsMappingId description: '' example: ea required: true schema: type: string /api/v1/org-integrations-mappings/search: post: summary: 'Fetch a list of Org integrations mappings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfOrgIntegrationsMappingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'externalIntegration,organization' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: externalIntegrationId operator: '=' value: value - field: organizationId operator: '=' value: value - field: status operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/field-value-matrices: post: summary: 'Create a new Field value matrix' operationId: createANewFieldValueMatrix description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: cupiditate description: type: string description: '' example: 'Ut sed eius dolores rerum reprehenderit doloribus mollitia.' keyFieldValue: type: string description: '' example: est keyFieldId: type: string description: '' example: est matrixFields: type: array description: '' example: null items: type: object properties: fieldId: type: string description: '' example: ab fieldValue: type: string description: '' example: aut required: - fieldId - fieldValue required: - name - description - keyFieldValue - keyFieldId get: summary: 'Fetch a list of Field value matrices with pagination' operationId: fetchAListOfFieldValueMatricesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/field-value-matrices/batch: post: summary: 'Batch create new Field value matrices' operationId: batchCreateNewFieldValueMatrices description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: quae description: type: string description: '' example: 'Quo repellat eveniet pariatur quod perferendis et.' keyFieldValue: type: string description: '' example: ut keyFieldId: type: string description: '' example: labore matrixFields: type: object description: '' example: null properties: { } required: - name - description - keyFieldValue - keyFieldId patch: summary: 'Batch update Field value matrices' operationId: batchUpdateFieldValueMatrices description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: ipsa description: type: string description: '' example: 'Quo qui est quidem aspernatur non repudiandae.' keyFieldValue: type: string description: '' example: at keyFieldId: type: string description: '' example: eligendi matrixFields: type: object description: '' example: null properties: { } delete: summary: 'Batch delete Field value matrices by their IDs' operationId: batchDeleteFieldValueMatricesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - totam items: type: string '/api/v1/field-value-matrices/{fieldValueMatrixId}': get: summary: 'Fetch a Field value matrix by its ID' operationId: fetchAFieldValueMatrixByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FieldValueMatrix [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FieldValueMatrix [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Field value matrix by its ID' operationId: updateAFieldValueMatrixByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FieldValueMatrix [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FieldValueMatrix [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: consectetur description: type: string description: '' example: 'Repellendus at illo eos ut pariatur atque.' keyFieldValue: type: string description: '' example: excepturi keyFieldId: type: string description: '' example: omnis matrixFields: type: array description: '' example: null items: type: object properties: fieldId: type: string description: '' example: vero fieldValue: type: string description: '' example: blanditiis required: - fieldId - fieldValue delete: summary: 'Delete a Field value matrix by its ID' operationId: deleteAFieldValueMatrixByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'FieldValueMatrix [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'FieldValueMatrix [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: fieldValueMatrixId description: '' example: praesentium required: true schema: type: string /api/v1/field-value-matrices/search: post: summary: 'Fetch a list of Field value matrices based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfFieldValueMatricesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: description operator: '=' value: value - field: keyFieldValue operator: '=' value: value - field: keyFieldId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/organizations: post: summary: 'Create a new Organization' operationId: createANewOrganization description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: quod orgNumber: type: string description: '' example: sed required: - name - orgNumber get: summary: 'Fetch a list of Organizations with pagination' operationId: fetchAListOfOrganizationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/organizations/batch: post: summary: 'Batch create new Organizations' operationId: batchCreateNewOrganizations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: unde orgNumber: type: string description: '' example: minus required: - name - orgNumber patch: summary: 'Batch update Organizations' operationId: batchUpdateOrganizations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: et orgNumber: type: string description: '' example: ut delete: summary: 'Batch delete Organizations by their IDs' operationId: batchDeleteOrganizationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - vitae items: type: string '/api/v1/organizations/{organizationId}': get: summary: 'Fetch a Organization by its ID' operationId: fetchAOrganizationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Organization [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Organization [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Organization by its ID' operationId: updateAOrganizationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Organization [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Organization [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: quis orgNumber: type: string description: '' example: sit delete: summary: 'Delete a Organization by its ID' operationId: deleteAOrganizationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Organization [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Organization [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: organizationId description: '' example: ut required: true schema: type: string /api/v1/organizations/search: post: summary: 'Fetch a list of Organizations based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfOrganizationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: companies responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: orgNumber operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/menus: post: summary: 'Create a new Menu' operationId: createANewMenu description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: jarclvkqmggqqlhtjfq icon: type: string description: 'Must not be greater than 255 characters.' example: vflz url: type: string description: 'Must not be greater than 255 characters.' example: 'http://yundt.com/magni-excepturi-voluptas-voluptatem-omnis' parentId: type: string description: '' example: maxime required: - name - icon - url get: summary: 'Fetch a list of Menus with pagination' operationId: fetchAListOfMenusWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/menus/batch: post: summary: 'Batch create new Menus' operationId: batchCreateNewMenus description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: lhbnysmjmrmviydachmhjdo icon: type: string description: 'Must not be greater than 255 characters.' example: gnpvp url: type: string description: 'Must not be greater than 255 characters.' example: 'http://www.smitham.com/voluptatem-expedita-maxime-et-officiis-non' parentId: type: string description: '' example: quasi required: - name - icon - url patch: summary: 'Batch update Menus' operationId: batchUpdateMenus description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: qobtdzfkkgdkmlmfpxxrywrs icon: type: string description: 'Must not be greater than 255 characters.' example: zkokdkyeraiccuilgewzhfde url: type: string description: 'Must not be greater than 255 characters.' example: 'https://rippin.com/quod-consequatur-voluptatem-omnis-totam-unde-fugiat.html' parentId: type: string description: '' example: beatae delete: summary: 'Batch delete Menus by their IDs' operationId: batchDeleteMenusByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - repellat items: type: string '/api/v1/menus/{menuId}': get: summary: 'Fetch a Menu by its ID' operationId: fetchAMenuByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Menu [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Menu [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Menu by its ID' operationId: updateAMenuByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Menu [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Menu [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: tcdcckhilvxhvas icon: type: string description: 'Must not be greater than 255 characters.' example: ssyav url: type: string description: 'Must not be greater than 255 characters.' example: 'http://goyette.biz/laboriosam-eum-velit-aut-sint-et-eligendi' parentId: type: string description: '' example: quo delete: summary: 'Delete a Menu by its ID' operationId: deleteAMenuByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Menu [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Menu [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: menuId description: '' example: non required: true schema: type: string /api/v1/menus/search: post: summary: 'Fetch a list of Menus based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfMenusBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: parent responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: name operator: '=' value: value - field: icon operator: '=' value: value - field: url operator: '=' value: value - field: parentId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/company-field-maps: post: summary: 'Create a new Company field map' operationId: createANewCompanyFieldMap description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalCompanyFieldId: type: string description: '' example: nemo companyFieldId: type: string description: '' example: amet companyId: type: string description: '' example: incidunt externalIntegrationId: type: string description: '' example: hic required: - externalCompanyFieldId - companyFieldId - externalIntegrationId get: summary: 'Fetch a list of Company field maps with pagination' operationId: fetchAListOfCompanyFieldMapsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-field-maps/batch: post: summary: 'Batch create new Company field maps' operationId: batchCreateNewCompanyFieldMaps description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalCompanyFieldId: type: string description: '' example: similique companyFieldId: type: string description: '' example: dignissimos companyId: type: string description: '' example: architecto externalIntegrationId: type: string description: '' example: ut required: - externalCompanyFieldId - companyFieldId - externalIntegrationId patch: summary: 'Batch update Company field maps' operationId: batchUpdateCompanyFieldMaps description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalCompanyFieldId: type: string description: '' example: deserunt companyFieldId: type: string description: '' example: quasi companyId: type: string description: '' example: omnis externalIntegrationId: type: string description: '' example: blanditiis required: - externalCompanyFieldId - companyFieldId delete: summary: 'Batch delete Company field maps by their IDs' operationId: batchDeleteCompanyFieldMapsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - quidem items: type: string '/api/v1/company-field-maps/{companyFieldMapId}': get: summary: 'Fetch a Company field map by its ID' operationId: fetchACompanyFieldMapByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldMap [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldMap [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company field map by its ID' operationId: updateACompanyFieldMapByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldMap [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldMap [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalCompanyFieldId: type: string description: '' example: sint companyFieldId: type: string description: '' example: aut companyId: type: string description: '' example: unde externalIntegrationId: type: string description: '' example: consequatur required: - externalCompanyFieldId - companyFieldId delete: summary: 'Delete a Company field map by its ID' operationId: deleteACompanyFieldMapByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanyFieldMap [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanyFieldMap [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyFieldMapId description: '' example: quia required: true schema: type: string /api/v1/company-field-maps/search: post: summary: 'Fetch a list of Company field maps based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanyFieldMapsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/pay-code-variables: post: summary: 'Create a new Pay code variable' operationId: createANewPayCodeVariable description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } variableTypeId: type: string description: '' example: quas required: - variableTypeId get: summary: 'Fetch a list of Pay code variables with pagination' operationId: fetchAListOfPayCodeVariablesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-variables/batch: post: summary: 'Batch create new Pay code variables' operationId: batchCreateNewPayCodeVariables description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } variableTypeId: type: string description: '' example: quaerat required: - variableTypeId patch: summary: 'Batch update Pay code variables' operationId: batchUpdatePayCodeVariables description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } variableTypeId: type: string description: '' example: null delete: summary: 'Batch delete Pay code variables by their IDs' operationId: batchDeletePayCodeVariablesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - fugit items: type: string '/api/v1/pay-code-variables/{payCodeVariableId}': get: summary: 'Fetch a Pay code variable by its ID' operationId: fetchAPayCodeVariableByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeVariable [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeVariable [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code variable by its ID' operationId: updateAPayCodeVariableByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeVariable [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeVariable [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } variableTypeId: type: string description: '' example: null delete: summary: 'Delete a Pay code variable by its ID' operationId: deleteAPayCodeVariableByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeVariable [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeVariable [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeVariableId description: '' example: nobis required: true schema: type: string /api/v1/pay-code-variables/search: post: summary: 'Fetch a list of Pay code variables based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeVariablesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: variableType responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: variableTypeId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/pay-code-types: post: summary: 'Create a new Pay code type' operationId: createANewPayCodeType description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: payCodeTypeNumber: type: number description: '' example: 2094130.7694593 translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } required: - payCodeTypeNumber get: summary: 'Fetch a list of Pay code types with pagination' operationId: fetchAListOfPayCodeTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-types/batch: post: summary: 'Batch create new Pay code types' operationId: batchCreateNewPayCodeTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: payCodeTypeNumber: type: number description: '' example: 432167161.36039 translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } required: - payCodeTypeNumber patch: summary: 'Batch update Pay code types' operationId: batchUpdatePayCodeTypes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: payCodeTypeNumber: type: number description: '' example: 568836.37756456 translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } delete: summary: 'Batch delete Pay code types by their IDs' operationId: batchDeletePayCodeTypesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - totam items: type: string '/api/v1/pay-code-types/{payCodeTypeId}': get: summary: 'Fetch a Pay code type by its ID' operationId: fetchAPayCodeTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code type by its ID' operationId: updateAPayCodeTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: payCodeTypeNumber: type: number description: '' example: 301.16458 translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } delete: summary: 'Delete a Pay code type by its ID' operationId: deleteAPayCodeTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeTypeId description: '' example: ea required: true schema: type: string /api/v1/pay-code-types/search: post: summary: 'Fetch a list of Pay code types based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeTypesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: payCodeTypeNumber operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/pay-code-mappings: post: summary: 'Create a new Pay code mapping' operationId: createANewPayCodeMapping description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null properties: { } companyId: type: string description: 'This field is required when organizationId is not present.' example: nisi organizationId: type: string description: 'This field is required when companyId is not present.' example: laboriosam isGlobal: type: boolean description: '' example: true isGroup: type: boolean description: '' example: true mappings: type: array description: '' example: null items: type: string notes: type: string description: '' example: velit required: - isGlobal - isGroup get: summary: 'Fetch a list of Pay code mappings with pagination' operationId: fetchAListOfPayCodeMappingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-mappings/batch: post: summary: 'Batch create new Pay code mappings' operationId: batchCreateNewPayCodeMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null properties: { } companyId: type: string description: 'This field is required when resources.*.organizationId is not present.' example: pariatur organizationId: type: string description: 'This field is required when resources.*.companyId is not present.' example: ea isGlobal: type: boolean description: '' example: true isGroup: type: boolean description: '' example: true mappings: type: object description: '' example: [] properties: { } notes: type: string description: '' example: sint required: - isGlobal - isGroup - mappings patch: summary: 'Batch update Pay code mappings' operationId: batchUpdatePayCodeMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null properties: { } companyId: type: string description: '' example: null organizationId: type: string description: '' example: null isGlobal: type: boolean description: '' example: false isGroup: type: boolean description: '' example: false mappings: type: object description: '' example: null properties: { } notes: type: string description: '' example: et status: type: string description: '' example: active enum: - active - inactive delete: summary: 'Batch delete Pay code mappings by their IDs' operationId: batchDeletePayCodeMappingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - voluptatem items: type: string '/api/v1/pay-code-mappings/{payCodeMappingId}': get: summary: 'Fetch a Pay code mapping by its ID' operationId: fetchAPayCodeMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code mapping by its ID' operationId: updateAPayCodeMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: whiteListedPayCodeIds: type: object description: '' example: null properties: { } companyId: type: string description: '' example: null organizationId: type: string description: '' example: null isGlobal: type: boolean description: '' example: false isGroup: type: boolean description: '' example: false mappings: type: array description: '' example: null items: type: string notes: type: string description: '' example: laboriosam status: type: string description: '' example: inactive enum: - active - inactive delete: summary: 'Delete a Pay code mapping by its ID' operationId: deleteAPayCodeMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeMapping [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeMapping [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeMappingId description: '' example: autem required: true schema: type: string /api/v1/pay-code-mappings/search: post: summary: 'Fetch a list of Pay code mappings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeMappingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: isGlobal operator: '=' value: value - field: isGroup operator: '=' value: value - field: status operator: '=' value: value - field: whiteListedPayCodeIds operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/companies: post: summary: 'Create a new Company' operationId: createANewCompany description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: fields: type: string description: '' example: null companyId: type: string description: '' example: null importedAt: type: string description: '' example: null parentCompanyId: type: string description: '' example: null organizationId: type: string description: '' example: null get: summary: 'Fetch a list of Companies with pagination' operationId: fetchAListOfCompaniesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/companies/batch: post: summary: 'Batch create new Companies' operationId: batchCreateNewCompanies description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: fields: type: string description: '' example: null companyId: type: string description: '' example: null importedAt: type: string description: '' example: null parentCompanyId: type: string description: '' example: null organizationId: type: string description: '' example: null patch: summary: 'Batch update Companies' operationId: batchUpdateCompanies description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: fields: type: string description: '' example: null companyId: type: string description: '' example: null importedAt: type: string description: '' example: null parentCompanyId: type: string description: '' example: null organizationId: type: string description: '' example: null delete: summary: 'Batch delete Companies by their IDs' operationId: batchDeleteCompaniesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - accusamus items: type: string '/api/v1/companies/{companyId}': get: summary: 'Fetch a Company by its ID' operationId: fetchACompanyByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Company [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Company [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company by its ID' operationId: updateACompanyByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Company [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Company [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: fields: type: string description: '' example: null companyId: type: string description: '' example: null importedAt: type: string description: '' example: null parentCompanyId: type: string description: '' example: null organizationId: type: string description: '' example: null delete: summary: 'Delete a Company by its ID' operationId: deleteACompanyByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Company [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Company [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: companyId description: '' example: harum required: true schema: type: string /api/v1/companies/search: post: summary: 'Fetch a list of Companies based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompaniesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'companies,fieldMaps,companyIntegration' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: companyName operator: '=' value: value - field: organisationNumber operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `externalId`.' example: - field: externalId direction: asc - field: companyId direction: asc - field: companyName direction: asc - field: organisationNumber direction: asc /api/v1/company-integrations-mappings: post: summary: 'Create a new Company integrations mapping' operationId: createANewCompanyIntegrationsMapping description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: qui companyId: type: string description: '' example: nesciunt notes: type: string description: '' example: molestiae status: type: string description: '' example: inactive enum: - active - inactive required: - externalIntegrationId - companyId - notes - status get: summary: 'Fetch a list of Company integrations mappings with pagination' operationId: fetchAListOfCompanyIntegrationsMappingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-integrations-mappings/batch: post: summary: 'Batch create new Company integrations mappings' operationId: batchCreateNewCompanyIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: exercitationem companyId: type: string description: '' example: quo notes: type: string description: '' example: magnam status: type: string description: '' example: active enum: - active - inactive required: - externalIntegrationId - companyId - notes - status patch: summary: 'Batch update Company integrations mappings' operationId: batchUpdateCompanyIntegrationsMappings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: externalIntegrationId: type: string description: '' example: null companyId: type: string description: '' example: null notes: type: string description: '' example: placeat status: type: string description: '' example: inactive enum: - active - inactive delete: summary: 'Batch delete Company integrations mappings by their IDs' operationId: batchDeleteCompanyIntegrationsMappingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - et items: type: string '/api/v1/company-integrations-mappings/{companyIntegrationsMappingId}': get: summary: 'Fetch a Company integrations mapping by its ID' operationId: fetchACompanyIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' patch: summary: 'Update a Company integrations mapping by its ID' operationId: updateACompanyIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: externalIntegrationId: type: string description: '' example: null companyId: type: string description: '' example: null notes: type: string description: '' example: vitae status: type: string description: '' example: inactive enum: - active - inactive delete: summary: 'Delete a Company integrations mapping by its ID' operationId: deleteACompanyIntegrationsMappingByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' parameters: - in: path name: companyIntegrationsMappingId description: '' example: voluptates required: true schema: type: string /api/v1/company-integrations-mappings/search: post: summary: 'Fetch a list of Company integrations mappings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanyIntegrationsMappingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: [] sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/company-settings: post: summary: 'Create a new Company settings' operationId: createANewCompanySettings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: defaultLocale: type: string description: '' example: es_PE defaultProfile: type: string description: '' example: tempora activeProfile: type: string description: '' example: voluptatem companyId: type: string description: 'This field is required when organizationId is not present.' example: molestiae organizationId: type: string description: 'This field is required when companyId is not present.' example: non organisationNumber: type: string description: '' example: nisi get: summary: 'Fetch a list of Company settings with pagination' operationId: fetchAListOfCompanySettingsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/company-settings/batch: post: summary: 'Batch create new Company settings' operationId: batchCreateNewCompanySettings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: defaultLocale: type: string description: '' example: dz_BT defaultProfile: type: string description: '' example: maiores activeProfile: type: string description: '' example: officia companyId: type: string description: 'This field is required when resources.*.organizationId is not present.' example: numquam organizationId: type: string description: 'This field is required when resources.*.companyId is not present.' example: ipsum organisationNumber: type: string description: '' example: modi patch: summary: 'Batch update Company settings' operationId: batchUpdateCompanySettings description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: defaultLocale: type: string description: '' example: uk_UA defaultProfile: type: string description: '' example: aliquid activeProfile: type: string description: '' example: qui companyId: type: string description: '' example: null organizationId: type: string description: '' example: null organisationNumber: type: string description: '' example: et delete: summary: 'Batch delete Company settings by their IDs' operationId: batchDeleteCompanySettingsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - dignissimos items: type: string '/api/v1/company-settings/{companySettingId}': get: summary: 'Fetch a Company settings by its ID' operationId: fetchACompanySettingsByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanySettings [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanySettings [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Company settings by its ID' operationId: updateACompanySettingsByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanySettings [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanySettings [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: defaultLocale: type: string description: '' example: to_TO defaultProfile: type: string description: '' example: quae activeProfile: type: string description: '' example: et companyId: type: string description: '' example: null organizationId: type: string description: '' example: null organisationNumber: type: string description: '' example: sit delete: summary: 'Delete a Company settings by its ID' operationId: deleteACompanySettingsByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'CompanySettings [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'CompanySettings [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: deserunt required: - companyId parameters: - in: path name: companySettingId description: '' example: illo required: true schema: type: string /api/v1/company-settings/search: post: summary: 'Fetch a list of Company settings based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfCompanySettingsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: company required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: company responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: organisationId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/pay-code-groups: post: summary: 'Create a new Pay code group' operationId: createANewPayCodeGroup description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeGroupNumber: type: number description: '' example: 172568.8 payCodeGroupId: type: string description: '' example: null payCodeVariableIds: type: array description: '' example: - quo items: type: string required: - payCodeGroupNumber - payCodeVariableIds get: summary: 'Fetch a list of Pay code groups with pagination' operationId: fetchAListOfPayCodeGroupsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-code-groups/batch: post: summary: 'Batch create new Pay code groups' operationId: batchCreateNewPayCodeGroups description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeGroupNumber: type: number description: '' example: 1886.1 payCodeGroupId: type: string description: '' example: null payCodeVariableIds: type: object description: '' example: [] properties: { } required: - payCodeGroupNumber - payCodeVariableIds patch: summary: 'Batch update Pay code groups' operationId: batchUpdatePayCodeGroups description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeGroupNumber: type: number description: '' example: 1820.0 payCodeGroupId: type: string description: '' example: null payCodeVariableIds: type: object description: '' example: null properties: { } delete: summary: 'Batch delete Pay code groups by their IDs' operationId: batchDeletePayCodeGroupsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - recusandae items: type: string '/api/v1/pay-code-groups/{payCodeGroupId}': get: summary: 'Fetch a Pay code group by its ID' operationId: fetchAPayCodeGroupByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeGroup [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeGroup [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code group by its ID' operationId: updateAPayCodeGroupByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeGroup [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeGroup [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeGroupNumber: type: number description: '' example: 650692960.91821 payCodeGroupId: type: string description: '' example: null payCodeVariableIds: type: array description: '' example: - quia items: type: string delete: summary: 'Delete a Pay code group by its ID' operationId: deleteAPayCodeGroupByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCodeGroup [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCodeGroup [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeGroupId description: '' example: doloribus required: true schema: type: string /api/v1/pay-code-groups/search: post: summary: 'Fetch a list of Pay code groups based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodeGroupsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: payCodeGroupNumber operator: '=' value: value - field: payCodeVariableIds operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/external-integrations: post: summary: 'Create a new External integration' operationId: createANewExternalIntegration description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: integrationName: type: string description: '' example: nemo description: type: string description: '' example: 'Molestiae illum officia rerum cumque iusto voluptatum enim voluptatem.' status: type: string description: '' example: inactive enum: - active - inactive integrationTypeId: type: string description: '' example: et required: - integrationName - description - status - integrationTypeId get: summary: 'Fetch a list of External integrations with pagination' operationId: fetchAListOfExternalIntegrationsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/external-integrations/batch: post: summary: 'Batch create new External integrations' operationId: batchCreateNewExternalIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: integrationName: type: string description: '' example: culpa description: type: string description: '' example: 'Laudantium veritatis incidunt ex deserunt facilis.' status: type: string description: '' example: inactive enum: - active - inactive integrationTypeId: type: string description: '' example: in required: - integrationName - description - status - integrationTypeId patch: summary: 'Batch update External integrations' operationId: batchUpdateExternalIntegrations description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: integrationName: type: string description: '' example: null description: type: string description: '' example: 'Deleniti et voluptas voluptatem voluptatem.' status: type: string description: '' example: inactive enum: - active - inactive integrationTypeId: type: string description: '' example: pariatur delete: summary: 'Batch delete External integrations by their IDs' operationId: batchDeleteExternalIntegrationsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - iste items: type: string '/api/v1/external-integrations/{externalIntegrationId}': get: summary: 'Fetch a External integration by its ID' operationId: fetchAExternalIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a External integration by its ID' operationId: updateAExternalIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: integrationName: type: string description: '' example: null description: type: string description: '' example: 'Nisi sed natus nulla dolores veritatis.' status: type: string description: '' example: inactive enum: - active - inactive integrationTypeId: type: string description: '' example: suscipit delete: summary: 'Delete a External integration by its ID' operationId: deleteAExternalIntegrationByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalIntegration [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalIntegration [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: externalIntegrationId description: '' example: corrupti required: true schema: type: string /api/v1/external-integrations/search: post: summary: 'Fetch a list of External integrations based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfExternalIntegrationsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: integrationName operator: '=' value: value - field: description operator: '=' value: value - field: status operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/pay-codes: post: summary: 'Create a new Pay code' operationId: createANewPayCode description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: adipisci integrationId: type: string description: '' example: molestiae organizationId: type: string description: '' example: autem translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeNumber: type: number description: '' example: 163.0 payCodeId: type: string description: '' example: null payCodeGroupId: type: string description: '' example: est payCodeTypeId: type: string description: '' example: porro payCodeVariableIds: type: array description: '' example: - enim items: type: string required: - payCodeNumber - payCodeGroupId - payCodeTypeId - payCodeVariableIds get: summary: 'Fetch a list of Pay codes with pagination' operationId: fetchAListOfPayCodesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/pay-codes/batch: post: summary: 'Batch create new Pay codes' operationId: batchCreateNewPayCodes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: companyId: type: string description: '' example: dicta integrationId: type: string description: '' example: quod organizationId: type: string description: '' example: qui translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeNumber: type: number description: '' example: 52173309.246247 payCodeId: type: string description: '' example: null payCodeGroupId: type: string description: '' example: aut payCodeTypeId: type: string description: '' example: beatae payCodeVariableIds: type: object description: '' example: [] properties: { } required: - payCodeNumber - payCodeGroupId - payCodeTypeId - payCodeVariableIds patch: summary: 'Batch update Pay codes' operationId: batchUpdatePayCodes description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeNumber: type: number description: '' example: 351.1508298 payCodeId: type: string description: '' example: null payCodeGroupId: type: string description: '' example: voluptas payCodeTypeId: type: string description: '' example: ullam payCodeVariableIds: type: object description: '' example: null properties: { } delete: summary: 'Batch delete Pay codes by their IDs' operationId: batchDeletePayCodesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - dolorum items: type: string '/api/v1/pay-codes/{payCodeId}': get: summary: 'Fetch a Pay code by its ID' operationId: fetchAPayCodeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCode [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCode [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Pay code by its ID' operationId: updateAPayCodeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCode [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCode [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } payCodeNumber: type: number description: '' example: 1526.6751 payCodeId: type: string description: '' example: null payCodeGroupId: type: string description: '' example: repellendus payCodeTypeId: type: string description: '' example: est payCodeVariableIds: type: array description: '' example: - numquam items: type: string delete: summary: 'Delete a Pay code by its ID' operationId: deleteAPayCodeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PayCode [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PayCode [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: payCodeId description: '' example: iure required: true schema: type: string /api/v1/pay-codes/search: post: summary: 'Fetch a list of Pay codes based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPayCodesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'payCodeGroup,payCodeType,payCodeVariables,payCodeVariables.variableType' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: organizationId operator: '=' value: value - field: integrationId operator: '=' value: value - field: companyId operator: '=' value: value - field: payCodeNumber operator: '=' value: value - field: payCodeGroupId operator: '=' value: value - field: payCodeTypeId operator: '=' value: value - field: payCodeVariableIds operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: payCodeNumber direction: asc /api/v1/personal-card-profiles: post: summary: 'Create a new Personal card profile' operationId: createANewPersonalCardProfile description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: omnis tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 654283.881 personalCardProfileTabId: type: string description: '' example: at grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 1.0 personalCardProfileTabGridId: type: string description: '' example: aut fieldGroupId: type: string description: 'This field is required when tabs.*.grids.*.fields is not present.' example: qui fields: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 1791.1527595 fieldId: type: string description: '' example: qui required: - order - fieldId required: - order - personalCardProfileTabGridId - fields required: - order - personalCardProfileTabId - grids translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Qui labore fugit eveniet et distinctio.' isGlobal: type: string description: '' example: eligendi companyId: type: string description: '' example: deserunt required: - name - tabs - description - isGlobal get: summary: 'Fetch a list of Personal card profiles with pagination' operationId: fetchAListOfPersonalCardProfilesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: debitis required: - isGlobal /api/v1/personal-card-profiles/batch: post: summary: 'Batch create new Personal card profiles' operationId: batchCreateNewPersonalCardProfiles description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: name: type: string description: '' example: harum tabs: type: object description: '' example: null properties: { } translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Voluptatem nam et dolores.' isGlobal: type: string description: '' example: iste companyId: type: string description: '' example: voluptatem required: - name - description - isGlobal patch: summary: 'Batch update Personal card profiles' operationId: batchUpdatePersonalCardProfiles description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: debitis translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Sunt qui itaque voluptates necessitatibus.' tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 4489190.5 personalCardProfileTabId: type: string description: '' example: ullam grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 120.5959 personalCardProfileTabGridId: type: string description: '' example: occaecati fieldGroupId: type: string description: '' example: et fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 5.7453899 fieldId: type: string description: '' example: est required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids isGlobal: type: string description: '' example: nisi companyId: type: string description: '' example: enim required: - tabs - isGlobal delete: summary: 'Batch delete Personal card profiles by their IDs' operationId: batchDeletePersonalCardProfilesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: voluptas required: - isGlobal '/api/v1/personal-card-profiles/{personalCardProfileId}': get: summary: 'Fetch a Personal card profile by its ID' operationId: fetchAPersonalCardProfileByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfile [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfile [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: a required: - isGlobal patch: summary: 'Update a Personal card profile by its ID' operationId: updateAPersonalCardProfileByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfile [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfile [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: aliquam translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Corporis et consequuntur excepturi voluptate.' tabs: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 463006583.02 personalCardProfileTabId: type: string description: '' example: suscipit grids: type: array description: '' example: - [] items: type: object properties: order: type: number description: '' example: 40.8 personalCardProfileTabGridId: type: string description: '' example: quo fieldGroupId: type: string description: '' example: nesciunt fields: type: array description: '' example: null items: type: object properties: order: type: number description: '' example: 53.52108 fieldId: type: string description: '' example: excepturi required: - order - fieldId required: - order - personalCardProfileTabGridId required: - order - personalCardProfileTabId - grids isGlobal: type: string description: '' example: fuga companyId: type: string description: '' example: expedita required: - tabs - isGlobal delete: summary: 'Delete a Personal card profile by its ID' operationId: deleteAPersonalCardProfileByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfile [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfile [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: dolor required: - isGlobal parameters: - in: path name: personalCardProfileId description: '' example: quibusdam required: true schema: type: string /api/v1/personal-card-profiles/search: post: summary: 'Fetch a list of Personal card profiles based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPersonalCardProfilesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: isGlobal operator: '=' value: value - field: name operator: '=' value: value - field: description operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/personal-card-profile-tab-grids: post: summary: 'Create a new Personal card profile tab grid' operationId: createANewPersonalCardProfileTabGrid description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: tabId: type: string description: '' example: esse isGlobal: type: boolean description: '' example: false description: type: string description: '' example: 'In qui totam sequi aliquam non.' translations: type: string description: '' example: null fieldGroupId: type: string description: '' example: velit fields: type: array description: '' example: null items: type: object properties: globalFieldId: type: string description: '' example: sunt required: - globalFieldId required: - description get: summary: 'Fetch a list of Personal card profile tab grids with pagination' operationId: fetchAListOfPersonalCardProfileTabGridsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personal-card-profile-tab-grids/batch: post: summary: 'Batch create new Personal card profile tab grids' operationId: batchCreateNewPersonalCardProfileTabGrids description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: tabId: type: string description: '' example: dolores isGlobal: type: boolean description: '' example: false description: type: string description: '' example: 'Molestias repellat rerum porro debitis accusantium et culpa.' translations: type: string description: '' example: null fieldGroupId: type: string description: '' example: aut fields: type: object description: '' example: null properties: { } required: - description patch: summary: 'Batch update Personal card profile tab grids' operationId: batchUpdatePersonalCardProfileTabGrids description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: tabId: type: string description: '' example: null isGlobal: type: boolean description: '' example: true description: type: string description: '' example: 'Quaerat illo sunt dolor impedit.' translations: type: string description: '' example: null fields: type: string description: '' example: null delete: summary: 'Batch delete Personal card profile tab grids by their IDs' operationId: batchDeletePersonalCardProfileTabGridsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - voluptas items: type: string '/api/v1/personal-card-profile-tab-grids/{personalCardProfileTabGridId}': get: summary: 'Fetch a Personal card profile tab grid by its ID' operationId: fetchAPersonalCardProfileTabGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTabGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTabGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Personal card profile tab grid by its ID' operationId: updateAPersonalCardProfileTabGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTabGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTabGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: tabId: type: string description: '' example: null isGlobal: type: boolean description: '' example: false description: type: string description: '' example: 'Sapiente earum et qui eligendi.' translations: type: string description: '' example: null fields: type: string description: '' example: null delete: summary: 'Delete a Personal card profile tab grid by its ID' operationId: deleteAPersonalCardProfileTabGridByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTabGrid [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTabGrid [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personalCardProfileTabGridId description: '' example: id required: true schema: type: string /api/v1/personal-card-profile-tab-grids/search: post: summary: 'Fetch a list of Personal card profile tab grids based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPersonalCardProfileTabGridsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: isGlobal operator: '=' value: value - field: description operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/personal-card-profile-tabs: post: summary: 'Create a new Personal card profile tab' operationId: createANewPersonalCardProfileTab description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: boolean description: '' example: false description: type: string description: '' example: 'Impedit alias debitis voluptatum quibusdam est.' translations: type: string description: '' example: null required: - description get: summary: 'Fetch a list of Personal card profile tabs with pagination' operationId: fetchAListOfPersonalCardProfileTabsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personal-card-profile-tabs/batch: post: summary: 'Batch create new Personal card profile tabs' operationId: batchCreateNewPersonalCardProfileTabs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: isGlobal: type: boolean description: '' example: true description: type: string description: '' example: 'Tempora quae saepe sit rerum.' translations: type: string description: '' example: null required: - description patch: summary: 'Batch update Personal card profile tabs' operationId: batchUpdatePersonalCardProfileTabs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: isGlobal: type: boolean description: '' example: true description: type: string description: '' example: 'Exercitationem quisquam iste deserunt dolorem modi eaque quo.' translations: type: string description: '' example: null delete: summary: 'Batch delete Personal card profile tabs by their IDs' operationId: batchDeletePersonalCardProfileTabsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - error items: type: string '/api/v1/personal-card-profile-tabs/{personalCardProfileTabId}': get: summary: 'Fetch a Personal card profile tab by its ID' operationId: fetchAPersonalCardProfileTabByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTab [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTab [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Personal card profile tab by its ID' operationId: updateAPersonalCardProfileTabByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTab [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTab [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: isGlobal: type: boolean description: '' example: false description: type: string description: '' example: 'Cum ea minima aut praesentium a.' translations: type: string description: '' example: null delete: summary: 'Delete a Personal card profile tab by its ID' operationId: deleteAPersonalCardProfileTabByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'PersonalCardProfileTab [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'PersonalCardProfileTab [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personalCardProfileTabId description: '' example: ut required: true schema: type: string /api/v1/personal-card-profile-tabs/search: post: summary: 'Fetch a list of Personal card profile tabs based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfPersonalCardProfileTabsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: isGlobal operator: '=' value: value - field: description operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/locales: post: summary: 'Create a new Locale' operationId: createANewLocale description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: '' example: dignissimos code: type: string description: '' example: pariatur enabled: type: boolean description: '' example: true required: - title - code - enabled get: summary: 'Fetch a list of Locales with pagination' operationId: fetchAListOfLocalesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/locales/batch: post: summary: 'Batch create new Locales' operationId: batchCreateNewLocales description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: title: type: string description: '' example: minus code: type: string description: '' example: sit enabled: type: boolean description: '' example: false required: - title - code - enabled patch: summary: 'Batch update Locales' operationId: batchUpdateLocales description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: title: type: string description: '' example: laboriosam code: type: string description: '' example: ut enabled: type: boolean description: '' example: true delete: summary: 'Batch delete Locales by their IDs' operationId: batchDeleteLocalesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - pariatur items: type: string '/api/v1/locales/{localeId}': get: summary: 'Fetch a Locale by its ID' operationId: fetchALocaleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Locale [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Locale [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Locale by its ID' operationId: updateALocaleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Locale [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Locale [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: '' example: dolores code: type: string description: '' example: error enabled: type: boolean description: '' example: false delete: summary: 'Delete a Locale by its ID' operationId: deleteALocaleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'Locale [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'Locale [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: localeId description: '' example: voluptatem required: true schema: type: string /api/v1/locales/search: post: summary: 'Fetch a list of Locales based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfLocalesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: code operator: '=' value: value - field: title operator: '=' value: value - field: enabled operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `code`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc '/api/v1/external-salary-types/{externalSalaryTypeId}': get: summary: 'Fetch a External salary type by its ID' operationId: fetchAExternalSalaryTypeByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'ExternalSalaryType [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'ExternalSalaryType [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: externalSalaryTypeId description: '' example: sit required: true schema: type: string /api/v1/external-salary-types: get: summary: 'Fetch a list of External salary types with pagination' operationId: fetchAListOfExternalSalaryTypesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,externalIntegration' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personnel-permissions: post: summary: 'Create a new Emp permission' operationId: createANewEmpPermission description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: glue: type: string description: '' example: AND enum: - AND - OR translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } rules: type: array description: '' example: - odio items: type: string required: - glue get: summary: 'Fetch a list of Emp permissions with pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionsWithPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personnel-permissions/batch: post: summary: 'Batch create new Emp permissions' operationId: batchCreateNewEmpPermissions description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: glue: type: string description: '' example: AND enum: - AND - OR translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } rules: type: object description: 'Must have at least 1 items.' example: [] properties: { } required: - glue - rules patch: summary: 'Batch update Emp permissions' operationId: batchUpdateEmpPermissions description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: glue: type: string description: '' example: OR enum: - AND - OR translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } rules: type: object description: 'Must have at least 1 items.' example: null properties: { } delete: summary: 'Batch delete Emp permissions by their IDs' operationId: batchDeleteEmpPermissionsByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - sit items: type: string '/api/v1/personnel-permissions/{personnelPermissionId}': get: summary: 'Fetch a Emp permission by its ID' operationId: fetchAEmpPermissionByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermission [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermission [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Emp permission by its ID (Stability Score: 0.1)' operationId: updateAEmpPermissionByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermission [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermission [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: glue: type: string description: '' example: AND enum: - AND - OR translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } rules: type: array description: '' example: - debitis items: type: string delete: summary: 'Delete a Emp permission by its ID (Stability Score: 0.1)' operationId: deleteAEmpPermissionByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermission [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermission [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personnelPermissionId description: '' example: eveniet required: true schema: type: string /api/v1/personnel-permissions/search: post: summary: 'Fetch a list of Emp permissions based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionsBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: empPermissionId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/personnel-permission-rules: post: summary: 'Create a new Emp permission rule' operationId: createANewEmpPermissionRule description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: employeeFieldId: type: string description: '' example: veritatis translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } operator: type: string description: '' example: '=' enum: - '=' value: type: string description: '' example: necessitatibus required: - employeeFieldId - operator - value get: summary: 'Fetch a list of Emp permission rules with pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionRulesWithPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' /api/v1/personnel-permission-rules/batch: post: summary: 'Batch create new Emp permission rules' operationId: batchCreateNewEmpPermissionRules description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: employeeFieldId: type: string description: '' example: quae translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } operator: type: string description: '' example: '=' enum: - '=' value: type: string description: '' example: rerum required: - employeeFieldId - operator - value patch: summary: 'Batch update Emp permission rules' operationId: batchUpdateEmpPermissionRules description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: null items: type: object properties: employeeFieldId: type: string description: '' example: in translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } operator: type: string description: '' example: '=' enum: - '=' value: type: string description: '' example: ut delete: summary: 'Batch delete Emp permission rules by their IDs' operationId: batchDeleteEmpPermissionRulesByTheirIDs description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: resources: type: array description: '' example: - dolor items: type: string '/api/v1/personnel-permission-rules/{personnelPermissionRuleId}': get: summary: 'Fetch a Emp permission rule by its ID' operationId: fetchAEmpPermissionRuleByItsID description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermissionRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermissionRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' patch: summary: 'Update a Emp permission rule by its ID (Stability Score: 0.1)' operationId: updateAEmpPermissionRuleByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermissionRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermissionRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: employeeFieldId: type: string description: '' example: et translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } operator: type: string description: '' example: '=' enum: - '=' value: type: string description: '' example: velit delete: summary: 'Delete a Emp permission rule by its ID (Stability Score: 0.1)' operationId: deleteAEmpPermissionRuleByItsIDStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. 404: description: '' content: application/json: schema: type: object example: data: [] message: 'EmpPermissionRule [id] does not exist.' status: 404 properties: data: type: array example: [] message: type: string example: 'EmpPermissionRule [id] does not exist.' status: type: integer example: 404 tags: - 'Crudy Endpoints' parameters: - in: path name: personnelPermissionRuleId description: '' example: et required: true schema: type: string /api/v1/personnel-permission-rules/search: post: summary: 'Fetch a list of Emp permission rules based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)' operationId: fetchAListOfEmpPermissionRulesBasedOnTheProvidedFiltersScopesSortingAndPaginationStabilityScore01 description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: empPermissionRuleId operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc /api/v1/transactions: get: summary: 'Fetch a list of Transactions with pagination' operationId: fetchAListOfTransactionsWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: provident required: - companyId /api/v1/transactions/search: post: summary: 'Fetch a list of Transactions based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfTransactionsBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'company,employee,payCode' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' requestBody: required: true content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: companyId operator: '=' value: value - field: employeeId operator: '=' value: value - field: payCodeId operator: '=' value: value - field: salaryPeriod operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: externalId direction: asc companyId: type: string description: '' example: fuga required: - companyId '/api/v1/companies/{companyId}/employees': get: summary: 'Fetch a list of Employees with pagination' operationId: fetchAListOfEmployeesWithPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: oneOf: - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. - description: '' type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' post: summary: 'Create a new Employee' operationId: createANewEmployee description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Crudy Endpoints' parameters: - in: path name: companyId description: '' example: illum required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/search-custom': post: summary: 'Fetch a list of App\ http\ resources\ api\ v1\ employee field change resources based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfAppHttpResourcesApiV1EmployeeFieldChangeResourcesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: fieldName operator: '=' value: value - field: changeId operator: '=' value: value - field: effectiveDate operator: '=' value: value - field: status operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc parameters: - in: path name: employeeId description: '' example: et required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/search': post: summary: 'Fetch a list of Employee field changes based on the provided filters, scopes, sorting and pagination' operationId: fetchAListOfEmployeeFieldChangesBasedOnTheProvidedFiltersScopesSortingAndPagination description: '' parameters: - in: query name: page description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 required: false schema: type: integer description: 'Page number for pagination, defaults to 1, minimum 1' example: 1 - in: query name: pageSize description: 'Number of items per page, defaults to 15, minimum 1' example: 15 required: false schema: type: integer description: 'Number of items per page, defaults to 15, minimum 1' example: 15 - in: query name: withSoftDeletes description: 'Include soft deleted items in the response' example: true required: false schema: type: boolean description: 'Include soft deleted items in the response' example: true - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Crudy Endpoints' requestBody: required: false content: application/json: schema: type: object properties: filters: type: 'string[]' description: 'Filtering criteria Allowed operators: !=, =, >, <, >=, <=, in, not-in, array-contains, array-contains-any.' example: - field: effectiveDate operator: '=' value: value sort: type: 'string[]' description: 'Sorting criteria. Default sort is by `createdAt`.' example: - field: createdAt direction: asc - field: updatedAt direction: asc parameters: - in: path name: employeeId description: '' example: ut required: true schema: type: string /api/v1/authenticate: get: summary: 'Authenticate (Stability Score: 0.1)' operationId: authenticateStabilityScore01 description: 'This endpoint lets you authenticate.' parameters: [] responses: 422: description: '' content: application/json: schema: type: object example: message: 'Company accusamus does not exist. (and 1 more error)' errors: companyId: - 'Company accusamus does not exist.' roleId: - 'The selected role id is invalid.' status: 422 properties: message: type: string example: 'Company accusamus does not exist. (and 1 more error)' errors: type: object properties: companyId: type: array example: - 'Company accusamus does not exist.' items: type: string roleId: type: array example: - 'The selected role id is invalid.' items: type: string status: type: integer example: 422 tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: url: type: string description: '' example: 'http://www.bashirian.com/' companyId: type: string description: '' example: accusamus roleId: type: integer description: '' example: 5 access_token: type: string description: '' example: qui sensitive: type: boolean description: '' example: true security: [] /api/v1/logout: get: summary: Logout operationId: logout description: 'This endpoint lets you logout.' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' /api/v1/user: get: summary: User operationId: user description: 'This endpoint lets you get the authenticated user.' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/salary-warnings/{salaryWarningId}/confirm': post: summary: 'Confirm a salary rule warning (Stability Score: 0.1)' operationId: confirmASalaryRuleWarningStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: salaryWarningId description: '' example: quidem required: true schema: type: string '/api/v1/salary-warnings/{salaryWarningId}/unconfirm': post: summary: 'Remove confirmation from a salary rule warning (Stability Score: 0.1)' operationId: removeConfirmationFromASalaryRuleWarningStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: 'employee,salaryRule' responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: salaryWarningId description: '' example: et required: true schema: type: string /api/v1/notifications/read-all: post: summary: 'Mark all notifications as read' operationId: markAllNotificationsAsRead description: 'This endpoint lets you mark all notifications as read.' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Custom Endpoints' '/api/v1/notifications/{notificationId}/read': post: summary: 'Mark a notification as read by its ID' operationId: markANotificationAsReadByItsID description: 'This endpoint lets you mark a notification as read.' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: notificationId description: '' example: laborum required: true schema: type: string '/api/v1/notifications/{notificationId}/unread': post: summary: 'Mark a notification as not read by its ID (Stability Score: 0.1)' operationId: markANotificationAsNotReadByItsIDStabilityScore01 description: 'This endpoint lets you mark a notification as not read.' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: notificationId description: '' example: pariatur required: true schema: type: string /api/v1/execute-salary-rules: post: summary: 'Evaluate salary rules for a given period (Stability Score: 0.1)' operationId: evaluateSalaryRulesForAGivenPeriodStabilityScore01 description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Custom Endpoints' '/api/v1/pay-code-mappings/{mappingId}/duplicate': post: summary: 'Duplicate a payCode mapping' operationId: duplicateAPayCodeMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: autem required: - companyId parameters: - in: path name: mappingId description: '' example: asperiores required: true schema: type: string /api/v1/transactions/statistics: post: summary: 'Transaction Statistics' operationId: transactionStatistics description: 'This endpoint lets you get transaction statistics.' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: includeChildren: type: boolean description: '' example: false organizationId: type: string description: 'This field is required when companyId is not present.' example: fugiat companyId: type: string description: 'This field is required when organizationId is not present.' example: ab '/api/v1/personal-card-profiles/{personalCardProfileId}/duplicate': post: summary: 'Duplicate a personal card profile' operationId: duplicateAPersonalCardProfile description: '' parameters: - in: query name: include description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' required: false schema: type: string description: 'Include related resources. Use comma-separated values for multiple includes.' example: '' responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: animi translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } description: type: string description: '' example: 'Ratione rerum ut magni voluptas ipsum.' isGlobal: type: string description: '' example: vel companyId: type: string description: '' example: sed required: - isGlobal parameters: - in: path name: personalCardProfileId description: '' example: dolorem required: true schema: type: string /api/v1/storage-structure: post: summary: 'Create a new storage structure' operationId: createANewStorageStructure description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: directoryName: type: string description: '' example: inventore directoryParentId: type: string description: '' example: porro required: - directoryName get: summary: 'Fetch a list of storage structures with pagination' operationId: fetchAListOfStorageStructuresWithPagination description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/storage-structure/{storageStructureId}': get: summary: 'Fetch a storage structure by its ID' operationId: fetchAStorageStructureByItsID description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' patch: summary: 'Update a storage structure by its ID' operationId: updateAStorageStructureByItsID description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: directoryName: type: string description: 'This field is required when directoryParentId is not present.' example: reprehenderit directoryParentId: type: string description: '' example: hic delete: summary: 'Delete a storage structure by its ID' operationId: deleteAStorageStructureByItsID description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: storageStructureId description: '' example: nihil required: true schema: type: string /api/v1/change-transfer: post: summary: 'Transfer Changes' operationId: transferChanges description: 'This endpoint lets you transfer changes.' parameters: [] responses: { } tags: - 'Custom Endpoints' '/api/v1/employees/{employeeId}/employee-relatives': post: summary: 'Create a new relative' operationId: createANewRelative description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: firstName: type: string description: '' example: temporibus lastName: type: string description: '' example: fugiat emailAddress: type: string description: 'Must be a valid email address.' example: fanny.jenkins@example.org telephone: type: string description: 'Must match the regex /^[\d\s\-\+]{5,}$/.' example: '-{5,}' mobilePhone: type: string description: 'Must match the regex /^[\d\s\-\+]{5,}$/.' example: '+{5,}' relationship: type: string description: '' example: fugit comment: type: string description: '' example: sint required: - firstName - lastName - relationship parameters: - in: path name: employeeId description: '' example: nam required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/field-changes': get: summary: 'Get changes for a particular relative.' operationId: getChangesForAParticularRelative description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: employeeId description: '' example: laborum required: true schema: type: string - in: path name: relativeId description: '' example: esse required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: mollitia recordId: type: string description: '' example: voluptatem required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: ut required: true schema: type: string - in: path name: relativeId description: '' example: repellat required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: velit recordId: type: string description: '' example: quam required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: officia required: true schema: type: string - in: path name: relativeId description: '' example: ut required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: esse recordId: type: string description: '' example: voluptatem required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: autem required: true schema: type: string - in: path name: relativeId description: '' example: nam required: true schema: type: string '/api/v1/employees/{employeeId}/employee-relatives/{relativeId}/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: deserunt recordId: type: string description: '' example: sit required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: et required: true schema: type: string - in: path name: relativeId description: '' example: possimus required: true schema: type: string '/api/v1/employees/{employeeId}/future-changes': get: summary: 'List all changes for a particular employee.' operationId: listAllChangesForAParticularEmployee description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: employeeId description: '' example: nesciunt required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/unique-effective-dates': get: summary: 'Get all unique effective dates for an employee.' operationId: getAllUniqueEffectiveDatesForAnEmployee description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: employeeId description: '' example: et required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes': post: summary: 'Create a new employee change' operationId: createANewEmployeeChange description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 changeId: type: string description: '' example: repellendus changeType: type: string description: '' example: delete enum: - delete fieldName: type: string description: '' example: aliquid newValue: type: string description: 'This field is required unless changeType is in delete.' example: null oldValue: type: string description: '' example: illum comment: type: string description: '' example: veritatis changedBy: type: string description: '' example: null changedDate: type: string description: '' example: null approved: type: string description: '' example: null employeeId: type: string description: '' example: null status: type: string description: '' example: null required: - fieldName parameters: - in: path name: employeeId description: '' example: quia required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/batch': post: summary: 'Create multiple employee changes' operationId: createMultipleEmployeeChanges description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 changeId: type: string description: '' example: quo changeType: type: string description: '' example: delete enum: - delete fieldName: type: string description: '' example: vitae newValue: type: string description: 'This field is required unless changeType is in delete.' example: null oldValue: type: string description: '' example: impedit comment: type: string description: '' example: tempora changedBy: type: string description: '' example: null changedDate: type: string description: '' example: null approved: type: string description: '' example: null employeeId: type: string description: '' example: null status: type: string description: '' example: null required: - fieldName parameters: - in: path name: employeeId description: '' example: magni required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment': get: summary: 'List all changes for a particular employee.' operationId: listAllChangesForAParticularEmployee description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' post: summary: 'Create a new change request for a particular employee.' operationId: createANewChangeRequestForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 changeId: type: string description: '' example: aliquid changeType: type: string description: '' example: delete enum: - delete fieldName: type: string description: '' example: voluptates newValue: type: string description: 'This field is required unless changeType is in delete.' example: null oldValue: type: string description: '' example: dolorem comment: type: string description: '' example: officia changedBy: type: string description: '' example: null changedDate: type: string description: '' example: null approved: type: string description: '' example: null employeeId: type: string description: '' example: null status: type: string description: '' example: null required: - fieldName parameters: - in: path name: employeeId description: '' example: ipsa required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/batch': post: summary: 'Create multiple change requests for a particular employee.' operationId: createMultipleChangeRequestsForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 changeId: type: string description: '' example: odio changeType: type: string description: '' example: delete enum: - delete fieldName: type: string description: '' example: reprehenderit newValue: type: string description: 'This field is required unless changeType is in delete.' example: null oldValue: type: string description: '' example: voluptatum comment: type: string description: '' example: maxime changedBy: type: string description: '' example: null changedDate: type: string description: '' example: null approved: type: string description: '' example: null employeeId: type: string description: '' example: null status: type: string description: '' example: null required: - fieldName parameters: - in: path name: employeeId description: '' example: quibusdam required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: quam recordId: type: string description: '' example: corporis required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: qui required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: qui recordId: type: string description: '' example: odit required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: non required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: magnam recordId: type: string description: '' example: in required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: praesentium required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/employment/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: quod recordId: type: string description: '' example: repellendus required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: qui required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code': get: summary: 'Get all pay code changes.' operationId: getAllPayCodeChanges description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' post: summary: 'Create a new pay code change.' operationId: createANewPayCodeChange description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 0 changeId: type: string description: '' example: expedita changeType: type: string description: '' example: delete enum: - delete fieldName: type: string description: '' example: qui newValue: type: object description: 'This field is required unless changeType is in delete.' example: null properties: { } oldValue: type: object description: '' example: null properties: { } comment: type: string description: '' example: dolorem changedBy: type: string description: '' example: null changedDate: type: string description: '' example: null approved: type: string description: '' example: null employeeId: type: string description: '' example: null status: type: string description: '' example: null required: - fieldName parameters: - in: path name: employeeId description: '' example: ipsam required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/batch': post: summary: 'Create multiple pay code changes.' operationId: createMultiplePayCodeChanges description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: effectiveDate: type: number description: 'This field is required unless changeType is in delete. Must be between 0 and 2147483647.' example: 1 changeId: type: string description: '' example: ullam changeType: type: string description: '' example: delete enum: - delete fieldName: type: string description: '' example: sit newValue: type: object description: 'This field is required unless changeType is in delete.' example: null properties: { } oldValue: type: object description: '' example: null properties: { } comment: type: string description: '' example: nihil changedBy: type: string description: '' example: null changedDate: type: string description: '' example: null approved: type: string description: '' example: null employeeId: type: string description: '' example: null status: type: string description: '' example: null required: - fieldName parameters: - in: path name: employeeId description: '' example: qui required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: in recordId: type: string description: '' example: debitis required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: amet required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: ea recordId: type: string description: '' example: at required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: velit required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: labore recordId: type: string description: '' example: autem required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: ut required: true schema: type: string '/api/v1/employees/{employeeId}/field-changes/pay-code/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: ut recordId: type: string description: '' example: et required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: aut required: true schema: type: string '/api/v1/employees/{employeeId}/approve-field-change': post: summary: 'Approve a field change for a particular employee.' operationId: approveAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: alias recordId: type: string description: '' example: vero required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: recusandae required: true schema: type: string '/api/v1/employees/{employeeId}/approve-field-change/batch': post: summary: 'Approve multiple field changes for a particular employee.' operationId: approveMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: autem recordId: type: string description: '' example: totam required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: minima required: true schema: type: string '/api/v1/employees/{employeeId}/deny-field-change': post: summary: 'Deny a field change for a particular employee.' operationId: denyAFieldChangeForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: harum recordId: type: string description: '' example: officiis required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: temporibus required: true schema: type: string '/api/v1/employees/{employeeId}/deny-field-change/batch': post: summary: 'Deny multiple field changes for a particular employee.' operationId: denyMultipleFieldChangesForAParticularEmployee description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: changeId: type: string description: '' example: ea recordId: type: string description: '' example: labore required: - changeId - recordId parameters: - in: path name: employeeId description: '' example: dolorem required: true schema: type: string /api/v1/field-mappings: post: summary: 'Create a new employee field mapping.' operationId: createANewEmployeeFieldMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalEmployeeFieldId: type: string description: '' example: harum employeeFieldId: type: string description: '' example: qui companyId: type: string description: '' example: null externalIntegrationId: type: string description: '' example: quam organizationId: type: string description: '' example: null required: - externalEmployeeFieldId - employeeFieldId /api/v1/field-mappings/batch: post: summary: 'Create multiple employee field mappings.' operationId: createMultipleEmployeeFieldMappings description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalEmployeeFieldId: type: string description: '' example: id employeeFieldId: type: string description: '' example: voluptates companyId: type: string description: '' example: null externalIntegrationId: type: string description: '' example: est organizationId: type: string description: '' example: null required: - externalEmployeeFieldId - employeeFieldId '/api/v1/field-mappings/{mappingId}': patch: summary: 'Update an employee field mapping.' operationId: updateAnEmployeeFieldMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: externalEmployeeFieldId: type: string description: '' example: harum employeeFieldId: type: string description: '' example: delectus companyId: type: string description: '' example: null externalIntegrationId: type: string description: '' example: sed organizationId: type: string description: '' example: null required: - externalEmployeeFieldId - employeeFieldId delete: summary: 'Delete an employee field mapping.' operationId: deleteAnEmployeeFieldMapping description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: mappingId description: '' example: impedit required: true schema: type: string '/api/v1/external-integration/{integrationId}/employee-fields': get: summary: 'Get fields for a particular integration.' operationId: getFieldsForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: select enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: string enum: - string - number - date - boolean maxInput: type: number description: '' example: 9781421.7951773 minInput: type: number description: '' example: 39550010.758808 parameters: - in: path name: integrationId description: '' example: animi required: true schema: type: string '/api/v1/external-integration/{integrationId}/employee-fields/{fieldId}': put: summary: 'Customize an existing global employee field for a particular integration.' operationId: customizeAnExistingGlobalEmployeeFieldForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: number enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: '' example: 17716.2 minInput: type: number description: '' example: 7574.82138 get: summary: 'Get an extended employee field for a particular integration.' operationId: getAnExtendedEmployeeFieldForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: true importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: email enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: '' example: 172.457 minInput: type: number description: '' example: 3522263.4225518 delete: summary: 'Revert an extended employee field for a particular integration.' operationId: revertAnExtendedEmployeeFieldForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: password enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean enum: - string - number - date - boolean maxInput: type: number description: '' example: 6.15836529 minInput: type: number description: '' example: 1147495.1267429 parameters: - in: path name: integrationId description: '' example: et required: true schema: type: string - in: path name: fieldId description: '' example: natus required: true schema: type: string '/api/v1/organization/{organizationId}/employee-fields': get: summary: 'Get fields for a particular organization.' operationId: getFieldsForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: false salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: date enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: string enum: - string - number - date - boolean maxInput: type: number description: '' example: 35.8457 minInput: type: number description: '' example: 980.00662708 parameters: - in: path name: organizationId description: '' example: in required: true schema: type: string '/api/v1/organization/{organizationId}/employee-fields/{fieldId}': put: summary: 'Customize an existing global employee field for a particular organization.' operationId: customizeAnExistingGlobalEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: false salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: email enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: '' example: 14734.955942 minInput: type: number description: '' example: 768375.2478 get: summary: 'Show an extended employee field for a particular organization.' operationId: showAnExtendedEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: true importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: textarea enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: '' example: 229939055.15218 minInput: type: number description: '' example: 4.9546598 delete: summary: 'Revert an extended employee field for a particular organization.' operationId: revertAnExtendedEmployeeFieldForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: email enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number enum: - string - number - date - boolean maxInput: type: number description: '' example: 16822.811836268 minInput: type: number description: '' example: 312246.9004489 parameters: - in: path name: organizationId description: '' example: rerum required: true schema: type: string - in: path name: fieldId description: '' example: consequatur required: true schema: type: string '/api/v1/company/{companyId}/employee-fields/{fieldId}': put: summary: 'Customize an existing global employee field for a particular company.' operationId: customizeAnExistingGlobalEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: true importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: textarea enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean enum: - string - number - date - boolean maxInput: type: number description: '' example: 92184.9766246 minInput: type: number description: '' example: 122229087.09758 get: summary: 'Get an extended employee field for a particular company.' operationId: getAnExtendedEmployeeFieldForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: false isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: date enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: '' example: 1.662889 minInput: type: number description: '' example: 209382.67085644 patch: summary: 'Update an employee field for a particular company.' operationId: updateAnEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null parentId: type: string description: '' example: null companyId: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: false salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: true fieldName: type: string description: '' example: null fieldType: type: string description: '' example: text enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: boolean enum: - string - number - date - boolean maxInput: type: number description: '' example: 9480.989652629 minInput: type: number description: '' example: 791.6792 maxLength: type: number description: '' example: 2.23 minLength: type: number description: '' example: 0.1 combinedFieldIds: type: array description: '' example: - magnam items: type: string required: - combinedFieldIds delete: summary: 'Delete an employee field for a particular company.' operationId: deleteAnEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: companyId description: '' example: cumque required: true schema: type: string - in: path name: fieldId description: '' example: et required: true schema: type: string '/api/v1/company/{companyId}/employee-fields/{fieldId}/revert': post: summary: 'Revert an extended employee field for a particular company.' operationId: revertAnExtendedEmployeeFieldForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: false salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: false observe: type: boolean description: '' example: true importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: email enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: date enum: - string - number - date - boolean maxInput: type: number description: '' example: 6236.8791 minInput: type: number description: '' example: 431304.64 parameters: - in: path name: companyId description: '' example: perspiciatis required: true schema: type: string - in: path name: fieldId description: '' example: quos required: true schema: type: string '/api/v1/company/{companyId}/employee-fields/revert-all': post: summary: 'Revert extended employee fields and custom fields for a particular company.' operationId: revertExtendedEmployeeFieldsAndCustomFieldsForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: false sensitive: type: boolean description: '' example: true allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: password enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number enum: - string - number - date - boolean maxInput: type: number description: '' example: 467809963.5234 minInput: type: number description: '' example: 27140.42 parameters: - in: path name: companyId description: '' example: omnis required: true schema: type: string '/api/v1/company/{companyId}/employee-fields': get: summary: 'Get employee fields for a particular company.' operationId: getEmployeeFieldsForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: companyId: type: string description: '' example: null parentId: type: string description: '' example: null fieldName: type: string description: '' example: null isGlobal: type: string description: '' example: null externalIntegrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: true salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: false importExcluded: type: boolean description: '' example: false manualInput: type: boolean description: '' example: false fieldType: type: string description: '' example: textarea enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number enum: - string - number - date - boolean maxInput: type: number description: '' example: 5035837.3759339 minInput: type: number description: '' example: 516398.17847 post: summary: 'Get employee fields for a particular company.' operationId: getEmployeeFieldsForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: isGlobal: type: string description: '' example: null parentId: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } isShow: type: boolean description: '' example: true isMandatory: type: boolean description: '' example: false salarySensitive: type: boolean description: '' example: true sensitive: type: boolean description: '' example: false allowNewValue: type: boolean description: '' example: true observe: type: boolean description: '' example: true importExcluded: type: boolean description: '' example: true manualInput: type: boolean description: '' example: true fieldType: type: string description: '' example: password enum: - text - number - password - email - date - checkbox - radio - select - textarea dataType: type: string description: '' example: number enum: - string - number - date - boolean maxInput: type: number description: 'This field is required when dataType is string.' example: 6.697714444 minInput: type: number description: 'This field is required when dataType is string.' example: 0.0 maxLength: type: number description: '' example: 159.415 minLength: type: number description: '' example: 23756247.3 fieldName: type: string description: 'Must not be greater than 255 characters.' example: gi combinedFieldIds: type: array description: '' example: - excepturi items: type: string required: - isShow - fieldName - combinedFieldIds parameters: - in: path name: companyId description: '' example: autem required: true schema: type: string /api/v1/field-groups: post: summary: 'Create a global field group' operationId: createAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupName: type: string description: '' example: quo translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null required: - groupName get: summary: 'Fetch all global field groups' operationId: fetchAllGlobalFieldGroups description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/field-groups/{groupId}': get: summary: 'Fetch a global field group by its ID' operationId: fetchAGlobalFieldGroupByItsID description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' patch: summary: 'Update a global field group' operationId: updateAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: aut translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null delete: summary: 'Delete a global field group' operationId: deleteAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' parameters: - in: path name: groupId description: '' example: consequatur required: true schema: type: string '/api/v1/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a global field group' operationId: addAFieldToAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: vel required: - groupId parameters: - in: path name: employeeFieldId description: '' example: eaque required: true schema: type: string '/api/v1/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from one global field group to another' operationId: moveAFieldFromOneGlobalFieldGroupToAnother description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: autem newGroupId: type: string description: '' example: libero required: - oldGroupId - newGroupId parameters: - in: path name: employeeFieldId description: '' example: veritatis required: true schema: type: string '/api/v1/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a global field group' operationId: removeAFieldFromAGlobalFieldGroup description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: enim required: - groupId parameters: - in: path name: employeeFieldId description: '' example: autem required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups': get: summary: 'Get fields groups for a particular integration.' operationId: getFieldsGroupsForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: et translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null parameters: - in: path name: integrationId description: '' example: temporibus required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{groupId}': put: summary: 'Customize an existing global field group for a particular integration.' operationId: customizeAnExistingGlobalFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: repellendus translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null get: summary: 'Get a particular field group for a particular integration.' operationId: getAParticularFieldGroupForAParticularIntegration description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: qui translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null delete: summary: 'Revert a customized global field group for a particular integration.' operationId: revertACustomizedGlobalFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: voluptas translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null parameters: - in: path name: integrationId description: '' example: repellat required: true schema: type: string - in: path name: groupId description: '' example: quia required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a particular field group for a particular integration.' operationId: addAFieldToAParticularFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: est required: - groupId parameters: - in: path name: integrationId description: '' example: quis required: true schema: type: string - in: path name: employeeFieldId description: '' example: et required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from a field group for a particular integration.' operationId: moveAFieldFromAFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: similique newGroupId: type: string description: '' example: mollitia required: - oldGroupId - newGroupId parameters: - in: path name: integrationId description: '' example: ipsa required: true schema: type: string - in: path name: employeeFieldId description: '' example: qui required: true schema: type: string '/api/v1/external-integration/{integrationId}/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a field group for a particular integration.' operationId: removeAFieldFromAFieldGroupForAParticularIntegration description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: maxime required: - groupId parameters: - in: path name: integrationId description: '' example: maxime required: true schema: type: string - in: path name: employeeFieldId description: '' example: dolore required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups': get: summary: 'Get fields groups for a particular organization.' operationId: getFieldsGroupsForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: ipsa translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null parameters: - in: path name: organizationId description: '' example: sit required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{groupId}': put: summary: 'Customize an existing global field group for a particular organization.' operationId: customizeAnExistingGlobalFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: ad translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null get: summary: 'Get a particular field group for a particular organization.' operationId: getAParticularFieldGroupForAParticularOrganization description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: numquam translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null delete: summary: 'Revert a customized field group for a particular organization.' operationId: revertACustomizedFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: fugiat translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null parameters: - in: path name: organizationId description: '' example: iusto required: true schema: type: string - in: path name: groupId description: '' example: amet required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a particular field group for a particular organization.' operationId: addAFieldToAParticularFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: vitae required: - groupId parameters: - in: path name: organizationId description: '' example: ratione required: true schema: type: string - in: path name: employeeFieldId description: '' example: corporis required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from one field group to another for a particular organization.' operationId: moveAFieldFromOneFieldGroupToAnotherForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: aspernatur newGroupId: type: string description: '' example: similique required: - oldGroupId - newGroupId parameters: - in: path name: organizationId description: '' example: quis required: true schema: type: string - in: path name: employeeFieldId description: '' example: aut required: true schema: type: string '/api/v1/organization/{organizationId}/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a particular field group for a particular organization.' operationId: removeAFieldFromAParticularFieldGroupForAParticularOrganization description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: laboriosam required: - groupId parameters: - in: path name: organizationId description: '' example: eius required: true schema: type: string - in: path name: employeeFieldId description: '' example: quia required: true schema: type: string '/api/v1/company/{companyId}/field-groups': get: summary: 'Get fields groups for a particular company.' operationId: getFieldsGroupsForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: non translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null parameters: - in: path name: companyId description: '' example: molestias required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{groupId}': put: summary: 'Customize an existing global field group for a particular company.' operationId: customizeAnExistingGlobalFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: alias translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null get: summary: 'Show a customized global field group for a particular company.' operationId: showACustomizedGlobalFieldGroupForAParticularCompany description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: necessitatibus translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null delete: summary: 'Revert a customized global field group for a particular company.' operationId: revertACustomizedGlobalFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: groupName: type: string description: '' example: et translations: type: object description: 'The data must be a valid translation object.' example: null properties: { } fields: type: string description: '' example: null isGlobal: type: string description: '' example: null companyId: type: string description: '' example: null integrationId: type: string description: '' example: null organizationId: type: string description: '' example: null parameters: - in: path name: companyId description: '' example: quia required: true schema: type: string - in: path name: groupId description: '' example: aut required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{employeeFieldId}/add-field': post: summary: 'Add a field to a field group for a particular company.' operationId: addAFieldToAFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: dolores required: - groupId parameters: - in: path name: companyId description: '' example: corporis required: true schema: type: string - in: path name: employeeFieldId description: '' example: rerum required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{employeeFieldId}/move-field': patch: summary: 'Move a field from one field group to another for a particular company.' operationId: moveAFieldFromOneFieldGroupToAnotherForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: oldGroupId: type: string description: '' example: cum newGroupId: type: string description: '' example: illo required: - oldGroupId - newGroupId parameters: - in: path name: companyId description: '' example: blanditiis required: true schema: type: string - in: path name: employeeFieldId description: '' example: veniam required: true schema: type: string '/api/v1/company/{companyId}/field-groups/{employeeFieldId}/remove-field': post: summary: 'Remove a field from a field group for a particular company.' operationId: removeAFieldFromAFieldGroupForAParticularCompany description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: groupId: type: string description: '' example: eveniet required: - groupId parameters: - in: path name: companyId description: '' example: rerum required: true schema: type: string - in: path name: employeeFieldId description: '' example: aut required: true schema: type: string /api/v1/import/company: post: summary: 'Import company details (Stability Score: 0.1)' operationId: importCompanyDetailsStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: laboriosam companyIntegrationId: type: string description: '' example: nihil async: type: boolean description: '' example: true required: - companyId - companyIntegrationId /api/v1/import/employees: post: summary: 'Import employees (Stability Score: 0.1)' operationId: importEmployeesStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: aliquid companyIntegrationId: type: string description: '' example: voluptas async: type: boolean description: '' example: false required: - companyId - companyIntegrationId /api/v1/import/transactions: post: summary: 'Import transactions. (Stability Score: 0.1)' operationId: importTransactionsStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: iure companyIntegrationId: type: string description: '' example: ipsa period: type: string description: 'Must match the regex /^[1-9][0-9]{3}(0[1-9]|1[0-2])[0-9]$/.' example: '4957040' required: - companyId - companyIntegrationId - period /api/v1/import/salary-types: post: summary: 'Import salary types.' operationId: importSalaryTypes description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: companyId: type: string description: '' example: temporibus required: - companyId /api/v1/import/cloud/transactions: post: summary: 'Import transactions to the cloud.' operationId: importTransactionsToTheCloud description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/cache/refresh: post: summary: 'Refresh the cache.' operationId: refreshTheCache description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/cache/warm: post: summary: 'Warm the cache.' operationId: warmTheCache description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/cache/clear: post: summary: 'Clear the cache.' operationId: clearTheCache description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' /api/v1/real-time/connection-token: get: summary: 'Generate connection token for Centrifugo.' operationId: generateConnectionTokenForCentrifugo description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' /api/v1/real-time/subscription-token: get: summary: 'Generate subscription token for Centrifugo.' operationId: generateSubscriptionTokenForCentrifugo description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: channel: type: string description: '' example: reiciendis required: - channel '/api/v1/roles/{role_id}/specific-abilities': get: summary: 'Retrieve specific abilities for a specific role (Stability Score: 0.1)' operationId: retrieveSpecificAbilitiesForASpecificRoleStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' parameters: - in: path name: role_id description: 'The ID of the role.' example: 1 required: true schema: type: integer '/api/v1/roles/{role_id}/specific-abilities/attach': post: summary: 'Attach a specific ability to a role (Stability Score: 0.1)' operationId: attachASpecificAbilityToARoleStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: specific_ability_ids: type: array description: '' example: null items: type: string parameters: - in: path name: role_id description: 'The ID of the role.' example: 1 required: true schema: type: integer '/api/v1/roles/{role_id}/specific-abilities/detach': post: summary: 'Detach a specific ability to a role (Stability Score: 0.1)' operationId: detachASpecificAbilityToARoleStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: specific_ability_ids: type: array description: '' example: null items: type: string parameters: - in: path name: role_id description: 'The ID of the role.' example: 1 required: true schema: type: integer /api/v1/specific-abilities: get: summary: 'Retrieve all specific abilities (Stability Score: 0.1)' operationId: retrieveAllSpecificAbilitiesStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' '/api/v1/abilities/ability-group/{abilityGroupId}/allow': post: summary: 'Allow an ability to a group. (Stability Score: 0.1)' operationId: allowAnAbilityToAGroupStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: ability: type: string description: '' example: update enum: - create - read - update - delete entity: type: string description: '' example: App\DataLayer\Models\PayCodeVariable enum: - App\DataLayer\Models\Change - App\DataLayer\Models\ChangeHistory - App\DataLayer\Models\Company - App\DataLayer\Models\CompanyField - App\DataLayer\Models\CompanyFieldMap - App\DataLayer\Models\CompanyIntegration - App\DataLayer\Models\CompanyIntegrationsMapping - App\DataLayer\Models\CompanySettings - App\DataLayer\Models\EmpPermission - App\DataLayer\Models\EmpPermissionRule - App\DataLayer\Models\Employee - App\DataLayer\Models\EmployeeField - App\DataLayer\Models\EmployeeFieldChange - App\DataLayer\Models\EmployeeFieldMap - App\DataLayer\Models\EmploymentChange - App\DataLayer\Models\EmploymentHistory - App\DataLayer\Models\ExternalCompanyField - App\DataLayer\Models\ExternalEmployeeField - App\DataLayer\Models\ExternalIntegration - App\DataLayer\Models\ExternalSalaryType - App\DataLayer\Models\FieldGroup - App\DataLayer\Models\FieldValueMatrix - App\DataLayer\Models\FileUpload - App\DataLayer\Models\IntegrationType - App\DataLayer\Models\Locale - App\DataLayer\Models\Menu - App\DataLayer\Models\Notification - App\DataLayer\Models\OrgIntegrationsMapping - App\DataLayer\Models\Organization - App\DataLayer\Models\PayCode - App\DataLayer\Models\PayCodeChange - App\DataLayer\Models\PayCodeGroup - App\DataLayer\Models\PayCodeHistory - App\DataLayer\Models\PayCodeMapping - App\DataLayer\Models\PayCodeType - App\DataLayer\Models\PayCodeVariable - App\DataLayer\Models\PersonalCardProfile - App\DataLayer\Models\PersonalCardProfileTab - App\DataLayer\Models\PersonalCardProfileTabGrid - App\DataLayer\Models\Relative - App\DataLayer\Models\RelativeChange - App\DataLayer\Models\RelativeChangeHistory - App\DataLayer\Models\RoleEmpPermission - App\DataLayer\Models\SalaryRule - App\DataLayer\Models\SalaryTypeMap - App\DataLayer\Models\SalaryWarning - App\DataLayer\Models\StorageStructure - App\DataLayer\Models\Transaction - App\DataLayer\Models\User - App\DataLayer\Models\VariableType entityId: type: string description: '' example: corrupti required: - ability - entity parameters: - in: path name: abilityGroupId description: '' example: officiis required: true schema: type: string '/api/v1/abilities/ability-group/{abilityGroupId}/forbid': post: summary: 'Forbid an ability to a group. (Stability Score: 0.1)' operationId: forbidAnAbilityToAGroupStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: ability: type: string description: '' example: update enum: - create - read - update - delete entity: type: string description: '' example: App\DataLayer\Models\RoleEmpPermission enum: - App\DataLayer\Models\Change - App\DataLayer\Models\ChangeHistory - App\DataLayer\Models\Company - App\DataLayer\Models\CompanyField - App\DataLayer\Models\CompanyFieldMap - App\DataLayer\Models\CompanyIntegration - App\DataLayer\Models\CompanyIntegrationsMapping - App\DataLayer\Models\CompanySettings - App\DataLayer\Models\EmpPermission - App\DataLayer\Models\EmpPermissionRule - App\DataLayer\Models\Employee - App\DataLayer\Models\EmployeeField - App\DataLayer\Models\EmployeeFieldChange - App\DataLayer\Models\EmployeeFieldMap - App\DataLayer\Models\EmploymentChange - App\DataLayer\Models\EmploymentHistory - App\DataLayer\Models\ExternalCompanyField - App\DataLayer\Models\ExternalEmployeeField - App\DataLayer\Models\ExternalIntegration - App\DataLayer\Models\ExternalSalaryType - App\DataLayer\Models\FieldGroup - App\DataLayer\Models\FieldValueMatrix - App\DataLayer\Models\FileUpload - App\DataLayer\Models\IntegrationType - App\DataLayer\Models\Locale - App\DataLayer\Models\Menu - App\DataLayer\Models\Notification - App\DataLayer\Models\OrgIntegrationsMapping - App\DataLayer\Models\Organization - App\DataLayer\Models\PayCode - App\DataLayer\Models\PayCodeChange - App\DataLayer\Models\PayCodeGroup - App\DataLayer\Models\PayCodeHistory - App\DataLayer\Models\PayCodeMapping - App\DataLayer\Models\PayCodeType - App\DataLayer\Models\PayCodeVariable - App\DataLayer\Models\PersonalCardProfile - App\DataLayer\Models\PersonalCardProfileTab - App\DataLayer\Models\PersonalCardProfileTabGrid - App\DataLayer\Models\Relative - App\DataLayer\Models\RelativeChange - App\DataLayer\Models\RelativeChangeHistory - App\DataLayer\Models\RoleEmpPermission - App\DataLayer\Models\SalaryRule - App\DataLayer\Models\SalaryTypeMap - App\DataLayer\Models\SalaryWarning - App\DataLayer\Models\StorageStructure - App\DataLayer\Models\Transaction - App\DataLayer\Models\User - App\DataLayer\Models\VariableType entityId: type: string description: '' example: omnis required: - ability - entity parameters: - in: path name: abilityGroupId description: '' example: in required: true schema: type: string '/api/v1/abilities/roles/{roleId}/assign': post: summary: 'Assign a role to a user. (Stability Score: 0.1)' operationId: assignARoleToAUserStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: nihil title: type: string description: '' example: est parameters: - in: path name: roleId description: '' example: 1 required: true schema: type: integer '/api/v1/abilities/roles/{roleId}/retract': post: summary: 'Retract a role from a user. (Stability Score: 0.1)' operationId: retractARoleFromAUserStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: dolores title: type: string description: '' example: animi parameters: - in: path name: roleId description: '' example: 1 required: true schema: type: integer '/api/v1/abilities/roles/{roleId}/assign-group': post: summary: 'Assign a group to a role. (Stability Score: 0.1)' operationId: assignAGroupToARoleStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: abilityGroupId: type: integer description: '' example: 7 required: - abilityGroupId parameters: - in: path name: roleId description: '' example: 1 required: true schema: type: integer '/api/v1/abilities/roles/{roleId}/retract-group': post: summary: 'Retract a group from a role. (Stability Score: 0.1)' operationId: retractAGroupFromARoleStabilityScore01 description: '' parameters: [] responses: { } tags: - 'Custom Endpoints' requestBody: required: true content: application/json: schema: type: object properties: abilityGroupId: type: integer description: '' example: 15 required: - abilityGroupId parameters: - in: path name: roleId description: '' example: 1 required: true schema: type: integer /api/v1/abilities/entity-types: get: summary: 'Get all types of entities (Stability Score: 0.1)' operationId: getAllTypesOfEntitiesStabilityScore01 description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Custom Endpoints' /api/v1/abilities/ability-group/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/ability-group/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/ability-group: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/abilities/ability-group/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the ability group.' example: nesciunt required: true schema: type: string /api/v1/abilities/roles/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/roles/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints /api/v1/abilities/roles: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints '/api/v1/abilities/roles/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Endpoints put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - Endpoints delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - Endpoints parameters: - in: path name: id description: 'The ID of the role.' example: 1 required: true schema: type: integer /api/v1/orion/transactions/search: post: summary: 'Filters, sorts, and fetches the list of resources.' operationId: filtersSortsAndFetchesTheListOfResources description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' /api/v1/orion/transactions/batch: post: summary: 'Creates a batch of new resources in a transaction-safe way.' operationId: createsABatchOfNewResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] properties: { } required: - resources patch: summary: 'Update a batch of resources in a transaction-safe way.' operationId: updateABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' requestBody: required: true content: application/json: schema: type: object properties: resources: type: object description: '' example: [] properties: { } required: - resources delete: summary: 'Deletes a batch of resources in a transaction-safe way.' operationId: deletesABatchOfResourcesInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' /api/v1/orion/transactions: get: summary: 'Fetches the list of resources.' operationId: fetchesTheListOfResources description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Orion Endpoints' post: summary: 'Creates new resource in a transaction-safe way.' operationId: createsNewResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' '/api/v1/orion/transactions/{id}': get: summary: 'Fetches resource.' operationId: fetchesResource description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Orion Endpoints' put: summary: 'Update a resource in a transaction-safe way.' operationId: updateAResourceInATransactionSafeWay description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' delete: summary: 'Deletes a resource.' operationId: deletesAResource description: '' parameters: [] responses: { } tags: - 'Orion Endpoints' parameters: - in: path name: id description: 'The ID of the transaction.' example: amet required: true schema: type: string /api/octane-firebase-concurrently: get: summary: '' operationId: getApiOctaneFirebaseConcurrently description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' /api/v1/user/roles: get: summary: '' operationId: getApiV1UserRoles description: '' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - 'Uncategorized Endpoints' tags: - name: 'Admin Dashboard' description: 'All other endpoints' - name: 'Crudy Endpoints' description: 'All Crudy endpoints' - name: 'Custom Endpoints' description: 'All other endpoints' - name: Endpoints description: 'All other endpoints' - name: 'Orion Endpoints' description: '' - name: 'Uncategorized Endpoints' description: 'All other endpoints' components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []