SmartInc-API / schema_map.py
yoursdvniel's picture
Create schema_map.py
ae85c35 verified
schema = {
"applications": {
"participantId": "string",
"programName": "string",
"programId": "string",
"companyCode": "string",
"submittedAt": "string",
"beneficiaryName": "string",
"gender": "string",
"ageGroup": "string",
"province": "string",
"hub": "string",
"email": "string",
"motivation": "string",
"challenges": "string",
"facebook": "string",
"instagram": "string",
"linkedIn": "string",
"complianceScore": "number",
"complianceDocuments": "object",
"aiEvaluation": "object",
"growthPlanDocUrl": "string",
"interventions": "object",
"stage": "string",
"applicationStatus": "string",
"$aliases": {
"status": "applicationStatus",
"applicantId": "participantId",
"program": "programName",
"submissionDate": "submittedAt",
"name": "beneficiaryName",
"region": "province",
"location": "hub",
"documents": "complianceDocuments",
"evaluation": "aiEvaluation",
"currentStage": "stage",
},
},
"assignedInterventions": {
"id": "string",
"participantId": "string",
"beneficiaryName": "string",
"consultantId": "string",
"consultantName": "string",
"interventionId": "string",
"interventionTitle": "string",
"type": "string",
"targetType": "string",
"targetValue": "string",
"targetMetric": ["string", "object"],
"dueDate": "object",
"userStatus": "string",
"consultantStatus": "string",
"userCompletionStatus": "string",
"consultantCompletionStatus": "string",
"operationsCompletionStatus": "string",
"createdAt": "object",
"updatedAt": ["object", "string"],
"notes": "string",
"feedback": "object",
"resources": "object",
"timeSpent": "number",
"progress": "number",
"status": "string",
"rejectionReason": "string",
"$aliases": {
"state": "status",
"assignmentId": "id",
"userId": "participantId",
"clientName": "beneficiaryName",
"advisorId": "consultantId",
"advisorName": "consultantName",
"taskId": "interventionId",
"taskTitle": "interventionTitle",
"deadline": "dueDate",
"clientStatus": "userStatus",
"advisorStatus": "consultantStatus",
"completionStatus": "userCompletionStatus",
"advisorCompletionStatus": "consultantCompletionStatus",
"opsStatus": "operationsCompletionStatus",
"modifiedAt": "updatedAt",
"comments": "notes",
"duration": "timeSpent",
},
},
"branches": {
"name": "string",
"code": "string",
"companyCode": "string",
"location": "object",
"contact": "object",
"status": "string",
"capacity": "object",
"isActive": "boolean",
"createdBy": "string",
"createdAt": "object",
"updatedAt": "object",
"$aliases": {
"branchName": "name",
"branchCode": "code",
"orgCode": "companyCode",
"address": "location",
"contactInfo": "contact",
"active": "isActive",
"creator": "createdBy",
"establishedAt": "createdAt",
"modifiedAt": "updatedAt",
},
},
"consultants": {
"name": "string",
"email": "string",
"expertise": "object",
"rate": "string",
"assignmentsCount": "number",
"rating": "number",
"active": "boolean",
"authUid": "string",
"companyCode": "string",
"createdAt": "string",
"$aliases": {
"consultantName": "name",
"hourlyRate": "rate",
"tasksCount": "assignmentsCount",
"score": "rating",
"isActive": "active",
"userId": "authUid",
"orgCode": "companyCode",
"joinedAt": "createdAt",
"skills": "expertise",
},
},
"departments": {
"id": "string",
"name": "string",
"isMain": "boolean",
"companyCode": "string",
"createdAt": ["object", "string"],
"departmentId": "string",
"$aliases": {
"deptId": "id",
"deptName": "name",
"primary": "isMain",
"orgCode": "companyCode",
"establishedAt": "createdAt",
"internalId": "departmentId",
},
},
"events": {
"id": "string",
"title": "string",
"date": "string",
"time": ["string", "object"],
"type": "string",
"createdAt": "object",
"$aliases": {
"eventId": "id",
"name": "title",
"eventDate": "date",
"eventTime": "time",
"eventType": "type",
"scheduledAt": "createdAt",
},
},
"expenseTypes": {
"name": "string",
"budget": "number",
"companyCode": "string",
"createdAt": "string",
"$aliases": {
"expenseCategory": "name",
"allocatedAmount": "budget",
"orgCode": "companyCode",
"addedAt": "createdAt",
},
},
"feedbacks": {
"participantId": "string",
"smeName": "string",
"consultantId": "string",
"interventionTitle": "string",
"comment": "string",
"createdAt": "object",
"$aliases": {
"userId": "participantId",
"expertName": "smeName",
"advisorId": "consultantId",
"taskTitle": "interventionTitle",
"feedbackText": "comment",
"submittedAt": "createdAt",
},
},
"financial_statements": {
"statement_type": "string",
"start_date": "string",
"end_date": "string",
"report": "string",
"business_id": "string",
"created_at": "object",
"$aliases": {
"type": "statement_type",
"from_date": "start_date",
"to_date": "end_date",
"document": "report",
"company_id": "business_id",
"generated_at": "created_at",
},
},
"interventionRequests": {
"participantId": "string",
"areaOfSupport": "string",
"interventionTitle": "string",
"reason": "string",
"status": "string",
"createdAt": "object",
"$aliases": {
"state": "status",
"userId": "participantId",
"supportArea": "areaOfSupport",
"requestTitle": "interventionTitle",
"justification": "reason",
"requestedAt": "createdAt",
},
},
"interventions": {
"interventionTitle": "string",
"areaOfSupport": "string",
"id": "string",
"companyCode": "string",
"createdAt": "string",
"departmentName": "string",
"departmentId": "string",
"isCompulsory": "string",
"isRecurring": "string",
"$aliases": {
"title": "interventionTitle",
"supportType": "areaOfSupport",
"interventionId": "id",
"orgCode": "companyCode",
"addedAt": "createdAt",
"deptName": "departmentName",
"deptId": "departmentId",
"required": "isCompulsory",
"repeating": "isRecurring",
},
},
"interventionsDatabase": {
"programId": "string",
"companyCode": "string",
"interventionId": "string",
"interventionTitle": "string",
"areaOfSupport": "string",
"participantId": "string",
"beneficiaryName": "string",
"hub": "string",
"province": "string",
"quarter": "string",
"consultantId": ["string", "object"],
"consultantIds": "object",
"timeSpent": ["number", "object"],
"interventionType": "string",
"targetMetric": ["string", "object"],
"targetType": "string",
"targetValue": ["string", "number"],
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"interventionKey": "string",
"resources": "object",
"$aliases": {
"projectId": "programId",
"orgCode": "companyCode",
"taskId": "interventionId",
"title": "interventionTitle",
"supportArea": "areaOfSupport",
"userId": "participantId",
"clientName": "beneficiaryName",
"location": "hub",
"region": "province",
"period": "quarter",
"advisorId": "consultantId",
"advisorIds": "consultantIds",
"duration": "timeSpent",
"taskType": "interventionType",
"metric": "targetMetric",
"goalType": "targetType",
"goalValue": "targetValue",
"approvedAt": "confirmedAt",
"addedAt": "createdAt",
"modifiedAt": "updatedAt",
"uniqueKey": "interventionKey",
"materials": "resources",
},
},
"kpiDefinitions": {
"id": "string",
"department": "string",
"kpiLabel": "string",
"unit": "string",
"target": "number",
"manualTags": "object",
"metrics": "object",
"category": "string",
"createdAt": "object",
"active": "boolean",
"$aliases": {
"kpiId": "id",
"dept": "department",
"name": "kpiLabel",
"measurement": "unit",
"goal": "target",
"tags": "manualTags",
"dimensions": "metrics",
"type": "category",
"addedAt": "createdAt",
"isActive": "active",
},
},
"kpiEntries": {
"kpiId": "string",
"department": "string",
"reportMonth": "string",
"value": "number",
"unit": "string",
"kpiLabel": "string",
"tags": "object",
"createdAt": "object",
"submittedBy": "string",
"$aliases": {
"metricId": "kpiId",
"dept": "department",
"month": "reportMonth",
"amount": "value",
"measurement": "unit",
"name": "kpiLabel",
"categories": "tags",
"recordedAt": "createdAt",
"reporter": "submittedBy",
},
},
"programs": {
"name": "string",
"type": "string",
"cohortYear": "string",
"assignedAdmin": ["string", "object"],
"id": "string",
"companyCode": "string",
"onboardingQuestions": "object",
"registrationLink": "string",
"endDate": "object",
"maxCapacity": "number",
"startDate": "object",
"status": "string",
"eligibilityCriteria": "object",
"budget": "number",
"description": "string",
"$aliases": {
"state": "status",
"programName": "name",
"programType": "type",
"batchYear": "cohortYear",
"admin": "assignedAdmin",
"programId": "id",
"orgCode": "companyCode",
"questions": "onboardingQuestions",
"regLink": "registrationLink",
"completionDate": "endDate",
"capacity": "maxCapacity",
"launchDate": "startDate",
"requirements": "eligibilityCriteria",
"funding": "budget",
"overview": "description",
},
},
"logs": {
"id": "string",
"action": "string",
"actorId": "string",
"actorRole": "string",
"message": "string",
"collection": "string",
"docId": "string",
"timestamp": "object",
"$aliases": {
"logId": "id",
"operation": "action",
"userId": "actorId",
"userRole": "actorRole",
"logMessage": "message",
"table": "collection",
"documentId": "docId",
"createdAt": "timestamp",
"eventTime": "timestamp",
"recordedAt": "timestamp",
},
},
"notifications": {
"id": "string",
"participantId": "string",
"consultantId": "string",
"interventionId": "string",
"interventionTitle": "string",
"type": "string",
"recipientRoles": "object",
"message": "object",
"createdAt": "object",
"readBy": "object",
"$aliases": {
"notificationId": "id",
"userId": "participantId",
"advisorId": "consultantId",
"taskId": "interventionId",
"taskTitle": "interventionTitle",
"notificationType": "type",
"audience": "recipientRoles",
"content": "message",
"sentAt": "createdAt",
"readReceipts": "readBy",
"acknowledgedBy": "readBy",
},
},
"operationsStaff": {
"email": "string",
"name": "string",
"gender": "string",
"phone": "string",
"companyCode": "string",
"$aliases": {
"staffEmail": "email",
"staffName": "name",
"contactNumber": "phone",
"orgCode": "companyCode",
"sex": "gender",
"mobile": "phone",
"employeeName": "name",
},
},
"participants": {
"participantName": "string",
"email": "string",
"beneficiaryName": "string",
"gender": "string",
"idNumber": "string",
"phone": "string",
"sector": "string",
"natureOfBusiness": "string",
"beeLevel": "number",
"youthOwnedPercent": "number",
"femaleOwnedPercent": "number",
"blackOwnedPercent": "number",
"dateOfRegistration": "object",
"yearsOfTrading": "number",
"registrationNumber": "string",
"businessAddress": "string",
"city": "string",
"postalCode": "string",
"province": "string",
"hub": "string",
"location": "string",
"revenueHistory": "object",
"headcountHistory": "object",
"setup": "boolean",
"updatedAt": "object",
"logoUrl": "string",
"$aliases": {
"name": "participantName",
"contactEmail": "email",
"clientName": "beneficiaryName",
"sex": "gender",
"identification": "idNumber",
"mobile": "phone",
"industry": "sector",
"businessType": "natureOfBusiness",
"BEE": "beeLevel",
"youthOwnership": "youthOwnedPercent",
"femaleOwnership": "femaleOwnedPercent",
"blackOwnership": "blackOwnedPercent",
"regDate": "dateOfRegistration",
"experience": "yearsOfTrading",
"regNo": "registrationNumber",
"address": "businessAddress",
"town": "city",
"zipCode": "postalCode",
"region": "province",
"center": "hub",
"coordinates": "location",
"financials": "revenueHistory",
"staffing": "headcountHistory",
"isConfigured": "setup",
"modifiedAt": "updatedAt",
"logo": "logoUrl",
"avatar": "logoUrl",
},
},
"programExpenses": {
"programId": "string",
"expenseType": "string",
"amount": "number",
"createdAt": "string",
"$aliases": {
"projectId": "programId",
"category": "expenseType",
"cost": "amount",
"recordedAt": "createdAt",
"spentAt": "createdAt",
"value": "amount",
"expenseCategory": "expenseType",
},
},
"resourceAllocations": {
"id": "string",
"resourceId": "string",
"allocatedTo": "string",
"purpose": "string",
"startTime": "object",
"endTime": "object",
"quantity": "number",
"status": "string",
"$aliases": {
"allocationId": "id",
"assetId": "resourceId",
"assignedTo": "allocatedTo",
"reason": "purpose",
"begin": "startTime",
"finish": "endTime",
"amount": "quantity",
"state": "status",
"allocationStart": "startTime",
"allocationEnd": "endTime",
"qty": "quantity",
"currentStatus": "status",
},
},
"supportPrograms": {
"participantId": "string",
"programName": "string",
"programType": "string",
"startDate": "object",
"endDate": "object",
"description": "string",
"budget": "number",
"status": "string",
"outcomes": "object",
"createdBy": "string",
"createdAt": "object",
"$aliases": {
"state": "status",
"userId": "participantId",
"name": "programName",
"type": "programType",
"launchDate": "startDate",
"completionDate": "endDate",
"overview": "description",
"funding": "budget",
"results": "outcomes",
"initiator": "createdBy",
"establishedAt": "createdAt",
"clientId": "participantId",
"programBudget": "budget",
},
},
"tasks": {
"id": "string",
"title": "string",
"dueDate": "object",
"priority": "string",
"status": "string",
"createdAt": "object",
"assignedRole": "string",
"assignedTo": "string",
"department": "object",
"companyCode": "string",
"$aliases": {
"state": "status",
"taskId": "id",
"name": "title",
"deadline": "dueDate",
"importance": "priority",
"createdAt": "createdAt",
"role": "assignedRole",
"assignee": "assignedTo",
"dept": "department",
"orgCode": "companyCode",
"currentStatus": "status",
"targetDate": "dueDate",
"owner": "assignedTo",
},
},
"transactions": {
"Customer_name": "string",
"City": "string",
"Amount": "number",
"Type": "string",
"Date": "object",
"business_id": "string",
"Category_of_expense": "string",
"Description": "string",
"$aliases": {
"clientName": "Customer_name",
"location": "City",
"value": "Amount",
"transactionType": "Type",
"transactionDate": "Date",
"companyId": "business_id",
"expenseCategory": "Category_of_expense",
"details": "Description",
"customer": "Customer_name",
"town": "City",
"sum": "Amount",
"txnType": "Type",
"recordedAt": "Date",
"merchantId": "business_id",
"category": "Category_of_expense",
"notes": "Description",
},
},
"users": {
"uid": "string",
"name": "string",
"email": "string",
"role": "string",
"companyCode": "string",
"createdAt": "string",
"$aliases": {
"userId": "uid",
"username": "name",
"userEmail": "email",
"permissionLevel": "role",
"orgCode": "companyCode",
"registeredAt": "createdAt",
"displayName": "name",
"authId": "uid",
"accessLevel": "role",
"joinedAt": "createdAt",
},
},
}