Wavvy Wallet

users

/api/v1/users/

GET POST OPTIONS

List Create Clients

Open Link

Description
Authentication
Permissions
Filters

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

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

}

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

}

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

}

/api/v1/users/me/

GET PUT PATCH OPTIONS

Retrieve Update Client

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

}

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

}

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

}

/api/v1/users/technicians/

GET OPTIONS

List Technicians

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

}

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

}

/api/v1/users/me/profile/

GET PUT PATCH OPTIONS

Retrieve Client

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

}

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

}

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

}

/api/v1/users/forgot-password

POST OPTIONS

Clients Forgot Password

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

/api/v1/users/reset-password

POST PUT PATCH OPTIONS

Clients Reset Password

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

}

mpesa-numbers

/api/v1/mpesa-numbers/

GET POST OPTIONS

List Create Mpesa Numbers

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

}

/api/v1/mpesa-numbers/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Mpesa Number

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

/api/v1/activities/

GET POST OPTIONS

List Create Activitys

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

}

/api/v1/activities/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Activity

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

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

GET POST OPTIONS

List Mpesa Transactions Stats

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

}

/api/v1/mpesa-transactions/stats/

GET POST OPTIONS

List Mpesa Transactions Stats Stats

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

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

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Tagging Rule

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:

{

confidence_score: IntegerField,
name: CharField, Required
custom_name: CharField,
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,
custom_name: CharField,
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

}

/api/v1/tagging-rules/suggest-tags/

GET OPTIONS

Suggest Tagging Rules

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

/api/v1/tagging-rules/

GET POST OPTIONS

List Create Tagging Rules

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
custom_name	Custom Name
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
custom_name: CharField,
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,
custom_name: CharField,
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

/api/v1/activity-transactions/

GET POST OPTIONS

List Create Activity Transactions

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

}

/api/v1/activity-transactions/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Activity Transaction

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

}

List Create Categorys

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

}

/api/v1/categories/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Category

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

/api/v1/sub-categories/

GET POST OPTIONS

List Create Sub Categorys

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
name	Name
category	Category
user	User

Request Fields:

{

image: Base64ImageField,
description: CharField,
name: CharField, Required
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,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
category: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

/api/v1/sub-categories/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Sub Category

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
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,
created_by: PrimaryKeyRelatedField, Help Text
updated_by: PrimaryKeyRelatedField, Help Text
category: PrimaryKeyRelatedField, Help Text
user: PrimaryKeyRelatedField Help Text

}

accounts

/api/v1/accounts/

GET POST OPTIONS

List Create Accounts

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

}

/api/v1/accounts/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Account

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

/api/v1/account-members/

GET POST OPTIONS

List Create Account Members

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

}

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

}

/api/v1/account-members/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Account Member

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

}

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

/api/v1/devices/

GET POST OPTIONS

List Create Phone Devices

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

}

/api/v1/devices/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Phone Device

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

/api/v1/device-messages/

GET POST OPTIONS

List Create Device Messages

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

}

/api/v1/device-messages/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Device Message

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

/api/v1/customers/

GET POST OPTIONS

List Create Customers

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

}

/api/v1/customers/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Customer

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

/api/v1/customer-visits/

GET POST OPTIONS

List Create Customer Visits

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

}

/api/v1/customer-visits/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Customer Visit

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

/api/v1/customer-groups/

GET POST OPTIONS

List Create Customer Groups

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

}

/api/v1/customer-groups/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Customer Group

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

/api/v1/customer-group-participants/

GET POST OPTIONS

List Create Customer Group Participants

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

}

/api/v1/customer-group-participants/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Customer Group Participant

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

/api/v1/visit-transactions/

GET POST OPTIONS

List Create Visit Transactions

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

}

/api/v1/visit-transactions/stats/<type>

GET OPTIONS

List Visit Transactions Stats

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

}

/api/v1/visit-transactions/stats/

GET POST OPTIONS

List Visit Transactions Stats Stats

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

}

/api/v1/visit-transactions/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Visit Transaction

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

/api/v1/campaigns/

GET POST OPTIONS

List Create Campaigns

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

}

/api/v1/campaigns/<pk>/send/

GET PUT PATCH OPTIONS

Retrieve Send Campaign

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

}

/api/v1/campaigns/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Campaign

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

/api/v1/campaign-customers/

GET POST OPTIONS

List Create Campaign Customers

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

/api/v1/sms-groups/

GET POST OPTIONS

List Create Sms Transactions Groups

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

}

/api/v1/sms-groups/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Sms Transactions Group

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

/api/v1/sms-regex-types/

GET POST OPTIONS

List Create Sms Transaction Regex Types

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

}

/api/v1/sms-regex-types/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Sms Transaction Regex Type

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

}

Retrieve Update Destroy Tag

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

}

/api/v1/tags/

GET POST OPTIONS

List Create Tags

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

/api/v1/translation-locales/

GET POST OPTIONS

List Create Translation Locales

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

}

/api/v1/translation-locales/flutter/

GET OPTIONS

List Flutter Formatted Translation Locales

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

}

/api/v1/translation-locales/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Translation Locale

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

/api/v1/translation-texts/

GET POST OPTIONS

List Create Translation Texts

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

}

/api/v1/translation-texts/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Translation Text

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

/api/v1/locale-translation-texts/

GET POST OPTIONS

List Create Locale Translation Texts

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

}

/api/v1/locale-translation-texts/stats/<type>/

GET OPTIONS

List Dynamic Locale Translation Texts Statistics

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

}

/api/v1/locale-translation-texts/<pk>/

GET PUT PATCH DELETE OPTIONS

Retrieve Update Destroy Locale Translation Text

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

}

Wavvy Wallet

API Endpoints

api

v1

users

List Create Clients

Signup response includes an access token

Request Fields:

Response Fields:

Retrieve Update Client

Request Fields:

Response Fields:

List Technicians

Request Fields:

No input data specified

Response Fields:

Retrieve Client

Request Fields:

Response Fields:

Clients Forgot Password

Request Fields:

No input data specified

Response Fields:

No output data specified

Clients Reset Password

Request Fields:

Response Fields:

mpesa-numbers

List Create Mpesa Numbers

Request Fields:

Response Fields:

Retrieve Update Destroy Mpesa Number

Request Fields:

Response Fields:

activities

List Create Activitys

Request Fields:

Response Fields:

Retrieve Update Destroy Activity

Request Fields:

Response Fields:

mpesa-transactions

List Mpesa Transactions Stats

Request Fields:

Response Fields:

List Mpesa Transactions Stats Stats

Request Fields:

Response Fields:

tagging-rules

Retrieve Update Destroy Tagging Rule

Request Fields:

Response Fields:

Suggest Tagging Rules

Request Fields:

No input data specified

Response Fields:

No output data specified

List Create Tagging Rules

Request Fields:

Response Fields:

activity-transactions

List Create Activity Transactions

Request Fields:

Response Fields:

Retrieve Update Destroy Activity Transaction

Request Fields:

Response Fields:

categories

List Create Categorys

Request Fields:

Response Fields:

Retrieve Update Destroy Category

Request Fields:

Response Fields:

sub-categories

List Create Sub Categorys

Request Fields:

Response Fields:

Retrieve Update Destroy Sub Category

Request Fields: