Skip to main content

Get Active Gratuities

By calling this API, you can get the list of active gratuities in the specified outlet.

GET /integrations/mokapos/outlets/{outlet_id}/v1/library/gratuities

Path Parameters

AttributeDescriptionTypeRequired
outlet_idThe Outlet IDStringRequired

Query Parameters

AttributeDescriptionTypeRequired
per_pageThe max number of items on each pageIntegerOptional
pageThe number of the pageIntegerOptional

Sample Response - 200 Success

{
"success": true,
"data": {
"total_pages": 5,
"total_count": 5,
"gratuity": [
{
"id": 232904,
"name": "Service charge",
"amount": 1000,
"updated_at": "2021-11-22T13:41:25.734000+07:00",
"created_at": "2021-11-22T13:41:25.734000+07:00"
}
]
}
}
note

To perform this operation, you must be authenticated using go_auth_client_credentials(mokapos:reporting:read).