To see ChoiceField choices, click on Choices
In choices you'll see 2 things: "value" and "meaning".
"Meaning" is human-understandable description of value. It's used only for choice field rendering, but doesn't take any part in logic/data processing.
{
"profile":{response fields below},
"token":{..}
}
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyPostRequests | Custom permission to allow only GET requests. |
| Param name | Description |
|---|---|
| password | Password |
| last_login | Last Login |
| is_superuser | Is Superuser |
| groups | Groups |
| user_permissions | User Permissions |
| username | Username |
| first_name | First Name |
| last_name | Last Name |
| is_staff | Is Staff |
| is_active | Is Active |
| date_joined | Date Joined |
| last_activity | Last Activity |
| role | Role |
| phone | Phone |
| google_profile_image | Google Profile Image |
| confirm_code | Confirm Code |
| reset_code | Reset Code |
| old_password | Old Password |
| changed_password | Changed Password |
| verified | Verified |
| dummy | Dummy |
| available | Available |
| dob | Dob |
| gender | Gender |
| allow_messages_import | Allow Messages Import |
| filter_args | Filter Args |
| novu_added | Novu Added |
| min_subscription_days_remaining | Min Subscription Days Remaining |
| max_subscription_days_remaining | Max Subscription Days Remaining |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSafariNjemaCustomerCareOrAdmin | A base class from which all permission classes should inherit. |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Expects a POST with JSON: { "access_token": "<google_access_token>" }
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Expects a POST with JSON: { "identity_token": "<APPLE_IDENTITY_TOKEN>" }
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Group My User statistics by:type = id, month_joined, month, year, day
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperUser | A base class from which all permission classes should inherit. |
| Param name | Description |
|---|---|
| password | Password |
| last_login | Last Login |
| is_superuser | Is Superuser |
| groups | Groups |
| user_permissions | User Permissions |
| username | Username |
| first_name | First Name |
| last_name | Last Name |
| is_staff | Is Staff |
| is_active | Is Active |
| date_joined | Date Joined |
| last_activity | Last Activity |
| role | Role |
| phone | Phone |
| google_profile_image | Google Profile Image |
| confirm_code | Confirm Code |
| reset_code | Reset Code |
| old_password | Old Password |
| changed_password | Changed Password |
| verified | Verified |
| dummy | Dummy |
| available | Available |
| dob | Dob |
| gender | Gender |
| allow_messages_import | Allow Messages Import |
| filter_args | Filter Args |
| novu_added | Novu Added |
| min_subscription_days_remaining | Min Subscription Days Remaining |
| max_subscription_days_remaining | Max Subscription Days Remaining |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperUser | A base class from which all permission classes should inherit. |
| Param name | Description |
|---|---|
| password | Password |
| last_login | Last Login |
| is_superuser | Is Superuser |
| groups | Groups |
| user_permissions | User Permissions |
| username | Username |
| first_name | First Name |
| last_name | Last Name |
| is_staff | Is Staff |
| is_active | Is Active |
| date_joined | Date Joined |
| last_activity | Last Activity |
| role | Role |
| phone | Phone |
| google_profile_image | Google Profile Image |
| confirm_code | Confirm Code |
| reset_code | Reset Code |
| old_password | Old Password |
| changed_password | Changed Password |
| verified | Verified |
| dummy | Dummy |
| available | Available |
| dob | Dob |
| gender | Gender |
| allow_messages_import | Allow Messages Import |
| filter_args | Filter Args |
| novu_added | Novu Added |
| min_subscription_days_remaining | Min Subscription Days Remaining |
| max_subscription_days_remaining | Max Subscription Days Remaining |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
API endpoint to recreate the Pro Trial topic in Novu.
This endpoint will:
1. Delete the existing topic (specified by topic_key query param)
2. Find all Pro Trial users
3. Add them to the recreated topic
Query Parameters:
- topic_key (required): The topic key to recreate (e.g., 'trial', 'pro-trial-users')
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSuperUser | A base class from which all permission classes should inherit. |
API endpoint to create a Novu topic based on date, name, and app version.
This endpoint will:
1. Generate a unique topic key from date, name, and app version
2. Delete the existing topic if it exists
3. Create a new topic in Novu
4. Find all users that joined on or before the specified date
5. Add them to the new topic
Request Body:
- date (optional): The date to filter users (format: YYYY-MM-DD, defaults to today)
- app_version (required): The app version for the topic
- name (optional): The name for the topic (defaults to 'feature-release')
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSuperUser | A base class from which all permission classes should inherit. |
API endpoint to trigger a Novu workflow for users or customers.
This endpoint will:
1. Validate the request data
2. Schedule a background task to trigger the workflow (immediately or at specified time)
3. Return immediate confirmation
The background task will:
- If target_ids provided: trigger workflow for each specified target
- If target_ids not provided: filter targets by date and trigger workflow for each
- Wait 10 seconds between each target workflow trigger
Request Body:
- workflow_key (required): The workflow identifier to trigger
- target_type (required): 'users' or 'customers'
- target_ids (optional): List of target IDs to trigger workflow for
- user_ids (optional): List of user IDs (deprecated, use target_ids with target_type='users')
- date (optional): Date filter for targets (format: YYYY-MM-DD)
- payload (optional): Additional payload data for the workflow
- scheduled_at (optional): Schedule the workflow to run at a specific datetime (with timezone info). Defaults to immediate execution.
Customer Notes:
- Customers must belong to the requesting user's account
- Customer IDs are used as integers in the API, but prefixed with "CT" for Novu
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| IsSuperUser | A base class from which all permission classes should inherit. |
| Value | Meaning |
|---|---|
| users | Users |
| customers | Customers |
| Value | Meaning |
|---|---|
| users | Users |
| customers | Customers |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| number | Number |
| name | Name |
| user | User |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| start_date | Start Date |
| end_date | End Date |
| account | Account |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
Group statistics by:type = id, receive, send, trans_type, month, year, day
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| updated_by | Updated By |
| amount | Amount |
| trans_type | Trans Type |
| code | Code |
| balance | Balance |
| receiver_name | Receiver Name |
| receiver_account | Receiver Account |
| sender_account | Sender Account |
| sender_name | Sender Name |
| fee | Fee |
| time | Time |
| date | Date |
| created_by | Created By |
| mpesa_type | Mpesa Type |
| mpesa_wallet_number | Mpesa Wallet Number |
| account_id | Account Id |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| Value | Meaning |
|---|---|
| SEND_MONEY | Send Money |
| RECEIVE_MONEY | Receive Money |
| DEPOSIT | Deposit Money |
| PAYBILL | Pay Bill |
| PAYBILL_RECEIVE | Paybill Receive |
| PAYBILL_DEPOSIT_BANK | Paybill to Bank |
| BUY_GOODS | Buy Goods |
| WITHDRAWAL | Withdrawal Money |
| DEPOSIT_MSHwARI | Deposit Mshwari |
| WITHDRAWAL_MSHWARI | Withdrawal Mshwari |
| FULIZA | Fuliza |
| BUY_AIRTIME | Buy Airtime |
| MPESA_BALANCE | Check Balance |
| REVERSAL | REVERSAL |
| BUY_AIRTIME_ANOTHER | Reversal |
| MSHWARI_LOAN_REQUEST | Mswhari Loan Request |
| MSHWARI_LOAN_PAYMENT | Mshwari Loan payment |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| Value | Meaning |
|---|---|
| SEND_MONEY | Send Money |
| RECEIVE_MONEY | Receive Money |
| DEPOSIT | Deposit Money |
| PAYBILL | Pay Bill |
| PAYBILL_RECEIVE | Paybill Receive |
| PAYBILL_DEPOSIT_BANK | Paybill to Bank |
| BUY_GOODS | Buy Goods |
| WITHDRAWAL | Withdrawal Money |
| DEPOSIT_MSHwARI | Deposit Mshwari |
| WITHDRAWAL_MSHWARI | Withdrawal Mshwari |
| FULIZA | Fuliza |
| BUY_AIRTIME | Buy Airtime |
| MPESA_BALANCE | Check Balance |
| REVERSAL | REVERSAL |
| BUY_AIRTIME_ANOTHER | Reversal |
| MSHWARI_LOAN_REQUEST | Mswhari Loan Request |
| MSHWARI_LOAN_PAYMENT | Mshwari Loan payment |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| updated_by | Updated By |
| amount | Amount |
| trans_type | Trans Type |
| code | Code |
| balance | Balance |
| receiver_name | Receiver Name |
| receiver_account | Receiver Account |
| sender_account | Sender Account |
| sender_name | Sender Name |
| fee | Fee |
| time | Time |
| date | Date |
| created_by | Created By |
| mpesa_type | Mpesa Type |
| mpesa_wallet_number | Mpesa Wallet Number |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| Value | Meaning |
|---|---|
| SEND_MONEY | Send Money |
| RECEIVE_MONEY | Receive Money |
| DEPOSIT | Deposit Money |
| PAYBILL | Pay Bill |
| PAYBILL_RECEIVE | Paybill Receive |
| PAYBILL_DEPOSIT_BANK | Paybill to Bank |
| BUY_GOODS | Buy Goods |
| WITHDRAWAL | Withdrawal Money |
| DEPOSIT_MSHwARI | Deposit Mshwari |
| WITHDRAWAL_MSHWARI | Withdrawal Mshwari |
| FULIZA | Fuliza |
| BUY_AIRTIME | Buy Airtime |
| MPESA_BALANCE | Check Balance |
| REVERSAL | REVERSAL |
| BUY_AIRTIME_ANOTHER | Reversal |
| MSHWARI_LOAN_REQUEST | Mswhari Loan Request |
| MSHWARI_LOAN_PAYMENT | Mshwari Loan payment |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| Value | Meaning |
|---|---|
| SEND_MONEY | Send Money |
| RECEIVE_MONEY | Receive Money |
| DEPOSIT | Deposit Money |
| PAYBILL | Pay Bill |
| PAYBILL_RECEIVE | Paybill Receive |
| PAYBILL_DEPOSIT_BANK | Paybill to Bank |
| BUY_GOODS | Buy Goods |
| WITHDRAWAL | Withdrawal Money |
| DEPOSIT_MSHwARI | Deposit Mshwari |
| WITHDRAWAL_MSHWARI | Withdrawal Mshwari |
| FULIZA | Fuliza |
| BUY_AIRTIME | Buy Airtime |
| MPESA_BALANCE | Check Balance |
| REVERSAL | REVERSAL |
| BUY_AIRTIME_ANOTHER | Reversal |
| MSHWARI_LOAN_REQUEST | Mswhari Loan Request |
| MSHWARI_LOAN_PAYMENT | Mshwari Loan payment |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| AllowOnlyGetRequests | Custom permission to allow only GET requests. |
| AllowDeleteIfOwnerOnlyGetRequests | Custom permission to allow only GET requests. |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyGetRequests | Custom permission to allow only GET requests. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| mpesa_code | Mpesa Code |
| custom_name | Custom Name |
| trans_type | Trans Type |
| account | Account |
| amount | Amount |
| sub_category | Sub Category |
| tags | Tags |
| usage_count | Usage Count |
| user | User |
| confidence_score | Confidence Score |
| source | Source |
| last_updated | Last Updated |
| mpesa_type | Mpesa Type |
| use_account | Use Account |
| start_date | Start Date |
| end_date | End Date |
| recommend_system | Recommend System |
| is_system_tag | Is System Tag |
| min_confidence_score | Min Confidence Score |
| max_confidence_score | Max Confidence Score |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| mpesa_code | Mpesa Code |
| custom_name | Custom Name |
| trans_type | Trans Type |
| account | Account |
| amount | Amount |
| sub_category | Sub Category |
| tags | Tags |
| usage_count | Usage Count |
| user | User |
| confidence_score | Confidence Score |
| source | Source |
| last_updated | Last Updated |
| mpesa_type | Mpesa Type |
| use_account | Use Account |
| start_date | Start Date |
| end_date | End Date |
| recommend_system | Recommend System |
| is_system_tag | Is System Tag |
| min_confidence_score | Min Confidence Score |
| max_confidence_score | Max Confidence Score |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
Group My User statistics by:type = id, month, year, day, day-of-week, iso-day-of-week, time-of-day, user, name-category, name, name-sub-category, sub-category, category
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| mpesa_code | Mpesa Code |
| custom_name | Custom Name |
| trans_type | Trans Type |
| account | Account |
| amount | Amount |
| sub_category | Sub Category |
| tags | Tags |
| usage_count | Usage Count |
| user | User |
| confidence_score | Confidence Score |
| source | Source |
| last_updated | Last Updated |
| mpesa_type | Mpesa Type |
| use_account | Use Account |
| start_date | Start Date |
| end_date | End Date |
| recommend_system | Recommend System |
| is_system_tag | Is System Tag |
| min_confidence_score | Min Confidence Score |
| max_confidence_score | Max Confidence Score |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| mpesa_code | Mpesa Code |
| custom_name | Custom Name |
| trans_type | Trans Type |
| account | Account |
| amount | Amount |
| sub_category | Sub Category |
| tags | Tags |
| usage_count | Usage Count |
| user | User |
| confidence_score | Confidence Score |
| source | Source |
| last_updated | Last Updated |
| mpesa_type | Mpesa Type |
| use_account | Use Account |
| start_date | Start Date |
| end_date | End Date |
| recommend_system | Recommend System |
| is_system_tag | Is System Tag |
| min_confidence_score | Min Confidence Score |
| max_confidence_score | Max Confidence Score |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| mpesa_code | Mpesa Code |
| custom_name | Custom Name |
| trans_type | Trans Type |
| account | Account |
| amount | Amount |
| sub_category | Sub Category |
| tags | Tags |
| usage_count | Usage Count |
| user | User |
| confidence_score | Confidence Score |
| source | Source |
| last_updated | Last Updated |
| mpesa_type | Mpesa Type |
| use_account | Use Account |
| start_date | Start Date |
| end_date | End Date |
| recommend_system | Recommend System |
| is_system_tag | Is System Tag |
| min_confidence_score | Min Confidence Score |
| max_confidence_score | Max Confidence Score |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
| Value | Meaning |
|---|---|
| D | Deposit |
| W | Withdrawal |
| B | Both |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| user | User |
| activity | Activity |
| transaction | Transaction |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyGetRequests | Custom permission to allow only GET requests. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| description | Description |
| name | Name |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyGetRequests | Custom permission to allow only GET requests. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| description | Description |
| name | Name |
| budget_category | Budget Category |
| category | Category |
| user | User |
| cost_behaviour | Cost Behaviour |
| frequency | Frequency |
| Value | Meaning |
|---|---|
| wants | Wants |
| needs | Needs |
| s_v | Savings & Investments |
| income | Income |
| Value | Meaning |
|---|---|
| fixed | Fixed |
| variable | Variable |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
| daily | Daily |
| quarterly | Quarterly |
| yearly | Yearly |
| Value | Meaning |
|---|---|
| wants | Wants |
| needs | Needs |
| s_v | Savings & Investments |
| income | Income |
| Value | Meaning |
|---|---|
| fixed | Fixed |
| variable | Variable |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
| daily | Daily |
| quarterly | Quarterly |
| yearly | Yearly |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| wants | Wants |
| needs | Needs |
| s_v | Savings & Investments |
| income | Income |
| Value | Meaning |
|---|---|
| fixed | Fixed |
| variable | Variable |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
| daily | Daily |
| quarterly | Quarterly |
| yearly | Yearly |
| Value | Meaning |
|---|---|
| wants | Wants |
| needs | Needs |
| s_v | Savings & Investments |
| income | Income |
| Value | Meaning |
|---|---|
| fixed | Fixed |
| variable | Variable |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
| daily | Daily |
| quarterly | Quarterly |
| yearly | Yearly |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| description | Description |
| types | Types |
| nickname | Nickname |
| name | Name |
| number | Number |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| account | Account |
| user | User |
| role | Role |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| O | Owner |
| V | View Only |
| E | Editor |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| P | Personal |
| B | Business |
| C | Contributions |
| Value | Meaning |
|---|---|
| N | Normal |
| A | Admin |
| C | Customer Care |
| T | Technician |
| Value | Meaning |
|---|---|
| M | Male |
| F | Female |
| RNS | Rather Not Say |
| Value | Meaning |
|---|---|
| O | Owner |
| V | View Only |
| E | Editor |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| device_id | Device Id |
| description | Description |
| user | User |
| sms_support | Sms Support |
| device_type | Device Type |
| is_primary_device | Is Primary Device |
| is_verifed | Is Verifed |
| android_version | Android Version |
| android_version_name | Android Version Name |
| push_token | Push Token |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| hash | Hash |
| message | Message |
| address | Address |
| date | Date |
| receive_date | Receive Date |
| transaction_created | Transaction Created |
| is_supported | Is Supported |
| source | Source |
| device | Device |
| device_user | Device User |
| Value | Meaning |
|---|---|
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
| Value | Meaning |
|---|---|
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
| Value | Meaning |
|---|---|
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| account | Account |
| first_name | First Name |
| last_name | Last Name |
| phone | Phone |
| last_visit_date | Last Visit Date |
| last_transaction_spent | Last Transaction Spent |
| visits | Visits |
| status | Status |
| min_visits | Min Visits |
| max_visits | Max Visits |
| Value | Meaning |
|---|---|
| A | All |
| B | Blacklist |
| N | Don't Send Sms |
| Value | Meaning |
|---|---|
| A | All |
| B | Blacklist |
| N | Don't Send Sms |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| A | All |
| B | Blacklist |
| N | Don't Send Sms |
| Value | Meaning |
|---|---|
| A | All |
| B | Blacklist |
| N | Don't Send Sms |
API endpoint to import customers from CSV file.
Expected CSV format:
first_name,last_name,email,phone,shop_name
John,Doe,john@example.com,+254123456789,Shop A
Jane,Smith,jane@example.com,+254987654321,Shop B
The import runs as a background task to handle large files efficiently.
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
API endpoint to retrieve import progress by ID
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| pending | Pending |
| processing | Processing |
| completed | Completed |
| failed | Failed |
API endpoint to list import progress history for the authenticated user
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| pending | Pending |
| processing | Processing |
| completed | Completed |
| failed | Failed |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| customer | Customer |
| date | Date |
| account_id | Account Id |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| account | Account |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| group | Group |
| customer | Customer |
| customer_first_name | Customer First Name |
| customer_last_name | Customer Last Name |
| customer_name | Customer Name |
| customer_phone | Customer Phone |
| account_id | Account Id |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| visit | Visit |
| amount | Amount |
| fee | Fee |
| payment_method | Payment Method |
| source | Source |
| description | Description |
| payment_phone | Payment Phone |
| code | Code |
| payment_name | Payment Name |
| account_id | Account Id |
| phone | Phone |
| name | Name |
| start_date | Start Date |
| end_date | End Date |
| min_amount | Min Amount |
| max_amount | Max Amount |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
Group statistics by:type = id, customer, month, year, day
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| visit | Visit |
| amount | Amount |
| fee | Fee |
| payment_method | Payment Method |
| source | Source |
| description | Description |
| payment_phone | Payment Phone |
| code | Code |
| payment_name | Payment Name |
| account_id | Account Id |
| phone | Phone |
| name | Name |
| start_date | Start Date |
| end_date | End Date |
| min_amount | Min Amount |
| max_amount | Max Amount |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| visit | Visit |
| amount | Amount |
| fee | Fee |
| payment_method | Payment Method |
| source | Source |
| description | Description |
| payment_phone | Payment Phone |
| code | Code |
| payment_name | Payment Name |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
| Value | Meaning |
|---|---|
| MPS | Mpesa |
| CSH | Cash |
| CRD | Card |
| Value | Meaning |
|---|---|
| AP | Wavvy App |
| DH | Dashboard |
| NA | Not Available |
| CAF | Customer App Foreground |
| CAB | Customer App Background |
| CAS | Customer App Manual Sync |
| BAF | Business App Foreground |
| BAB | Business App Background |
| BAS | Business App Manual Sync |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| account | Account |
| template | Template |
| group | Group |
| group_tag | Group Tag |
| send_now | Send Now |
| status | Status |
| failed_reason | Failed Reason |
| sent | Sent |
| Value | Meaning |
|---|---|
| AL | All |
| AR | Active Return |
| AF | Active First Timer |
| IR | In Active Return |
| IF | In Active First Timer |
| Value | Meaning |
|---|---|
| AL | All |
| AR | Active Return |
| AF | Active First Timer |
| IR | In Active Return |
| IF | In Active First Timer |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| AL | All |
| AR | Active Return |
| AF | Active First Timer |
| IR | In Active Return |
| IF | In Active First Timer |
| Value | Meaning |
|---|---|
| AL | All |
| AR | Active Return |
| AF | Active First Timer |
| IR | In Active Return |
| IF | In Active First Timer |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| campaign | Campaign |
| customer | Customer |
| message | Message |
| send_now | Send Now |
| phone | Phone |
| status | Status |
| failed_reason | Failed Reason |
| account_id | Account Id |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| url | Url |
| token | Token |
| sms_sender_address | Sms Sender Address |
| regex | Regex |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| value | Value |
| group | Group |
| regex | Regex |
| active | Active |
| extra_regex | Extra Regex |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| sub_category | Sub Category |
| user | User |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| country_code | Country Code |
| language_code | Language Code |
| version | Version |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| country_code | Country Code |
| language_code | Language Code |
| version | Version |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| title | Title |
| description | Description |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| locale | Locale |
| text | Text |
| translated_text | Translated Text |
| not_translated | Not Translated |
| original | Original |
Group statistics by:
`type` = {stat_types}
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| locale | Locale |
| text | Text |
| translated_text | Translated Text |
| not_translated | Not Translated |
| original | Original |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAdminOrReadOnly | The request is authenticated as a user, or is a read-only request. |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAdminOrReadOnly | The request is authenticated as a user, or is a read-only request. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| amount | Amount |
| discount | Discount |
| hidden | Hidden |
| interval | Interval |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
| Value | Meaning |
|---|---|
| weekly | Weekly |
| monthly | Monthly |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| reference_number | Reference Number |
| payment_for | Payment For |
| phone_number | Phone Number |
| phone_number_hash | Phone Number Hash |
| phone_number_paid | Phone Number Paid |
| phone_number_paid_hash | Phone Number Paid Hash |
| transaction_id | Transaction Id |
| amount | Amount |
| amount_paid | Amount Paid |
| transaction_date | Transaction Date |
| request_trans_time | Request Trans Time |
| initiated | Initiated |
| completed | Completed |
| request_code | Request Code |
| request_description | Request Description |
| result_code | Result Code |
| result_description | Result Description |
| subscription | Subscription |
| plan | Plan |
| plan_quantity | Plan Quantity |
| purchase | Purchase |
| transaction_type | Transaction Type |
| stk_triggered | Stk Triggered |
| status | Status |
| checkout_request_id | Checkout Request Id |
| first_name | First Name |
| middle_name | Middle Name |
| last_name | Last Name |
| trans_time | Trans Time |
| confirmed | Confirmed |
| Value | Meaning |
|---|---|
| P | Product |
| S | Subscription |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| customer | Customer |
| start_date | Start Date |
| next_payment_date | Next Payment Date |
| is_active | Is Active |
| latest_payment | Latest Payment |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Value | Meaning |
|---|---|
| P | Product |
| S | Subscription |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| P | Product |
| S | Subscription |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperuserOrProductOwner | Custom permission that allows: |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperuserOrProductOwner | Custom permission that allows: |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| nickaname | Nickaname |
| description | Description |
| active | Active |
| product | Product |
| sku | Sku |
| attributes | Attributes |
| price | Price |
| discount | Discount |
| initial_stock | Initial Stock |
| stock | Stock |
| low_stock_threshold | Low Stock Threshold |
| shop | Shop |
| thumbnail_url | Thumbnail Url |
| poster_url | Poster Url |
| preview_url | Preview Url |
| sprites_url | Sprites Url |
| main_file | Main File |
| product_sub_category | Product Sub Category |
| product_category | Product Category |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| title | Title |
| phone | Phone |
| status | Status |
| created_at | Created At |
| updated_at | Updated At |
| current_payment | Current Payment |
| source | Source |
| device | Device |
| ip_address | Ip Address |
| delivery_address | Delivery Address |
| notes | Notes |
| user | User |
| service_fee | Service Fee |
| delivery_fee | Delivery Fee |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| title | Title |
| phone | Phone |
| status | Status |
| created_at | Created At |
| updated_at | Updated At |
| current_payment | Current Payment |
| source | Source |
| device | Device |
| ip_address | Ip Address |
| delivery_address | Delivery Address |
| notes | Notes |
| user | User |
| service_fee | Service Fee |
| delivery_fee | Delivery Fee |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
Group statistics by:
`type` = {stat_types}
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| title | Title |
| phone | Phone |
| status | Status |
| created_at | Created At |
| updated_at | Updated At |
| current_payment | Current Payment |
| source | Source |
| device | Device |
| ip_address | Ip Address |
| delivery_address | Delivery Address |
| notes | Notes |
| user | User |
| service_fee | Service Fee |
| delivery_fee | Delivery Fee |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| reference_number | Reference Number |
| payment_for | Payment For |
| phone_number | Phone Number |
| phone_number_hash | Phone Number Hash |
| phone_number_paid | Phone Number Paid |
| phone_number_paid_hash | Phone Number Paid Hash |
| transaction_id | Transaction Id |
| amount | Amount |
| amount_paid | Amount Paid |
| transaction_date | Transaction Date |
| request_trans_time | Request Trans Time |
| initiated | Initiated |
| completed | Completed |
| request_code | Request Code |
| request_description | Request Description |
| result_code | Result Code |
| result_description | Result Description |
| subscription | Subscription |
| plan | Plan |
| plan_quantity | Plan Quantity |
| purchase | Purchase |
| transaction_type | Transaction Type |
| stk_triggered | Stk Triggered |
| status | Status |
| checkout_request_id | Checkout Request Id |
| first_name | First Name |
| middle_name | Middle Name |
| last_name | Last Name |
| trans_time | Trans Time |
| confirmed | Confirmed |
| Value | Meaning |
|---|---|
| P | Product |
| S | Subscription |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| title | Title |
| phone | Phone |
| status | Status |
| created_at | Created At |
| updated_at | Updated At |
| current_payment | Current Payment |
| source | Source |
| device | Device |
| ip_address | Ip Address |
| delivery_address | Delivery Address |
| notes | Notes |
| user | User |
| service_fee | Service Fee |
| delivery_fee | Delivery Fee |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAdminOrReadOnly | The request is authenticated as a user, or is a read-only request. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAdminOrReadOnly | The request is authenticated as a user, or is a read-only request. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAdminOrReadOnly | The request is authenticated as a user, or is a read-only request. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAdminOrReadOnly | The request is authenticated as a user, or is a read-only request. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| category | Category |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperuserOrShopCollaborator | Custom permission that allows: |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSuperuserOrShopCollaborator | Custom permission that allows: |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| shop | Shop |
| base_price | Base Price |
| system_fee_percentage | System Fee Percentage |
| created_at | Created At |
| updated_at | Updated At |
| venue | Venue |
| start_time | Start Time |
| end_time | End Time |
| has_unlimited_stock | Has Unlimited Stock |
| active | Active |
| sub_category | Sub Category |
| trailer_url | Trailer Url |
| trailer_preview_url | Trailer Preview Url |
| can_be_redeemed | Can Be Redeemed |
| product_sub_category | Product Sub Category |
| product_category | Product Category |
Trigger revenue split for all undisbursed purchase items in a shop.
POST /api/v1/shops/{shop_id}/trigger-split
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyGetRequests | Custom permission to allow only GET requests. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowOnlyGetRequests | Custom permission to allow only GET requests. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| user | User |
| support_email | Support Email |
| support_phone | Support Phone |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| product_variant | Product Variant |
| supplier | Supplier |
| quantity | Quantity |
| cost_per_unit | Cost Per Unit |
| total_cost | Total Cost |
| received_date | Received Date |
| remarks | Remarks |
| device | Device |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
| D | Desktop |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
| D | Desktop |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| device_id | Device Id |
| description | Description |
| user | User |
| device_type | Device Type |
| is_primary_device | Is Primary Device |
| is_verifed | Is Verifed |
| os_version | Os Version |
| os_version_name | Os Version Name |
| firebase_token | Firebase Token |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
| D | Desktop |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| M | Mobile |
| T | Tablet |
| D | Desktop |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| purchase_device | Purchase Device |
| user | User |
| location_type | Location Type |
| floor_number | Floor Number |
| door_number | Door Number |
| building_name | Building Name |
| additional_info | Additional Info |
| lat | Lat |
| lng | Lng |
| notes | Notes |
| is_default_address | Is Default Address |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAddressOwner | A base class from which all permission classes should inherit. |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
Group statistics by:
`type` = {stat_types}
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| purchase | Purchase |
| product_variant | Product Variant |
| quantity | Quantity |
| price | Price |
| discount | Discount |
| disbursed | Disbursed |
| disbursed_at | Disbursed At |
| disbursement_failure_reason | Disbursement Failure Reason |
| purchase_id | Purchase Id |
| purchase_email | Purchase Email |
| purchase_status | Purchase Status |
| purchase_created_date | Purchase Created Date |
| purchase_modified_date | Purchase Modified Date |
| product_id | Product Id |
| product_name | Product Name |
| product_variant_id | Product Variant Id |
| product_sku | Product Sku |
| product_variant_name | Product Variant Name |
| shop_name | Shop Name |
| shop_id | Shop Id |
| payment_reference | Payment Reference |
| is_mpesa_code_empty | Is Mpesa Code Empty |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| purchase | Purchase |
| product_variant | Product Variant |
| quantity | Quantity |
| price | Price |
| discount | Discount |
| disbursed | Disbursed |
| disbursed_at | Disbursed At |
| disbursement_failure_reason | Disbursement Failure Reason |
| purchase_id | Purchase Id |
| purchase_email | Purchase Email |
| purchase_status | Purchase Status |
| purchase_created_date | Purchase Created Date |
| purchase_modified_date | Purchase Modified Date |
| product_id | Product Id |
| product_name | Product Name |
| product_variant_id | Product Variant Id |
| product_sku | Product Sku |
| product_variant_name | Product Variant Name |
| shop_name | Shop Name |
| shop_id | Shop Id |
| payment_reference | Payment Reference |
| is_mpesa_code_empty | Is Mpesa Code Empty |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| purchase | Purchase |
| product_variant | Product Variant |
| quantity | Quantity |
| price | Price |
| discount | Discount |
| disbursed | Disbursed |
| disbursed_at | Disbursed At |
| disbursement_failure_reason | Disbursement Failure Reason |
| purchase_id | Purchase Id |
| purchase_email | Purchase Email |
| purchase_status | Purchase Status |
| purchase_created_date | Purchase Created Date |
| purchase_modified_date | Purchase Modified Date |
| product_id | Product Id |
| product_name | Product Name |
| product_variant_id | Product Variant Id |
| product_sku | Product Sku |
| product_variant_name | Product Variant Name |
| shop_name | Shop Name |
| shop_id | Shop Id |
| payment_reference | Payment Reference |
| is_mpesa_code_empty | Is Mpesa Code Empty |
| Value | Meaning |
|---|---|
| HS | House |
| HT | Hotel |
| AP | Apartment |
| OF | Office |
| OT | Other |
| Value | Meaning |
|---|---|
| CART | Cart |
| PENDING | Pending |
| PROCESSING | Processing |
| PROCESSED | Processed |
| DELIVERING | Delivering |
| DELIVERED | Delivered |
| PAID | Paid |
| CANCELED | Canceled |
| COMPLETED | Completed |
| Value | Meaning |
|---|---|
| online | Online |
| shop | Shop |
| gate | Gate |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Value | Meaning |
|---|---|
| PENDING | PENDING |
| REDEEMING | REDEEMING |
| REDEEMED | REDEEMED |
| Value | Meaning |
|---|---|
| PENDING | PENDING |
| REDEEMING | REDEEMING |
| REDEEMED | REDEEMED |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| user | User |
| name | Name |
| description | Description |
| is_payable | Is Payable |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| name | Name |
| description | Description |
| collaborator | Collaborator |
| percentage | Percentage |
| tax | Tax |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| shop | Shop |
| collaborator | Collaborator |
| percentage | Percentage |
| tax | Tax |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| product | Product |
| collaborator | Collaborator |
| percentage | Percentage |
| tax | Tax |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| variant | Variant |
| collaborator | Collaborator |
| percentage | Percentage |
| tax | Tax |
| active | Active |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| created_by | Created By |
| updated_by | Updated By |
| collaborator | Collaborator |
| available_balance | Available Balance |
| total_earned | Total Earned |
| total_withdrawn | Total Withdrawn |
| transaction_count | Transaction Count |
| last_updated | Last Updated |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Value | Meaning |
|---|---|
| REVENUE_SHARE | Revenue Share |
| SYSTEM_FEE | System Fee |
| WITHDRAWAL | Withdrawal |
| ADJUSTMENT | Manual Adjustment |
| TAX_WITHHOLD | Tax Withholding |
| Value | Meaning |
|---|---|
| SYSTEM | System Level |
| SHOP | Shop Level |
| PRODUCT | Product Level |
| VARIANT | Variant Level |
| Value | Meaning |
|---|---|
| REVENUE_SHARE | Revenue Share |
| SYSTEM_FEE | System Fee |
| WITHDRAWAL | Withdrawal |
| ADJUSTMENT | Manual Adjustment |
| TAX_WITHHOLD | Tax Withholding |
| Value | Meaning |
|---|---|
| SYSTEM | System Level |
| SHOP | Shop Level |
| PRODUCT | Product Level |
| VARIANT | Variant Level |
Group statistics by:type = shop, product, variant, collaborator_type, transaction_type, collaborator, month, date
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| updated_by | Updated By |
| ledger | Ledger |
| transaction_type | Transaction Type |
| amount | Amount |
| gross_amount | Gross Amount |
| tax_amount | Tax Amount |
| tax_percentage | Tax Percentage |
| description | Description |
| reference_id | Reference Id |
| previous_balance | Previous Balance |
| current_balance | Current Balance |
| previous_transaction | Previous Transaction |
| collaboration_type | Collaboration Type |
| system_collaborator | System Collaborator |
| shop_collaborator | Shop Collaborator |
| product_collaborator | Product Collaborator |
| variant_collaborator | Variant Collaborator |
| purchase | Purchase |
| shop | Shop |
| purchase_item | Purchase Item |
| created_by | Created By |
| start_date | Start Date |
| end_date | End Date |
| min_amount | Min Amount |
| max_amount | Max Amount |
| collaborator_id | Collaborator Id |
| Value | Meaning |
|---|---|
| REVENUE_SHARE | Revenue Share |
| SYSTEM_FEE | System Fee |
| WITHDRAWAL | Withdrawal |
| ADJUSTMENT | Manual Adjustment |
| TAX_WITHHOLD | Tax Withholding |
| Value | Meaning |
|---|---|
| SYSTEM | System Level |
| SHOP | Shop Level |
| PRODUCT | Product Level |
| VARIANT | Variant Level |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| updated_by | Updated By |
| ledger | Ledger |
| transaction_type | Transaction Type |
| amount | Amount |
| gross_amount | Gross Amount |
| tax_amount | Tax Amount |
| tax_percentage | Tax Percentage |
| description | Description |
| reference_id | Reference Id |
| previous_balance | Previous Balance |
| current_balance | Current Balance |
| previous_transaction | Previous Transaction |
| collaboration_type | Collaboration Type |
| system_collaborator | System Collaborator |
| shop_collaborator | Shop Collaborator |
| product_collaborator | Product Collaborator |
| variant_collaborator | Variant Collaborator |
| purchase | Purchase |
| shop | Shop |
| purchase_item | Purchase Item |
| created_by | Created By |
| start_date | Start Date |
| end_date | End Date |
| collaborator_id | Collaborator Id |
| Value | Meaning |
|---|---|
| REVENUE_SHARE | Revenue Share |
| SYSTEM_FEE | System Fee |
| WITHDRAWAL | Withdrawal |
| ADJUSTMENT | Manual Adjustment |
| TAX_WITHHOLD | Tax Withholding |
| Value | Meaning |
|---|---|
| SYSTEM | System Level |
| SHOP | Shop Level |
| PRODUCT | Product Level |
| VARIANT | Variant Level |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
| Param name | Description |
|---|---|
| created | Created |
| modified | Modified |
| updated_by | Updated By |
| ledger | Ledger |
| transaction_type | Transaction Type |
| amount | Amount |
| gross_amount | Gross Amount |
| tax_amount | Tax Amount |
| tax_percentage | Tax Percentage |
| description | Description |
| reference_id | Reference Id |
| previous_balance | Previous Balance |
| current_balance | Current Balance |
| previous_transaction | Previous Transaction |
| collaboration_type | Collaboration Type |
| system_collaborator | System Collaborator |
| shop_collaborator | Shop Collaborator |
| product_collaborator | Product Collaborator |
| variant_collaborator | Variant Collaborator |
| purchase | Purchase |
| shop | Shop |
| purchase_item | Purchase Item |
| created_by | Created By |
| Value | Meaning |
|---|---|
| REVENUE_SHARE | Revenue Share |
| SYSTEM_FEE | System Fee |
| WITHDRAWAL | Withdrawal |
| ADJUSTMENT | Manual Adjustment |
| TAX_WITHHOLD | Tax Withholding |
| Value | Meaning |
|---|---|
| SYSTEM | System Level |
| SHOP | Shop Level |
| PRODUCT | Product Level |
| VARIANT | Variant Level |
| Value | Meaning |
|---|---|
| REVENUE_SHARE | Revenue Share |
| SYSTEM_FEE | System Fee |
| WITHDRAWAL | Withdrawal |
| ADJUSTMENT | Manual Adjustment |
| TAX_WITHHOLD | Tax Withholding |
| Value | Meaning |
|---|---|
| SYSTEM | System Level |
| SHOP | Shop Level |
| PRODUCT | Product Level |
| VARIANT | Variant Level |
Implements an endpoint to provide access tokens
The endpoint is used in the following flows:
* Authorization code
* Password
* Client credentials
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Implements an endpoint to convert a provider token to an access token
The endpoint is used in the following flows:
* Authorization code
* Client credentials
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
Implements an endpoint to revoke access or refresh tokens
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| Type | Description |
|---|---|
| IsAuthenticated | Allows access only to authenticated users. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSafaricomAllowedIP | Custom permission to allow access only to specific IP addresses. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSafaricomAllowedIP | Custom permission to allow access only to specific IP addresses. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| IsSafaricomAllowedIP | Custom permission to allow access only to specific IP addresses. |
No description provided by developer
| Type | Description |
|---|---|
| OAuth2Authentication | OAuth 2 authentication backend using |
| SessionAuthentication | Use Django's session framework for authentication. |
| Type | Description |
|---|---|
| AllowAny | Allow any access. |