Project Settings

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

NameDescription
CustomerDisplayFormatSetting 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
ProjectStartDateNameUser’s customized name for start date of project
ProjectEndDateNameUser’s customized name for end date of project
IsEnabledSetting 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.
ProjectTextUser’s customized name for project
ProjectOnBankLineWhether project is enabled or not for bank line items
ProjectOnInvoiceLineSetting 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.
ProjectOnJournalWhether project is enabled or not for journal
ProjectOnReceiptLineSetting 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.
ProjectPrintWhether project print feature is enabled or not for the user
ProjectSortOrderUser’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
ShowCustomerPostCodeWhether customer post code should be shown for project
VatRegisteredWhether user is vat registered or not
IsWorkInProgressEnabledWhether 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
}

See how KashFlow works with your business and your books