Wavvy Wallet

api

• v1

  • users

    • • swap_horiz /api/v1/users/

        GET POST OPTIONS

        List Create Clients

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Signup response includes an access token

        
        

        {
   "profile":{response fields below},
   "token":{..}
 }

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        email	Email
        dob	Dob
        gender	Gender
        allow_messages_import	Allow Messages Import
        filter_args	Filter Args

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • password: CharField, Required
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • mpesa_numbers: ListSerializer,
          Item structure

          {

          • number: CharField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • accounts: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • created_by_first_name: CharField,
          • created_by_last_name: CharField,
          • created_by_full_name: CharField,
          • created_by_email: CharField,
          • created_by_phone: CharField,
          • created_by_last_login: DateTimeField,
          • mpesa_wallets: ListSerializer,
            Item structure

            {

            • account: ModelField,
            • numbers: ListSerializer,
              Item structure

              {

              • number: CharField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • mpesa_wallet: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • description: CharField,
          • types: ChoiceField,
            Choices

            Value	Meaning
            P	Personal
            B	Business
            C	Contributions

          • nickname: CharField,
          • name: CharField,
          • number: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • subscription: SubscriptionSerializer,
          Item structure

          {

          • id: IntegerField,
          • plan_name: ReadOnlyField,
          • plan_id: ReadOnlyField,
          • payment_id: ReadOnlyField,
          • plan_amount: ReadOnlyField,
          • plan_amount_paid: ReadOnlyField,
          • plan_latest_transaction_date: ReadOnlyField,
          • plan_discount: ReadOnlyField,
          • plan_interval: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • start_date: DateTimeField,
          • next_payment_date: DateTimeField,
          • is_active: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • customer: PrimaryKeyRelatedField, Help Text
          • latest_payment: PrimaryKeyRelatedField Help Text

          }
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }
    • • swap_horiz /api/v1/users/me/

        GET PUT PATCH OPTIONS

        Retrieve Update Client

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • password: CharField, Required
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • mpesa_numbers: ListSerializer,
          Item structure

          {

          • number: CharField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • accounts: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • created_by_first_name: CharField,
          • created_by_last_name: CharField,
          • created_by_full_name: CharField,
          • created_by_email: CharField,
          • created_by_phone: CharField,
          • created_by_last_login: DateTimeField,
          • mpesa_wallets: ListSerializer,
            Item structure

            {

            • account: ModelField,
            • numbers: ListSerializer,
              Item structure

              {

              • number: CharField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • mpesa_wallet: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • description: CharField,
          • types: ChoiceField,
            Choices

            Value	Meaning
            P	Personal
            B	Business
            C	Contributions

          • nickname: CharField,
          • name: CharField,
          • number: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • subscription: SubscriptionSerializer,
          Item structure

          {

          • id: IntegerField,
          • plan_name: ReadOnlyField,
          • plan_id: ReadOnlyField,
          • payment_id: ReadOnlyField,
          • plan_amount: ReadOnlyField,
          • plan_amount_paid: ReadOnlyField,
          • plan_latest_transaction_date: ReadOnlyField,
          • plan_discount: ReadOnlyField,
          • plan_interval: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • start_date: DateTimeField,
          • next_payment_date: DateTimeField,
          • is_active: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • customer: PrimaryKeyRelatedField, Help Text
          • latest_payment: PrimaryKeyRelatedField Help Text

          }
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }
    • • swap_horiz /api/v1/users/technicians/

        GET OPTIONS

        List Technicians

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.
        IsSafariNjemaCustomerCareOrAdmin	A base class from which all permission classes should inherit.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • mpesa_numbers: ListSerializer,
          Item structure

          {

          • number: CharField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • accounts: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • created_by_first_name: CharField,
          • created_by_last_name: CharField,
          • created_by_full_name: CharField,
          • created_by_email: CharField,
          • created_by_phone: CharField,
          • created_by_last_login: DateTimeField,
          • mpesa_wallets: ListSerializer,
            Item structure

            {

            • account: ModelField,
            • numbers: ListSerializer,
              Item structure

              {

              • number: CharField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • mpesa_wallet: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • description: CharField,
          • types: ChoiceField,
            Choices

            Value	Meaning
            P	Personal
            B	Business
            C	Contributions

          • nickname: CharField,
          • name: CharField,
          • number: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • subscription: SubscriptionSerializer,
          Item structure

          {

          • id: IntegerField,
          • plan_name: ReadOnlyField,
          • plan_id: ReadOnlyField,
          • payment_id: ReadOnlyField,
          • plan_amount: ReadOnlyField,
          • plan_amount_paid: ReadOnlyField,
          • plan_latest_transaction_date: ReadOnlyField,
          • plan_discount: ReadOnlyField,
          • plan_interval: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • start_date: DateTimeField,
          • next_payment_date: DateTimeField,
          • is_active: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • customer: PrimaryKeyRelatedField, Help Text
          • latest_payment: PrimaryKeyRelatedField Help Text

          }
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }
    • • swap_horiz /api/v1/users/me/profile/

        GET PUT PATCH OPTIONS

        Retrieve Client

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • password: CharField, Required
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • mpesa_numbers: ListSerializer,
          Item structure

          {

          • number: CharField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • accounts: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • created_by_first_name: CharField,
          • created_by_last_name: CharField,
          • created_by_full_name: CharField,
          • created_by_email: CharField,
          • created_by_phone: CharField,
          • created_by_last_login: DateTimeField,
          • mpesa_wallets: ListSerializer,
            Item structure

            {

            • account: ModelField,
            • numbers: ListSerializer,
              Item structure

              {

              • number: CharField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • mpesa_wallet: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • description: CharField,
          • types: ChoiceField,
            Choices

            Value	Meaning
            P	Personal
            B	Business
            C	Contributions

          • nickname: CharField,
          • name: CharField,
          • number: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • subscription: SubscriptionSerializer,
          Item structure

          {

          • id: IntegerField,
          • plan_name: ReadOnlyField,
          • plan_id: ReadOnlyField,
          • payment_id: ReadOnlyField,
          • plan_amount: ReadOnlyField,
          • plan_amount_paid: ReadOnlyField,
          • plan_latest_transaction_date: ReadOnlyField,
          • plan_discount: ReadOnlyField,
          • plan_interval: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • start_date: DateTimeField,
          • next_payment_date: DateTimeField,
          • is_active: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • customer: PrimaryKeyRelatedField, Help Text
          • latest_payment: PrimaryKeyRelatedField Help Text

          }
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }
    • • swap_horiz /api/v1/users/forgot-password

        POST OPTIONS

        Clients Forgot Password

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

    • • swap_horiz /api/v1/users/reset-password

        POST PUT PATCH OPTIONS

        Clients Reset Password

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

        
        

        Request Fields:

        {

        • reset_code: IntegerField, Required
        • new_password: CharField Required

        }

        
        

        Response Fields:

        {

        • reset_code: IntegerField,
        • new_password: CharField

        }
    • • swap_horiz /api/v1/users/google-signin

        POST OPTIONS

        Google Login

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        Expects a POST with JSON: { "access_token": "<google_access_token>" }
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

    • • swap_horiz /api/v1/users/apple-signin

        POST OPTIONS

        Apple Login

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        Expects a POST with JSON: { "identity_token": "<APPLE_IDENTITY_TOKEN>" }
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

    • • swap_horiz /api/v1/users/stats/<type>

        GET POST OPTIONS

        List My User Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group My User statistics by:
        type = id, month_joined, month, year, day

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        email	Email
        dob	Dob
        gender	Gender
        allow_messages_import	Allow Messages Import
        filter_args	Filter Args

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • password: CharField, Required
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • mpesa_numbers: ListSerializer,
          Item structure

          {

          • number: CharField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • accounts: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • created_by_first_name: CharField,
          • created_by_last_name: CharField,
          • created_by_full_name: CharField,
          • created_by_email: CharField,
          • created_by_phone: CharField,
          • created_by_last_login: DateTimeField,
          • mpesa_wallets: ListSerializer,
            Item structure

            {

            • account: ModelField,
            • numbers: ListSerializer,
              Item structure

              {

              • number: CharField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • mpesa_wallet: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • description: CharField,
          • types: ChoiceField,
            Choices

            Value	Meaning
            P	Personal
            B	Business
            C	Contributions

          • nickname: CharField,
          • name: CharField,
          • number: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • subscription: SubscriptionSerializer,
          Item structure

          {

          • id: IntegerField,
          • plan_name: ReadOnlyField,
          • plan_id: ReadOnlyField,
          • payment_id: ReadOnlyField,
          • plan_amount: ReadOnlyField,
          • plan_amount_paid: ReadOnlyField,
          • plan_latest_transaction_date: ReadOnlyField,
          • plan_discount: ReadOnlyField,
          • plan_interval: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • start_date: DateTimeField,
          • next_payment_date: DateTimeField,
          • is_active: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • customer: PrimaryKeyRelatedField, Help Text
          • latest_payment: PrimaryKeyRelatedField Help Text

          }
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }
    • • swap_horiz /api/v1/users/stats/

        GET POST OPTIONS

        Retrieve My Users General Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        email	Email
        dob	Dob
        gender	Gender
        allow_messages_import	Allow Messages Import
        filter_args	Filter Args

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • password: CharField, Required
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • mpesa_numbers: ListSerializer,
          Item structure

          {

          • number: CharField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • accounts: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • created_by_first_name: CharField,
          • created_by_last_name: CharField,
          • created_by_full_name: CharField,
          • created_by_email: CharField,
          • created_by_phone: CharField,
          • created_by_last_login: DateTimeField,
          • mpesa_wallets: ListSerializer,
            Item structure

            {

            • account: ModelField,
            • numbers: ListSerializer,
              Item structure

              {

              • number: CharField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • mpesa_wallet: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • description: CharField,
          • types: ChoiceField,
            Choices

            Value	Meaning
            P	Personal
            B	Business
            C	Contributions

          • nickname: CharField,
          • name: CharField,
          • number: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • subscription: SubscriptionSerializer,
          Item structure

          {

          • id: IntegerField,
          • plan_name: ReadOnlyField,
          • plan_id: ReadOnlyField,
          • payment_id: ReadOnlyField,
          • plan_amount: ReadOnlyField,
          • plan_amount_paid: ReadOnlyField,
          • plan_latest_transaction_date: ReadOnlyField,
          • plan_discount: ReadOnlyField,
          • plan_interval: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • start_date: DateTimeField,
          • next_payment_date: DateTimeField,
          • is_active: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • customer: PrimaryKeyRelatedField, Help Text
          • latest_payment: PrimaryKeyRelatedField Help Text

          }
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField

        }

  • mpesa-numbers

    • • swap_horiz /api/v1/mpesa-numbers/

        GET POST OPTIONS

        List Create Mpesa Numbers

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • number: CharField, Required
        • name: CharField, Required

        }

        
        

        Response Fields:

        {

        • number: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/mpesa-numbers/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Mpesa Number

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • number: CharField, Required
        • name: CharField, Required

        }

        
        

        Response Fields:

        {

        • number: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • activities

    • • swap_horiz /api/v1/activities/

        GET POST OPTIONS

        List Create Activitys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • start_date: DateTimeField, Required
        • end_date: DateTimeField, Required
        • account: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/activities/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Activity

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • start_date: DateTimeField, Required
        • end_date: DateTimeField, Required
        • account: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField Help Text

        }

  • mpesa-transactions

    • • swap_horiz /api/v1/mpesa-transactions/stats/<type>

        GET POST OPTIONS

        List Mpesa Transactions Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        type = id, receive, send, trans_type, month, year, day

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • code: CharField, Required
        • date: DateField, Required
        • amount: FloatField, Required
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal

        • balance: FloatField,
        • receiver_name: CharField,
        • receiver_account: CharField,
        • sender_account: CharField,
        • sender_name: CharField,
        • fee: FloatField,
        • time: TimeField, Required
        • mpesa_type: ChoiceField, Required
          Choices

          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

        • mpesa_wallet_number: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • code: CharField,
        • date: DateField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • amount: FloatField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal

        • balance: FloatField,
        • receiver_name: CharField,
        • receiver_account: CharField,
        • sender_account: CharField,
        • sender_name: CharField,
        • fee: FloatField,
        • time: TimeField,
        • mpesa_type: ChoiceField,
          Choices

          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

        • updated_by: PrimaryKeyRelatedField, Help Text
        • created_by: PrimaryKeyRelatedField, Help Text
        • mpesa_wallet_number: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/mpesa-transactions/stats/

        GET POST OPTIONS

        List Mpesa Transactions Stats Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • code: CharField, Required
        • date: DateField, Required
        • amount: FloatField, Required
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal

        • balance: FloatField,
        • receiver_name: CharField,
        • receiver_account: CharField,
        • sender_account: CharField,
        • sender_name: CharField,
        • fee: FloatField,
        • time: TimeField, Required
        • mpesa_type: ChoiceField, Required
          Choices

          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

        • mpesa_wallet_number: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • code: CharField,
        • date: DateField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • amount: FloatField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal

        • balance: FloatField,
        • receiver_name: CharField,
        • receiver_account: CharField,
        • sender_account: CharField,
        • sender_name: CharField,
        • fee: FloatField,
        • time: TimeField,
        • mpesa_type: ChoiceField,
          Choices

          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

        • updated_by: PrimaryKeyRelatedField, Help Text
        • created_by: PrimaryKeyRelatedField, Help Text
        • mpesa_wallet_number: PrimaryKeyRelatedField Help Text

        }

  • tagging-rules

    • • swap_horiz /api/v1/tagging-rules/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Tagging Rule

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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.

        
        

        Request Fields:

        {

        • confidence_score: IntegerField,
        • name: CharField, Required
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • source: CharField,
        • mpesa_type: CharField, Required
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • sub_category: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • sub_category_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • category: ReadOnlyField,
        • confidence_score: IntegerField,
        • mpesa_type_display: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • usage_count: IntegerField,
        • source: CharField,
        • last_updated: DateTimeField,
        • mpesa_type: CharField,
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/tagging-rules/suggest-tags/

        GET OPTIONS

        Suggest Tagging Rules

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

    • • swap_horiz /api/v1/tagging-rules/system/

        GET OPTIONS

        List System Tagging Rules

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • sub_category_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • category: ReadOnlyField,
        • confidence_score: IntegerField,
        • mpesa_type_display: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • usage_count: IntegerField,
        • source: CharField,
        • last_updated: DateTimeField,
        • mpesa_type: CharField,
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/tagging-rules/me/

        GET OPTIONS

        List My Tagging Rules

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • sub_category_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • category: ReadOnlyField,
        • confidence_score: IntegerField,
        • mpesa_type_display: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • usage_count: IntegerField,
        • source: CharField,
        • last_updated: DateTimeField,
        • mpesa_type: CharField,
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/tagging-rules/stats/<str:type>/

        GET POST OPTIONS

        List Tagging Rules Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        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

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • confidence_score: IntegerField,
        • name: CharField, Required
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • source: CharField,
        • mpesa_type: CharField, Required
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • sub_category: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • sub_category_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • category: ReadOnlyField,
        • confidence_score: IntegerField,
        • mpesa_type_display: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • usage_count: IntegerField,
        • source: CharField,
        • last_updated: DateTimeField,
        • mpesa_type: CharField,
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/tagging-rules/stats/

        GET POST OPTIONS

        Retrieve Tagging Rules General Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • confidence_score: IntegerField,
        • name: CharField, Required
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • source: CharField,
        • mpesa_type: CharField, Required
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • sub_category: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • sub_category_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • category: ReadOnlyField,
        • confidence_score: IntegerField,
        • mpesa_type_display: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • usage_count: IntegerField,
        • source: CharField,
        • last_updated: DateTimeField,
        • mpesa_type: CharField,
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/tagging-rules/

        GET POST OPTIONS

        List Create Tagging Rules

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • confidence_score: IntegerField,
        • name: CharField, Required
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • source: CharField,
        • mpesa_type: CharField, Required
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • sub_category: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • sub_category_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • category: ReadOnlyField,
        • confidence_score: IntegerField,
        • mpesa_type_display: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • mpesa_code: CharField,
        • custom_name: CharField,
        • trans_type: ChoiceField,
          Choices

          Value	Meaning
          D	Deposit
          W	Withdrawal
          B	Both

        • account: CharField,
        • amount: IntegerField,
        • usage_count: IntegerField,
        • source: CharField,
        • last_updated: DateTimeField,
        • mpesa_type: CharField,
        • use_account: BooleanField,
        • start_date: DateTimeField,
        • end_date: DateTimeField,
        • cache: JSONField,
        • recommend_system: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • tags: ManyRelatedField Help Text

        }

  • activity-transactions

    • • swap_horiz /api/v1/activity-transactions/

        GET POST OPTIONS

        List Create Activity Transactions

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • user: PrimaryKeyRelatedField, Required Help Text
        • activity: PrimaryKeyRelatedField, Required Help Text
        • transaction: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • activity: PrimaryKeyRelatedField, Help Text
        • transaction: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/activity-transactions/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Activity Transaction

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • user: PrimaryKeyRelatedField, Required Help Text
        • activity: PrimaryKeyRelatedField, Required Help Text
        • transaction: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField, Help Text
        • activity: PrimaryKeyRelatedField, Help Text
        • transaction: PrimaryKeyRelatedField Help Text

        }

  • categories

    • • swap_horiz /api/v1/categories/

        GET POST OPTIONS

        List Create Categorys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • description: CharField,
        • name: CharField, Required

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • description: CharField,
        • name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/categories/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Category

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • description: CharField,
        • name: CharField, Required

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • description: CharField,
        • name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • sub-categories

    • • swap_horiz /api/v1/sub-categories/

        GET POST OPTIONS

        List Create Sub Categorys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • description: CharField,
        • name: CharField, Required
        • budget_category: ChoiceField,
          Choices

          Value	Meaning
          wants	Wants
          needs	Needs
          s_v	Savings & Investments

        • category: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • category_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • description: CharField,
        • name: CharField,
        • budget_category: ChoiceField,
          Choices

          Value	Meaning
          wants	Wants
          needs	Needs
          s_v	Savings & Investments

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/sub-categories/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Sub Category

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • description: CharField,
        • name: CharField, Required
        • budget_category: ChoiceField,
          Choices

          Value	Meaning
          wants	Wants
          needs	Needs
          s_v	Savings & Investments

        • category: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • category_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • description: CharField,
        • name: CharField,
        • budget_category: ChoiceField,
          Choices

          Value	Meaning
          wants	Wants
          needs	Needs
          s_v	Savings & Investments

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • accounts

    • • swap_horiz /api/v1/accounts/

        GET POST OPTIONS

        List Create Accounts

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • description: CharField,
        • types: ChoiceField,
          Choices

          Value	Meaning
          P	Personal
          B	Business
          C	Contributions

        • nickname: CharField,
        • name: CharField,
        • number: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created_by_first_name: CharField,
        • created_by_last_name: CharField,
        • created_by_full_name: CharField,
        • created_by_email: CharField,
        • created_by_phone: CharField,
        • created_by_last_login: DateTimeField,
        • mpesa_wallets: ListSerializer,
          Item structure

          {

          • account: ModelField,
          • numbers: ListSerializer,
            Item structure

            {

            • number: CharField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • mpesa_wallet: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • description: CharField,
        • types: ChoiceField,
          Choices

          Value	Meaning
          P	Personal
          B	Business
          C	Contributions

        • nickname: CharField,
        • name: CharField,
        • number: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/accounts/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Account

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • description: CharField,
        • types: ChoiceField,
          Choices

          Value	Meaning
          P	Personal
          B	Business
          C	Contributions

        • nickname: CharField,
        • name: CharField,
        • number: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created_by_first_name: CharField,
        • created_by_last_name: CharField,
        • created_by_full_name: CharField,
        • created_by_email: CharField,
        • created_by_phone: CharField,
        • created_by_last_login: DateTimeField,
        • mpesa_wallets: ListSerializer,
          Item structure

          {

          • account: ModelField,
          • numbers: ListSerializer,
            Item structure

            {

            • number: CharField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • mpesa_wallet: PrimaryKeyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • description: CharField,
        • types: ChoiceField,
          Choices

          Value	Meaning
          P	Personal
          B	Business
          C	Contributions

        • nickname: CharField,
        • name: CharField,
        • number: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • account-members

    • • swap_horiz /api/v1/account-members/

        GET POST OPTIONS

        List Create Account Members

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • role: ChoiceField,
          Choices

          Value	Meaning
          O	Owner
          V	View Only
          E	Editor

        • account: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • account_name: ReadOnlyField,
        • user_details: SimpleUserSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • profile_image: SerializerMethodField,
          • full_name: CharField,
          • mpesa_numbers: ListSerializer,
            Item structure

            {

            • number: CharField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • user: PrimaryKeyRelatedField Help Text

            }
          • accounts: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • image: Base64ImageField,
            • cache_image: SerializerMethodField,
            • avatar_image: SerializerMethodField,
            • created_by_first_name: CharField,
            • created_by_last_name: CharField,
            • created_by_full_name: CharField,
            • created_by_email: CharField,
            • created_by_phone: CharField,
            • created_by_last_login: DateTimeField,
            • mpesa_wallets: ListSerializer,
              Item structure

              {

              • account: ModelField,
              • numbers: ListSerializer,
                Item structure

                {

                • number: CharField,
                • created: DateTimeField,
                • modified: DateTimeField,
                • name: CharField,
                • created_by: PrimaryKeyRelatedField, Help Text
                • updated_by: PrimaryKeyRelatedField, Help Text
                • mpesa_wallet: PrimaryKeyRelatedField Help Text

                }
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • description: CharField,
            • types: ChoiceField,
              Choices

              Value	Meaning
              P	Personal
              B	Business
              C	Contributions

            • nickname: CharField,
            • name: CharField,
            • number: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • last_login: DateTimeField,
          • username: CharField, Help Text
          • first_name: CharField,
          • last_name: CharField,
          • date_joined: DateTimeField,
          • role: ChoiceField,
            Choices

            Value	Meaning
            N	Normal
            A	Admin
            C	Customer Care
            T	Technician

          • phone: CharField,
          • google_profile_image: URLField,
          • verified: BooleanField,
          • dummy: BooleanField,
          • available: BooleanField,
          • email: EmailField,
          • dob: DateField,
          • gender: ChoiceField,
            Choices

            Value	Meaning
            M	Male
            F	Female
            RNS	Rather Not Say

          • allow_messages_import: BooleanField,
          • filter_args: CharField

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          O	Owner
          V	View Only
          E	Editor

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/account-members/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Account Member

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • role: ChoiceField,
          Choices

          Value	Meaning
          O	Owner
          V	View Only
          E	Editor

        • account: PrimaryKeyRelatedField, Required Help Text
        • user: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • account_name: ReadOnlyField,
        • user_details: SimpleUserSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • profile_image: SerializerMethodField,
          • full_name: CharField,
          • mpesa_numbers: ListSerializer,
            Item structure

            {

            • number: CharField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • user: PrimaryKeyRelatedField Help Text

            }
          • accounts: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • image: Base64ImageField,
            • cache_image: SerializerMethodField,
            • avatar_image: SerializerMethodField,
            • created_by_first_name: CharField,
            • created_by_last_name: CharField,
            • created_by_full_name: CharField,
            • created_by_email: CharField,
            • created_by_phone: CharField,
            • created_by_last_login: DateTimeField,
            • mpesa_wallets: ListSerializer,
              Item structure

              {

              • account: ModelField,
              • numbers: ListSerializer,
                Item structure

                {

                • number: CharField,
                • created: DateTimeField,
                • modified: DateTimeField,
                • name: CharField,
                • created_by: PrimaryKeyRelatedField, Help Text
                • updated_by: PrimaryKeyRelatedField, Help Text
                • mpesa_wallet: PrimaryKeyRelatedField Help Text

                }
              • created: DateTimeField,
              • modified: DateTimeField,
              • name: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField Help Text

              }
            • created: DateTimeField,
            • modified: DateTimeField,
            • description: CharField,
            • types: ChoiceField,
              Choices

              Value	Meaning
              P	Personal
              B	Business
              C	Contributions

            • nickname: CharField,
            • name: CharField,
            • number: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField Help Text

            }
          • last_login: DateTimeField,
          • username: CharField, Help Text
          • first_name: CharField,
          • last_name: CharField,
          • date_joined: DateTimeField,
          • role: ChoiceField,
            Choices

            Value	Meaning
            N	Normal
            A	Admin
            C	Customer Care
            T	Technician

          • phone: CharField,
          • google_profile_image: URLField,
          • verified: BooleanField,
          • dummy: BooleanField,
          • available: BooleanField,
          • email: EmailField,
          • dob: DateField,
          • gender: ChoiceField,
            Choices

            Value	Meaning
            M	Male
            F	Female
            RNS	Rather Not Say

          • allow_messages_import: BooleanField,
          • filter_args: CharField

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          O	Owner
          V	View Only
          E	Editor

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • devices

    • • swap_horiz /api/v1/devices/

        GET POST OPTIONS

        List Create Phone Devices

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • device_id: CharField, Required
        • name: CharField,
        • description: CharField,
        • sms_support: BooleanField,
        • device_type: ChoiceField, Required
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet

        • android_version: IntegerField, Required
        • android_version_name: CharField, Required
        • extra_info: JSONField,
        • user: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • device_id: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • sms_support: BooleanField,
        • device_type: ChoiceField,
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet

        • is_primary_device: BooleanField,
        • is_verifed: BooleanField,
        • android_version: IntegerField,
        • android_version_name: CharField,
        • extra_info: JSONField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/devices/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Phone Device

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • device_id: CharField, Required
        • name: CharField,
        • description: CharField,
        • sms_support: BooleanField,
        • device_type: ChoiceField, Required
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet

        • android_version: IntegerField, Required
        • android_version_name: CharField, Required
        • extra_info: JSONField,
        • user: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • device_id: CharField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • sms_support: BooleanField,
        • device_type: ChoiceField,
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet

        • is_primary_device: BooleanField,
        • is_verifed: BooleanField,
        • android_version: IntegerField,
        • android_version_name: CharField,
        • extra_info: JSONField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • device-messages

    • • swap_horiz /api/v1/device-messages/

        GET POST OPTIONS

        List Create Device Messages

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • hash: CharField, Required
        • message: CharField, Required
        • address: CharField, Required
        • date: DateField, Required
        • receive_date: DateTimeField, Required
        • is_supported: BooleanField,
        • source: ChoiceField,
          Choices

          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

        • extracted_info: JSONField,
        • device: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • hash: CharField,
        • device_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • message: CharField,
        • address: CharField,
        • date: DateField,
        • receive_date: DateTimeField,
        • transaction_created: BooleanField,
        • is_supported: BooleanField,
        • source: ChoiceField,
          Choices

          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

        • extracted_info: JSONField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/device-messages/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Device Message

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • hash: CharField, Required
        • message: CharField, Required
        • address: CharField, Required
        • date: DateField, Required
        • receive_date: DateTimeField, Required
        • is_supported: BooleanField,
        • source: ChoiceField,
          Choices

          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

        • extracted_info: JSONField,
        • device: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • hash: CharField,
        • device_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • message: CharField,
        • address: CharField,
        • date: DateField,
        • receive_date: DateTimeField,
        • transaction_created: BooleanField,
        • is_supported: BooleanField,
        • source: ChoiceField,
          Choices

          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

        • extracted_info: JSONField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

  • customers

    • • swap_horiz /api/v1/customers/

        GET POST OPTIONS

        List Create Customers

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        name	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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • phone: CharField,
        • last_visit_date: DateField,
        • last_transaction_spent: IntegerField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          A	All
          B	Blacklist
          N	Don't Send Sms

        • account: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • status_display: ReadOnlyField,
        • full_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • phone: CharField,
        • last_visit_date: DateField,
        • last_transaction_spent: IntegerField,
        • visits: IntegerField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          A	All
          B	Blacklist
          N	Don't Send Sms

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/customers/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Customer

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • phone: CharField,
        • last_visit_date: DateField,
        • last_transaction_spent: IntegerField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          A	All
          B	Blacklist
          N	Don't Send Sms

        • account: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • status_display: ReadOnlyField,
        • full_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • phone: CharField,
        • last_visit_date: DateField,
        • last_transaction_spent: IntegerField,
        • visits: IntegerField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          A	All
          B	Blacklist
          N	Don't Send Sms

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField Help Text

        }

  • customer-visits

    • • swap_horiz /api/v1/customer-visits/

        GET POST OPTIONS

        List Create Customer Visits

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • date: DateField,
        • customer: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • customer_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • date: DateField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/customer-visits/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Customer Visit

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • date: DateField,
        • customer: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • customer_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • date: DateField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField Help Text

        }

  • customer-groups

    • • swap_horiz /api/v1/customer-groups/

        GET POST OPTIONS

        List Create Customer Groups

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • account: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • account_name: ReadOnlyField,
        • stats: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/customer-groups/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Customer Group

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • account: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • account_name: ReadOnlyField,
        • stats: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField Help Text

        }

  • customer-group-participants

    • • swap_horiz /api/v1/customer-group-participants/

        GET POST OPTIONS

        List Create Customer Group Participants

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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_name	Customer Name
        customer_phone	Customer Phone
        account_id	Account Id

        
        

        Request Fields:

        {

        • group: PrimaryKeyRelatedField, Required Help Text
        • customer: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • group_name: ReadOnlyField,
        • customer_name: ReadOnlyField,
        • customer_phone: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • group: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/customer-group-participants/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Customer Group Participant

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • group: PrimaryKeyRelatedField, Required Help Text
        • customer: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • group_name: ReadOnlyField,
        • customer_name: ReadOnlyField,
        • customer_phone: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • group: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField Help Text

        }

  • visit-transactions

    • • swap_horiz /api/v1/visit-transactions/

        GET POST OPTIONS

        List Create Visit Transactions

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • customer: IntegerField, Required
        • date: DateField, Required
        • amount: FloatField, Required
        • fee: FloatField,
        • payment_method: ChoiceField, Required
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • customer_name: ReadOnlyField,
        • visit_date: ReadOnlyField,
        • payment_method_display: ReadOnlyField,
        • source_display: ReadOnlyField,
        • customer_id: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • amount: FloatField,
        • fee: FloatField,
        • payment_method: ChoiceField,
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • visit: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/visit-transactions/stats/<type>

        GET OPTIONS

        List Visit Transactions Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        type = id, customer, month, year, day

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • customer_name: ReadOnlyField,
        • visit_date: ReadOnlyField,
        • payment_method_display: ReadOnlyField,
        • source_display: ReadOnlyField,
        • customer_id: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • amount: FloatField,
        • fee: FloatField,
        • payment_method: ChoiceField,
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • visit: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/visit-transactions/stats/

        GET POST OPTIONS

        List Visit Transactions Stats Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • customer: IntegerField, Required
        • date: DateField, Required
        • amount: FloatField, Required
        • fee: FloatField,
        • payment_method: ChoiceField, Required
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • customer_name: ReadOnlyField,
        • visit_date: ReadOnlyField,
        • payment_method_display: ReadOnlyField,
        • source_display: ReadOnlyField,
        • customer_id: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • amount: FloatField,
        • fee: FloatField,
        • payment_method: ChoiceField,
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • visit: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/visit-transactions/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Visit Transaction

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • customer: IntegerField, Required
        • date: DateField, Required
        • amount: FloatField, Required
        • fee: FloatField,
        • payment_method: ChoiceField, Required
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • customer_name: ReadOnlyField,
        • visit_date: ReadOnlyField,
        • payment_method_display: ReadOnlyField,
        • source_display: ReadOnlyField,
        • customer_id: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • amount: FloatField,
        • fee: FloatField,
        • payment_method: ChoiceField,
          Choices

          Value	Meaning
          MPS	Mpesa
          CSH	Cash
          CRD	Card

        • source: ChoiceField,
          Choices

          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

        • description: CharField,
        • payment_phone: CharField,
        • code: CharField,
        • payment_name: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • visit: PrimaryKeyRelatedField Help Text

        }

  • campaigns

    • • swap_horiz /api/v1/campaigns/

        GET POST OPTIONS

        List Create Campaigns

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • template: CharField, Required
        • group_tag: ChoiceField,
          Choices

          Value	Meaning
          AL	All
          AR	Active Return
          AF	Active First Timer
          IR	In Active Return
          IF	In Active First Timer

        • send_now: BooleanField,
        • account: PrimaryKeyRelatedField, Required Help Text
        • group: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • account_name: ReadOnlyField,
        • group_name: ReadOnlyField,
        • status_display: ReadOnlyField,
        • group_tag_display: ReadOnlyField,
        • stats: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • template: CharField,
        • group_tag: ChoiceField,
          Choices

          Value	Meaning
          AL	All
          AR	Active Return
          AF	Active First Timer
          IR	In Active Return
          IF	In Active First Timer

        • send_now: BooleanField,
        • status: CharField,
        • failed_reason: CharField,
        • sent: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField, Help Text
        • group: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/campaigns/<pk>/send/

        GET PUT PATCH OPTIONS

        Retrieve Send Campaign

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • sent: BooleanField

        }

        
        

        Response Fields:

        {

        • sent: BooleanField

        }
    • • swap_horiz /api/v1/campaigns/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Campaign

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • template: CharField, Required
        • group_tag: ChoiceField,
          Choices

          Value	Meaning
          AL	All
          AR	Active Return
          AF	Active First Timer
          IR	In Active Return
          IF	In Active First Timer

        • send_now: BooleanField,
        • account: PrimaryKeyRelatedField, Required Help Text
        • group: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • account_name: ReadOnlyField,
        • group_name: ReadOnlyField,
        • status_display: ReadOnlyField,
        • group_tag_display: ReadOnlyField,
        • stats: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • template: CharField,
        • group_tag: ChoiceField,
          Choices

          Value	Meaning
          AL	All
          AR	Active Return
          AF	Active First Timer
          IR	In Active Return
          IF	In Active First Timer

        • send_now: BooleanField,
        • status: CharField,
        • failed_reason: CharField,
        • sent: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • account: PrimaryKeyRelatedField, Help Text
        • group: PrimaryKeyRelatedField Help Text

        }

  • campaign-customers

    • • swap_horiz /api/v1/campaign-customers/

        GET POST OPTIONS

        List Create Campaign Customers

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • send_now: BooleanField,
        • phone: CharField,
        • campaign: PrimaryKeyRelatedField, Required Help Text
        • customer: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • status_display: ReadOnlyField,
        • account_name: ReadOnlyField,
        • group_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • message: CharField,
        • send_now: BooleanField,
        • phone: CharField,
        • status: CharField,
        • failed_reason: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • campaign: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField Help Text

        }

  • sms-groups

    • • swap_horiz /api/v1/sms-groups/

        GET POST OPTIONS

        List Create Sms Transactions Groups

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • url: URLField,
        • token: CharField,
        • sms_sender_address: CharField, Required
        • regex: CharField, Required
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • regexs: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • url: URLField,
        • token: CharField,
        • sms_sender_address: CharField,
        • regex: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/sms-groups/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Sms Transactions Group

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • url: URLField,
        • token: CharField,
        • sms_sender_address: CharField, Required
        • regex: CharField, Required
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • regexs: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • url: URLField,
        • token: CharField,
        • sms_sender_address: CharField,
        • regex: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • sms-regex-types

    • • swap_horiz /api/v1/sms-regex-types/

        GET POST OPTIONS

        List Create Sms Transaction Regex Types

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • value: CharField, Required
        • regex: CharField, Required
        • active: BooleanField,
        • extra_fields: JSONField,
        • extra_regex: CharField,
        • group: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • group_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • value: CharField,
        • regex: CharField,
        • active: BooleanField,
        • extra_fields: JSONField,
        • extra_regex: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • group: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/sms-regex-types/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Sms Transaction Regex Type

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • value: CharField, Required
        • regex: CharField, Required
        • active: BooleanField,
        • extra_fields: JSONField,
        • extra_regex: CharField,
        • group: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • group_name: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • value: CharField,
        • regex: CharField,
        • active: BooleanField,
        • extra_fields: JSONField,
        • extra_regex: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • group: PrimaryKeyRelatedField Help Text

        }

  • tags

    • • swap_horiz /api/v1/tags/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Tag

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • image: ImageField,
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • image: ImageField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/tags/

        GET POST OPTIONS

        List Create Tags

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • image: ImageField,
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • image: ImageField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • translation-locales

    • • swap_horiz /api/v1/translation-locales/

        GET POST OPTIONS

        List Create Translation Locales

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • name: CharField, Required
        • country_code: CharField, Required
        • language_code: CharField, Required
        • translations: JSONField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • country_code: CharField,
        • language_code: CharField,
        • translations: JSONField,
        • version: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/translation-locales/flutter/

        GET OPTIONS

        List Flutter Formatted Translation Locales

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowAny	Allow any access. This isn't strictly required, since you could use an empty permission_classes list, but it's useful because it makes the intention more explicit.

        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • country_code: CharField,
        • language_code: CharField,
        • translations: JSONField,
        • version: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/translation-locales/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Translation Locale

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • country_code: CharField, Required
        • language_code: CharField, Required
        • translations: JSONField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • country_code: CharField,
        • language_code: CharField,
        • translations: JSONField,
        • version: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • translation-texts

    • • swap_horiz /api/v1/translation-texts/

        GET POST OPTIONS

        List Create Translation Texts

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • title: CharField, Required
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • title: CharField,
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/translation-texts/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Translation Text

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • title: CharField, Required
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • title: CharField,
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • locale-translation-texts

    • • swap_horiz /api/v1/locale-translation-texts/

        GET POST OPTIONS

        List Create Locale Translation Texts

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • translated_text: CharField,
        • locale: PrimaryKeyRelatedField, Required Help Text
        • text: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • translated_text: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • locale: PrimaryKeyRelatedField, Help Text
        • text: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/locale-translation-texts/stats/<type>/

        GET OPTIONS

        List Dynamic Locale Translation Texts Statistics

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        `type` = {stat_types}
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • language: ReadOnlyField,
        • country_code: ReadOnlyField,
        • language_code: ReadOnlyField,
        • original: ReadOnlyField,
        • original_description: ReadOnlyField,
        • translated: ReadOnlyField,
        • is_translated: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • translated_text: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • locale: PrimaryKeyRelatedField, Help Text
        • text: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/locale-translation-texts/<pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Locale Translation Text

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • translated_text: CharField,
        • locale: PrimaryKeyRelatedField, Required Help Text
        • text: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • translated_text: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • locale: PrimaryKeyRelatedField, Help Text
        • text: PrimaryKeyRelatedField Help Text

        }

  • subscription-plans

    • • swap_horiz /api/v1/subscription-plans/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Subscription Plan

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • amount: FloatField, Required
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField, Required
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • amount: FloatField,
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField,
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscription-plans/

        GET POST OPTIONS

        List Create Subscription Plans

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        amount	Amount
        discount	Discount
        hidden	Hidden
        interval	Interval

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • amount: FloatField, Required
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField, Required
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • amount: FloatField,
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField,
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • subscriptions

    • • swap_horiz /api/v1/subscriptions/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Subscription

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • customer: PrimaryKeyRelatedField, Required Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_name: ReadOnlyField,
        • plan_id: ReadOnlyField,
        • payment_id: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_amount_paid: ReadOnlyField,
        • plan_latest_transaction_date: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • start_date: DateTimeField,
        • next_payment_date: DateTimeField,
        • is_active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField, Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/me/mpesa-payments/

        GET POST OPTIONS

        List Create Subscription Mpesa Payments

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • plan_quantity: IntegerField,
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/

        GET POST OPTIONS

        List Create Subscriptions

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • customer: PrimaryKeyRelatedField, Required Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_name: ReadOnlyField,
        • plan_id: ReadOnlyField,
        • payment_id: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_amount_paid: ReadOnlyField,
        • plan_latest_transaction_date: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • start_date: DateTimeField,
        • next_payment_date: DateTimeField,
        • is_active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField, Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/active-trial/

        GET POST OPTIONS

        Activate Trial Subscription

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • customer: PrimaryKeyRelatedField, Required Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_name: ReadOnlyField,
        • plan_id: ReadOnlyField,
        • payment_id: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_amount_paid: ReadOnlyField,
        • plan_latest_transaction_date: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • start_date: DateTimeField,
        • next_payment_date: DateTimeField,
        • is_active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField, Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

  • mpesa-payments

    • • swap_horiz /api/v1/mpesa-payments/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Mpesa Payment

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • plan_quantity: IntegerField,
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

  • product-variants

    • • swap_horiz /api/v1/product-variants/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Variant

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField, Required
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • main_file: URLField,
        • product: PrimaryKeyRelatedField, Required Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • product_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • description: ReadOnlyField,
        • price: ReadOnlyField,
        • is_low_stock: ReadOnlyField,
        • attributes_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • name: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • value: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • attribute: PrimaryKeyRelatedField Help Text

          }
        • product_image: Base64ImageField,
        • product_cache_image: SerializerMethodField,
        • product_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField,
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product: PrimaryKeyRelatedField, Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-variants/

        GET POST OPTIONS

        List Create Product Variants

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField, Required
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • main_file: URLField,
        • product: PrimaryKeyRelatedField, Required Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • product_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • description: ReadOnlyField,
        • price: ReadOnlyField,
        • is_low_stock: ReadOnlyField,
        • attributes_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • name: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • value: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • attribute: PrimaryKeyRelatedField Help Text

          }
        • product_image: Base64ImageField,
        • product_cache_image: SerializerMethodField,
        • product_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField,
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product: PrimaryKeyRelatedField, Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Help Text

        }

  • purchases

    • • swap_horiz /api/v1/purchases/mpesa-payments/

        POST OPTIONS

        List Create Direct Purchase Mpesa Payments

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        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
        email	Email
        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

        
        

        Request Fields:

        {

        • product_variant: IntegerField, Required
        • quantity: IntegerField, Required
        • name: CharField, Required
        • email: EmailField, Required
        • phone: CharField, Required

        }

        
        

        Response Fields:

        {

        • name: CharField,
        • email: EmailField,
        • phone: CharField,
        • id: ReadOnlyField,
        • total_items: ReadOnlyField,
        • total_price: ReadOnlyField,
        • status: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }

        }
    • • swap_horiz /api/v1/purchases/me/

        GET POST OPTIONS

        List Create My Purchases

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        email	Email
        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

        
        

        Request Fields:

        {

        • raw_items: ListSerializer,
          Item structure

          {

          • product_variant: IntegerField, Required
          • quantity: IntegerField Required

          }
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • notes: CharField,
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/stats/<str:type>/

        GET OPTIONS

        List Dynamic Purchases Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        `type` = {stat_types}
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        email	Email
        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Purchase

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • raw_items: ListSerializer,
          Item structure

          {

          • product_variant: IntegerField, Required
          • quantity: IntegerField Required

          }
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • notes: CharField,
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/<int:pk>/mpesa-payments/

        GET POST OPTIONS

        List Create Purchase Mpesa Payments

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        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

        
        

        Request Fields:

        {

        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • plan_quantity: IntegerField,
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/<str:reference_number>/

        GET OPTIONS

        Retrieve Purchase By Reference Number

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/

        GET POST OPTIONS

        List Create Purchases

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        email	Email
        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

        
        

        Request Fields:

        {

        • raw_items: ListSerializer,
          Item structure

          {

          • product_variant: IntegerField, Required
          • quantity: IntegerField Required

          }
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • notes: CharField,
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • product-categorys

    • • swap_horiz /api/v1/product-categorys/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Category

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-categorys/

        GET POST OPTIONS

        List Create Product Categorys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • product-sub-categorys

    • • swap_horiz /api/v1/product-sub-categorys/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Sub Category

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • category: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • products: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • variants_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • image: Base64ImageField,
            • cache_image: SerializerMethodField,
            • avatar_image: SerializerMethodField,
            • product_name: ReadOnlyField,
            • category_name: ReadOnlyField,
            • sub_category_name: ReadOnlyField,
            • description: ReadOnlyField,
            • price: ReadOnlyField,
            • is_low_stock: ReadOnlyField,
            • attributes_details: ListSerializer,
              Item structure

              {

              • id: IntegerField,
              • name: ReadOnlyField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • value: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • attribute: PrimaryKeyRelatedField Help Text

              }
            • product_image: Base64ImageField,
            • product_cache_image: SerializerMethodField,
            • product_avatar_image: SerializerMethodField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • active: BooleanField,
            • sku: CharField,
            • discount: DecimalField,
            • initial_stock: IntegerField,
            • stock: IntegerField,
            • low_stock_threshold: IntegerField,
            • thumbnail_url: URLField,
            • poster_url: URLField,
            • preview_url: URLField,
            • sprites_url: URLField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • product: PrimaryKeyRelatedField, Help Text
            • shop: PrimaryKeyRelatedField, Help Text
            • attributes: ManyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • description: CharField,
          • base_price: DecimalField,
          • created_at: DateTimeField,
          • updated_at: DateTimeField,
          • venue: CharField,
          • start_time: DateTimeField,
          • end_time: DateTimeField,
          • has_unlimited_stock: BooleanField,
          • active: BooleanField,
          • trailer_url: URLField,
          • trailer_preview_url: URLField,
          • can_be_redeemed: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • sub_category: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • category: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-sub-categorys/

        GET POST OPTIONS

        List Create Product Sub Categorys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • category: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • products: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • variants_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • image: Base64ImageField,
            • cache_image: SerializerMethodField,
            • avatar_image: SerializerMethodField,
            • product_name: ReadOnlyField,
            • category_name: ReadOnlyField,
            • sub_category_name: ReadOnlyField,
            • description: ReadOnlyField,
            • price: ReadOnlyField,
            • is_low_stock: ReadOnlyField,
            • attributes_details: ListSerializer,
              Item structure

              {

              • id: IntegerField,
              • name: ReadOnlyField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • value: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • attribute: PrimaryKeyRelatedField Help Text

              }
            • product_image: Base64ImageField,
            • product_cache_image: SerializerMethodField,
            • product_avatar_image: SerializerMethodField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • active: BooleanField,
            • sku: CharField,
            • discount: DecimalField,
            • initial_stock: IntegerField,
            • stock: IntegerField,
            • low_stock_threshold: IntegerField,
            • thumbnail_url: URLField,
            • poster_url: URLField,
            • preview_url: URLField,
            • sprites_url: URLField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • product: PrimaryKeyRelatedField, Help Text
            • shop: PrimaryKeyRelatedField, Help Text
            • attributes: ManyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • description: CharField,
          • base_price: DecimalField,
          • created_at: DateTimeField,
          • updated_at: DateTimeField,
          • venue: CharField,
          • start_time: DateTimeField,
          • end_time: DateTimeField,
          • has_unlimited_stock: BooleanField,
          • active: BooleanField,
          • trailer_url: URLField,
          • trailer_preview_url: URLField,
          • can_be_redeemed: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • sub_category: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • category: PrimaryKeyRelatedField Help Text

        }

  • products

    • • swap_horiz /api/v1/products/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • base_price: DecimalField, Required
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • sub_category: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • variants_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • product_name: ReadOnlyField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • description: ReadOnlyField,
          • price: ReadOnlyField,
          • is_low_stock: ReadOnlyField,
          • attributes_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • name: ReadOnlyField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • value: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • attribute: PrimaryKeyRelatedField Help Text

            }
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • active: BooleanField,
          • sku: CharField,
          • discount: DecimalField,
          • initial_stock: IntegerField,
          • stock: IntegerField,
          • low_stock_threshold: IntegerField,
          • thumbnail_url: URLField,
          • poster_url: URLField,
          • preview_url: URLField,
          • sprites_url: URLField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • product: PrimaryKeyRelatedField, Help Text
          • shop: PrimaryKeyRelatedField, Help Text
          • attributes: ManyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • base_price: DecimalField,
        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/products/

        GET POST OPTIONS

        List Create Products

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        base_price	Base Price
        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • base_price: DecimalField, Required
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • sub_category: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • variants_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • product_name: ReadOnlyField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • description: ReadOnlyField,
          • price: ReadOnlyField,
          • is_low_stock: ReadOnlyField,
          • attributes_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • name: ReadOnlyField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • value: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • attribute: PrimaryKeyRelatedField Help Text

            }
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • active: BooleanField,
          • sku: CharField,
          • discount: DecimalField,
          • initial_stock: IntegerField,
          • stock: IntegerField,
          • low_stock_threshold: IntegerField,
          • thumbnail_url: URLField,
          • poster_url: URLField,
          • preview_url: URLField,
          • sprites_url: URLField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • product: PrimaryKeyRelatedField, Help Text
          • shop: PrimaryKeyRelatedField, Help Text
          • attributes: ManyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • base_price: DecimalField,
        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField Help Text

        }

  • shops

    • • swap_horiz /api/v1/shops/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Shop

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowOnlyGetRequests	Custom permission to allow only GET requests.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • banner_image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • banner_image: Base64ImageField,
        • banner_cache_image: SerializerMethodField,
        • banner_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/shops/

        GET POST OPTIONS

        List Create Shops

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • banner_image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • banner_image: Base64ImageField,
        • banner_cache_image: SerializerMethodField,
        • banner_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • stock-in-logs

    • • swap_horiz /api/v1/stock-in-logs/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Stock In Log

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: ImageField,
        • quantity: IntegerField, Required
        • cost_per_unit: DecimalField, Required
        • received_date: DateField, Required
        • remarks: CharField,
        • product_variant: PrimaryKeyRelatedField, Required Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • quantity: IntegerField,
        • cost_per_unit: DecimalField,
        • total_cost: DecimalField,
        • received_date: DateField,
        • remarks: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField, Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/stock-in-logs/

        GET POST OPTIONS

        List Create Stock In Logs

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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

        
        

        Request Fields:

        {

        • image: ImageField,
        • quantity: IntegerField, Required
        • cost_per_unit: DecimalField, Required
        • received_date: DateField, Required
        • remarks: CharField,
        • product_variant: PrimaryKeyRelatedField, Required Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • quantity: IntegerField,
        • cost_per_unit: DecimalField,
        • total_cost: DecimalField,
        • received_date: DateField,
        • remarks: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField, Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

  • purchase-devices

    • • swap_horiz /api/v1/purchase-devices/<str:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Purchase Device

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • device_id: CharField, Required
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField, Required
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • os_version: IntegerField, Required
        • os_version_name: CharField, Required
        • firebase_token: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • device_id: CharField,
        • delivery_addresses: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField,
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • is_primary_device: BooleanField,
        • is_verifed: BooleanField,
        • os_version: IntegerField,
        • os_version_name: CharField,
        • firebase_token: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-devices/

        GET POST OPTIONS

        List Create Purchase Devices

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        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

        
        

        Request Fields:

        {

        • device_id: CharField, Required
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField, Required
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • os_version: IntegerField, Required
        • os_version_name: CharField, Required
        • firebase_token: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • device_id: CharField,
        • delivery_addresses: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField,
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • is_primary_device: BooleanField,
        • is_verifed: BooleanField,
        • os_version: IntegerField,
        • os_version_name: CharField,
        • firebase_token: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • delivery-addresses

    • • swap_horiz /api/v1/delivery-addresses/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Delivery Address

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField, Required
        • lng: FloatField, Required
        • notes: CharField,
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField,
        • lng: FloatField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/delivery-addresses/<str:device_id>/

        GET POST OPTIONS

        List Create Delivery Addresss

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        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

        
        

        Request Fields:

        {

        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField, Required
        • lng: FloatField, Required
        • notes: CharField,
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField,
        • lng: FloatField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • purchase-items

    • • swap_horiz /api/v1/purchase-items/stats/<str:type>/

        GET OPTIONS

        List Dynamic Purchase Items Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        `type` = {stat_types}
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        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

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • quantity: IntegerField,
        • price: DecimalField,
        • discount: DecimalField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/stats/

        GET POST OPTIONS

        Get Stats Purchase Items

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        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
        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

        
        

        Request Fields:

        {

        • purchase_device: PrimaryKeyRelatedField, Help Text
        • quantity: IntegerField,
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • quantity: IntegerField,
        • price: DecimalField,
        • discount: DecimalField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Purchase Item

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • purchase_device: PrimaryKeyRelatedField, Help Text
        • quantity: IntegerField,
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/

        GET POST OPTIONS

        List Create Purchase Items

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        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

        
        

        Request Fields:

        {

        • purchase_device: PrimaryKeyRelatedField, Help Text
        • quantity: IntegerField,
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/redeem/

        POST OPTIONS

        Redeem Purchase Item

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • reference: CharField, Required
        • hash: CharField, Required
        • status: ChoiceField Required
          Choices

          Value	Meaning
          PENDING	PENDING
          REDEEMING	REDEEMING
          REDEEMED	REDEEMED

        }

        
        

        Response Fields:

        {

        • reference: CharField,
        • hash: CharField,
        • status: ChoiceField
          Choices

          Value	Meaning
          PENDING	PENDING
          REDEEMING	REDEEMING
          REDEEMED	REDEEMED

        }