Fuel Management
api-key-token
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required |
assign-sticker
list
card_count [Total cards left in stock]
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:param request: :param args: :param kwargs: :return: super admin can assign the sticker to organization in bulk if they don't have much sticker give error
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
count required | |
organisation required |
assign_sticker_by_pos
Assign the cards to the user from pos device
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
vehicle required | |
sticker required |
sticker_unassigned
:param request: company :return: List of sticker still which are not assigned to any Vehicle.
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
cards
list
card_count [Total cards left in stock]
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Card API for Super and Organisation Admin users.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
organization | |
name | |
serial_no required | |
is_active | |
is_issued | |
issued_date | |
purchased_date | |
invoice_no |
read
Card API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Card API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
organization | |
name | |
serial_no required | |
is_active | |
is_issued | |
issued_date | |
purchased_date | |
invoice_no |
partial_update
Card API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
organization | |
name | |
serial_no | |
is_active | |
is_issued | |
issued_date | |
purchased_date | |
invoice_no |
reset_pin
Card API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
organization | |
name | |
serial_no | |
is_active | |
is_issued | |
issued_date | |
purchased_date | |
invoice_no |
pin > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
old_pin required | |
new_pin required | |
confirm_pin required |
company
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:return: Organization Admin created from this api
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
description | |
address | |
address2 | |
city | |
zip_code | |
website | |
is_active | |
contact_email | |
contact_name | |
contact_phone | |
is_duty_free | |
fuel_station required |
company_emp
:param request: company with its id :return: List of end user associate with that company
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
description | |
address | |
address2 | |
city | |
zip_code | |
website | |
is_active | |
contact_email | |
contact_name | |
contact_phone | |
is_duty_free | |
fuel_station required |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
description | |
address | |
address2 | |
city | |
zip_code | |
website | |
is_active | |
contact_email | |
contact_name | |
contact_phone | |
is_duty_free | |
fuel_station |
contact
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
designation | |
contact | |
alt_contact | |
organisation_name | |
address | |
email required | |
contact_type |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
coupons
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
coupon_details required | |
qr_image | |
created_by_external | |
created_by |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
status required | |
qr_image | |
created_by_external | |
created_by |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
coupon_details | |
qr_image | |
created_by_external | |
created_by |
depot-exempt-admin
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:return: Organization Admin created from this api
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
profile_picture | |
is_depot_admin | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required | |
first_name | |
last_name | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
profile_picture |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
profile_picture | |
is_depot_admin | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
duty-free-request-organization
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required | |
quantity | |
validity | |
documents_description | |
organisation required | |
fuel_type required |
report
:param request: 1. dispatch_report=true para for Total dispatched from depot to mini stations 2. For Consumption Report use consumption_report=true and inside para is organization, from_date, to_date 3. Otherwise give the issued duty free report of amounts in liter inside para is organization, from_date, to_date :return: report
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
update
:param request: To update the status of the request by Government admin :param pk: pk :return: record data
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
reject_reason | |
request_status | |
stock_certificate |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file | |
quantity | |
validity | |
documents_description | |
organisation | |
fuel_type |
email-notification
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
attachment | |
title required | |
description | |
send_from required | |
sent_to required |
employee-fuel-request
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:param request: :param args: :param kwargs: :return: End user
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_mini_station | |
quantity required | |
reference_text |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
request_status | |
reference_text |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_mini_station | |
quantity | |
reference_text |
end-user
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
mini_station | |
is_mini_station_emp | |
company | |
fuel_station_amount | |
mini_station_amount | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
subscription | |
profile_picture | |
card | |
driver_license | |
token_month_limit | |
check_sticker |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required | |
first_name | |
last_name | |
contact | |
alt_contact | |
address | |
city | |
is_mini_station_emp | |
zip_code | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
profile_picture | |
subscription | |
driver_license | |
card | |
mini_station | |
fuel_station_amount | |
mini_station_amount | |
token_month_limit | |
check_sticker |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
mini_station | |
is_mini_station_emp | |
company | |
fuel_station_amount | |
mini_station_amount | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
subscription | |
profile_picture | |
card | |
driver_license | |
token_month_limit | |
check_sticker |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-price
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_station_location required | |
fuel_type required | |
price |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_station_location required | |
fuel_type required | |
price |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_station_location | |
fuel_type | |
price |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-request-bysmartfuel
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:param request: :param args: :param kwargs: :return: super admin can assign the sticker to organization in bulk if they don't have much sticker give error
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_detail required | |
total_fuel | |
description | |
paid_amount | |
payment_date | |
payment_type | |
reference_text | |
fuel_station required |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
request_status | |
reference_text |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_detail | |
total_fuel | |
description | |
paid_amount | |
payment_date | |
payment_type | |
reference_text | |
fuel_station |
fuel-request-organization
list
Fuel Request raise by organization admin only and then it will show to super admin after approve goes to depot admin
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:param request: :param args: :param kwargs: :return: organization admin can create a new request.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
total_fuel | |
price_per_litre | |
intended_issue_date | |
intended_payment_date | |
delivery_address | |
city | |
description | |
reject_reason | |
is_duty_free | |
certificate_image | |
is_dispached | |
bulk_fuel | |
bulk_price | |
driver_licence | |
vehicle_photo | |
is_credited | |
credit_amount | |
paid_amount | |
payment_date | |
payment_type | |
reference_text | |
tax_waived_amount | |
payment_receipt | |
fuel_type | |
ministation |
intended_date_change
:param request: To update the intended date :return: updated intended date
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
id required | |
intended_issue_date |
read
Fuel Request raise by organization admin only and then it will show to super admin after approve goes to depot admin
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Fuel Request raise by organization admin only and then it will show to super admin after approve goes to depot admin
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
request_status | |
depot_receipt | |
reject_reason | |
payment_date | |
payment_type | |
reference_text |
partial_update
Fuel Request raise by organization admin only and then it will show to super admin after approve goes to depot admin
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
total_fuel | |
price_per_litre | |
intended_issue_date | |
intended_payment_date | |
delivery_address | |
city | |
description | |
reject_reason | |
is_duty_free | |
certificate_image | |
is_dispached | |
bulk_fuel | |
bulk_price | |
driver_licence | |
vehicle_photo | |
is_credited | |
credit_amount | |
paid_amount | |
payment_date | |
payment_type | |
reference_text | |
tax_waived_amount | |
payment_receipt | |
fuel_type | |
ministation |
fuel-station
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
description | |
is_active | |
contact_email | |
contact_name | |
contact_phone | |
image | |
one_point_amount | |
consecutive_no_transaction | |
trasnsction_discount |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
description | |
is_active | |
contact_email | |
contact_name | |
contact_phone | |
image | |
one_point_amount | |
consecutive_no_transaction | |
trasnsction_discount |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
description | |
is_active | |
contact_email | |
contact_name | |
contact_phone | |
image | |
one_point_amount | |
consecutive_no_transaction | |
trasnsction_discount |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-station-admin
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
address | |
contact | |
alt_contact | |
city | |
zip_code | |
fuel_station | |
profile_picture | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
address | |
contact | |
alt_contact | |
city | |
zip_code | |
fuel_station | |
profile_picture | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email | |
address | |
contact | |
alt_contact | |
city | |
zip_code | |
fuel_station | |
profile_picture | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-station-employee
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
address | |
city | |
contact | |
alt_contact | |
zip_code | |
profile_picture | |
fuel_station | |
fuel_station_location | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
change_pin
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
old_pin required | |
new_pin required | |
confirm_pin required |
verify_pin
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pin required |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
address | |
city | |
contact | |
alt_contact | |
zip_code | |
profile_picture | |
fuel_station | |
fuel_station_location | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email | |
address | |
city | |
contact | |
alt_contact | |
zip_code | |
profile_picture | |
fuel_station | |
fuel_station_location | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-station-location
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_ids | |
fuel_detail | |
pump_number | |
is_active | |
address | |
address2 | |
city | |
zip_code | |
latitude | |
longitude | |
image | |
fuel_station required |
add_pos
add new POS machines under the fuel station location : param request: fuel_station_location_id, pos_ids: [1,2]
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_station_location_id required | |
pos_ids required |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_active | |
address | |
address2 | |
no_of_employees | |
no_of_pos | |
city | |
zip_code | |
latitude | |
longitude | |
image | |
fuel_station required |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_ids | |
fuel_detail | |
pump_number | |
is_active | |
address | |
address2 | |
city | |
zip_code | |
latitude | |
longitude | |
image | |
fuel_station |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-station-pos
list
List of the pos machines assigned to the fuel station
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
fuel-type
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_type required |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_type required |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fuel_type |
delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
search | A search term. |
general-setting
org_qouta
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_duty_free |
setting
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
standard_fuel_price required | |
email_notification | |
sms_notification | |
fuel_limit | |
tax_percent | |
loyalty_point_limit |
get-sms
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
login
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
username required | Valid username for authentication |
password required | Valid password for authentication |
logout
loyalty-gifts
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
product_id required | |
product_name | |
quantity | |
product_amount | |
image | |
product_description |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
quantity | |
product_amount | |
image | |
product_description | |
product_view |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
product_id | |
product_name | |
quantity | |
product_amount | |
image | |
product_description |
mini-station
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_ids | |
pump_number | |
is_active | |
address | |
address2 | |
city | |
zip_code | |
latitude | |
longitude | |
image | |
organization required |
add_pos_device
add new POS machines under the fuel station location : param request: fuel_station_location_id, pos_ids: [1,2]
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
mini_station_id required | |
pos_ids required |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_ids | |
pump_number | |
is_active | |
address | |
address2 | |
city | |
zip_code | |
latitude | |
longitude | |
image |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_ids | |
pump_number | |
is_active | |
address | |
address2 | |
city | |
zip_code | |
latitude | |
longitude | |
image | |
organization |
notification
modify
:param request: To update the status of the notification :return: record data
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
notification_id |
organisation-cards
list
card_count [Total cards left in stock]
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Organisation Cards API for Super and Organisation Admin users. Send the 'organisation_id' and all_cards =1 field to get the organisation cards in the List api
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pin | |
is_active | |
card required | |
user | |
organisation required |
assign_cards
Assign the cards to the organisations
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
total_cards required | |
organisation_id required |
assign_cards_by_pos
Assign the cards to the user from pos device
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
card required | |
user |
unassigned_cards
: param request: organisation_id :return: List of cards assigned to the organisation which are left. This API will be used for showing the left cards in dropdown.
organisation-subscription
list
Organisation Subscription List API for Super and Organisation Admin users. Params: organisation_id return: 404 or list of the organisation subsctiptions
read
Organisation Subscription List API for Super and Organisation Admin users. Params: organisation_id return: 404 or list of the organisation subsctiptions
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this organisation subscription. |
requests > list
Organisation Subscription Requests List API for Super Admin users.
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
requests > create
:param request: request to update the organisation subscriptions :return: created record
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
updated_fuel | |
updated_amount | |
organisation_subscription | |
status |
requests > update
:param request: To update the status of the request by Super Admin :param pk: pk :return: record data
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
updated_fuel | |
updated_amount | |
organisation_subscription | |
status |
requests > partial_update
Organisation Subscription Requests List API for Super Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
updated_fuel | |
updated_amount | |
organisation_subscription | |
status |
organization-admin
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:return: Organization Admin created from this api
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
profile_picture | |
company | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
assign_quota
:param request: users [1,2] OR all_users: true/false in case of organisation admin, but for super admin also send organisation_id [required] :return: List of sticker still which are not assigned to any Vehicle.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
users | |
all_users | |
organisation_id | |
custom_assign | |
fuel_station_amount | |
mini_station_amount |
deduct_qouta
:param request: :return:
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
users required | |
organisation_id required | |
fuel_station_amount | |
mini_station_amount |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required | |
first_name | |
last_name | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
profile_picture |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
profile_picture | |
company | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
pos
list
pos_count [Total POS left in stock]
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
POS API for Super and Fuel Station Admin users.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_manufacturer | |
name | |
model_no | |
is_active | |
serial_no required | |
is_issued | |
purchased_date | |
invoice_no |
assign_pos
Assign the number of the pos machines to the fuel station. Parameters: fuel_station_id, total_pos
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
total_pos required | |
fuel_station_id | |
organization_id |
unassigned_pos
: param request: fuel_station_id, organization_id : return: This API will be used for showing the left pos in dropdown.
read
POS API for Super and Fuel Station Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
POS API for Super and Fuel Station Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_manufacturer | |
name | |
model_no | |
is_active | |
serial_no required | |
purchased_date | |
invoice_no |
partial_update
POS API for Super and Fuel Station Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pos_manufacturer | |
name | |
model_no | |
is_active | |
serial_no | |
is_issued | |
purchased_date | |
invoice_no |
pre-register
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
contact | |
alt_contact | |
company_name | |
designation | |
company_address | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
individual |
quota-logs
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
redeem-points
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
create
:param request: Redeem the loyalty points :return: created record
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
gift_items required |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
delivery_status |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
gift_items |
service-provider
coupons > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
payment_amount required | |
transaction_id required | |
transaction_date required | |
transaction_time | |
client_name required | |
mobile_number required | |
email |
coupons > transactions
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
mobile_number required |
coupons > last_transaction_status
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
transaction_id required |
logs > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
sticker
list
card_count [Total cards left in stock]
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
serial_no required | |
is_active | |
issue_date |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
serial_no required | |
is_active | |
issue_date |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
serial_no | |
is_active | |
issue_date |
stock
sub-admin
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
create
:return: Organization Admin created from this api
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email required | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
profile_picture | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
permissions |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required | |
first_name | |
last_name | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
profile_picture | |
permissions |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
email | |
contact | |
alt_contact | |
address | |
city | |
zip_code | |
profile_picture | |
is_active | Designates whether this user should be treated as active. Unselect this instead of deleting accounts. |
permissions |
subscription
read
Subscription List API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this subscription. |
update
Subscription List API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this subscription. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
description | |
fuel | |
amount | |
is_active |
partial_update
Subscription List API for Super and Organisation Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A unique integer value identifying this subscription. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
description | |
fuel | |
amount | |
is_active |
transaction
list
List of the transactions based on the fields: Like card_id, pos_id, fuel_station_id, ministation_location_id, fuel_station_location_id, sticker_id, vehicle_id, vehicle_id, fuel_type_id, vehicle_number || STRING BASED FIELDS || vehicle_number card_serial_no sticker_serial_no pos_serial_no fuel_station_name fuel_station_location_address ministation_location_address organisation_name coupon_code is_duty_free is_mini_station txn_number || ID BASED FIELDS || organisation_id card_id pos_id fuel_station_id ministation_location_id fuel_station_location_id sticker_id vehicle_id fuel_type_id
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
process
Commit the transaction and update the various reserves and wallet of user # Param request: Transaction fields ["org_employee, pos_employee, fuel_type, station_location, pos_device, card, vehicle, vehicle_number, fuel_purchase_amount, quantity, fuel_price, is_duty_free, is_mini_station"] # Return: Transaction response
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pin | |
org_employee required | |
fuel_type required | |
pos required | |
card | |
vehicle | |
vehicle_number | |
sticker | |
fuel_purchase_amount | |
quantity | |
is_duty_free | |
coupon_code |
report
:param request: fuel_station, fuel_station_employee, organization, end_user, fuel_station_location, from_date, to_date, fuel_type :return: report
verify_card
:param request: card "searial_no" :return: Verify the details of the Sticker in respect to transaction
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
serial_no required | |
pos required |
verify_fuelcoupon
:param request: coupon_code, pos :return: Verify the details of the Coupon in respect to transaction
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
coupon_code required | |
pos required |
verify_sticker
:param request: Sticker "serial_no", pos, user [end user id from the card] :return: Verify the details of the Sticker in respect to transaction
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
serial_no required | |
user required | |
pos required |
read
Organisation Subscription Requests List API for Super Admin users.
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |
transaction-fees
list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
user
change_password
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
old_password required | |
new_password required | |
confirm_password required |
edit_profile
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
last_name | |
address | |
city | |
zip_code | |
contact | |
alt_contact | |
profile_picture |
reset_password_email
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required |
set_password
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
uid required | |
token required | |
new_password required | |
confirm_password required |
vehicle
create
:param request: user field data pass like [{"id":1}, {"id": 3}] :return: Create Vehicle and can able to assign multiple Vehicle
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
manufacturer | |
model_year | |
color | |
number required | |
fuel_type required | |
company | |
vehicle_image | |
is_active | |
user required | |
sticker |
update
:param request: :param pk: pk :return:
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
manufacturer | |
model_year | |
color | |
number required | |
fuel_type required | |
company | |
vehicle_image | |
is_active | |
user required | |
sticker |
partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
manufacturer | |
model_year | |
color | |
number | |
fuel_type | |
company | |
vehicle_image | |
is_active | |
user | |
sticker |
list > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
page | A page number within the paginated result set. |
page_size | Number of results to return per page. |
ordering | Which field to use when ordering the results. |
search | A search term. |
list > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
ordering | Which field to use when ordering the results. |
search | A search term. |