This s a documentation page for our shiny new REST API - you weren't meant to find it. This API isn't ready for public use yet. We're chopping and changing it a LOT as we grow it. So if you build something that uses it then it's very likely to break in a future update. Don't say you weren't warned!
URL: | https://api.kashflow.com/v2/userpermissions |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve the list of user’s permissions. |
Parameters
| Name | Description |
|---|---|
| FullAccess | Full access to KashFlow account |
| ViewInvoice | Permission to view invoice |
| CreateInvoice | Permission to view and create invoice |
| EditInvoice | Permission to view, create and edit invoice |
| DeleteInvoice | Permission to view, create, edit and delete invoice (full access to invoices) |
| ViewQuote | Permission to view quote |
| CreateQuote | Permission to view and create quote |
| EditQuote | Permission to view, create and edit quote |
| DeleteQuote | Permission to view, create, edit and delete quote (full access to quotes) |
| ViewCustomer | Permission to view customer |
| CreateCustomer | Permission to view and create customer |
| EditCustomer | Permission to view, create and edit customer |
| DeleteCustomer | Permission to view, create, edit and delete customer (full access to customers) |
| ViewReceipt | Permission to view receipt |
| CreateReceipt | Permission to view and create receipt |
| EditReceipt | Permission to view, create and edit receipt |
| ViewProject | Permission to view project |
| CreateProject | Permission to view and create project |
| EditProject | Permission to view, create and edit project |
| DeleteProject | Permission to view, create, edit and delete project (full access to projects) |
| ManageRole | Permission to manage roles (administrative right) |
| ManageUser | Permission to manage users (administrative right) |
GET Operation
GET of userpermissions returns the list of all permissions that a user has.URL : /userpermissions
Example response for GET of list of user permissions
[
"FullAccess",
"ViewInvoice",
"CreateInvoice",
"EditInvoice",
"DeleteInvoice",
"ViewQuote",
"CreateQuote",
"EditQuote",
"DeleteQuote",
"ViewCustomer",
"CreateCustomer",
"EditCustomer",
"DeleteCustomer",
"ViewReceipt",
"CreateReceipt",
"EditReceipt",
"ViewProject",
"CreateProject",
"EditProject",
"DeleteProject",
"ManageRole",
"ManageUser"
]