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/settings/project |
Method(s): | get |
Response Formats: | JSON, XML |
Description: | This method allows you to retrieve all project related settings for a user. |
Response Elements
| Name | Description |
|---|---|
| CustomerDisplayFormat | Setting that indicates how the customer’s first and last name should be arranged while displaying it. For 0 – Smith, John, Mr ; 1 – Smith, John; 3 – John Smith |
| ProjectStartDateName | User’s customized name for start date of project |
| ProjectEndDateName | User’s customized name for end date of project |
| IsEnabled | Setting for whether project is enabled or not for the user. When this setting is enabled, invoices and purchases can be assigned to individual “jobs” or “projects”. This helps in the tracking of the total amount spent and earned on a specific project. |
| ProjectText | User’s customized name for project |
| ProjectOnBankLine | Whether project is enabled or not for bank line items |
| ProjectOnInvoiceLine | Setting for whether project is enabled or not for invoice line items. Projects can be allocated to individual lines because an invoice may spans across multiple Projects. |
| ProjectOnJournal | Whether project is enabled or not for journal |
| ProjectOnReceiptLine | Setting for whether project is enabled or not for receipt line items. Projects can be allocated to individual lines because a receipt may spans across multiple Projects. |
| ProjectPrint | Whether project print feature is enabled or not for the user |
| ProjectSortOrder | User’s preferred ordering on project list. Possible values are 0, 1 and 2. 0 – Sorting on number, 1 – Sorting on name, 2 – Sorting on creation |
| ShowCustomerPostCode | Whether customer post code should be shown for project |
| VatRegistered | Whether user is vat registered or not |
| IsWorkInProgressEnabled | Whether work-in-progress value needs to be displayed for any project in the user account |
GET Operation
Returns project settings for user.URL : /settings/project
Example response for GET of project settings
{
"CustomerDisplayFormat": "0",
"ProjectDate1Name": "Start Date",
"ProjectDate2Name": "End Date",
"IsEnabled": true,
"ProjectText": "Project",
"ProjectOnBankLine": true,
"ProjectOnInvoiceLine": true,
"ProjectOnJournal": true,
"ProjectOnReceiptLine": true,
"ProjectPrint": true,
"ProjectSortOrder": 0,
"ShowCustomerPostCode": true,
"VatRegistered": true,
"IsWorkInProgressEnabled": true
}