fbpx

User Permissions

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

NameDescription
FullAccessFull access to KashFlow account
ViewInvoicePermission to view invoice
CreateInvoicePermission to view and create invoice
EditInvoicePermission to view, create and edit invoice
DeleteInvoicePermission to view, create, edit and delete invoice (full access to invoices)
ViewQuotePermission to view quote
CreateQuotePermission to view and create quote
EditQuotePermission to view, create and edit quote
DeleteQuotePermission to view, create, edit and delete quote (full access to quotes)
ViewCustomerPermission to view customer
CreateCustomerPermission to view and create customer
EditCustomerPermission to view, create and edit customer
DeleteCustomerPermission to view, create, edit and delete customer (full access to customers)
ViewReceiptPermission to view receipt
CreateReceiptPermission to view and create receipt
EditReceiptPermission to view, create and edit receipt
ViewProjectPermission to view project
CreateProjectPermission to view and create project
EditProjectPermission to view, create and edit project
DeleteProjectPermission to view, create, edit and delete project (full access to projects)
ManageRolePermission to manage roles (administrative right)
ManageUserPermission 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"
]

See how KashFlow works with your business and your books