flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

Account_Get

OnInit
./lib/actions/Account_Get.js
OnStartup
-
OnClose
-

Attributes

-

Company_Get

OnInit
./lib/actions/Company_Get.js
OnStartup
-
OnClose
-

Attributes

-

Company_Post

OnInit
./lib/actions/Company_Post.js
OnStartup
-
OnClose
-

Attributes

-

Company_Put

Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.

OnInit
./lib/actions/Company_Put.js
OnStartup
-
OnClose
-

Attributes

-

Company_GetByID

OnInit
./lib/actions/Company_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Contact_Get

OnInit
./lib/actions/Contact_Get.js
OnStartup
-
OnClose
-

Attributes

-

Contact_Post

OnInit
./lib/actions/Contact_Post.js
OnStartup
-
OnClose
-

Attributes

-

Contact_GetByID

OnInit
./lib/actions/Contact_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

CreditNote_Get

OnInit
./lib/actions/CreditNote_Get.js
OnStartup
-
OnClose
-

Attributes

-

CreditNote_GetByID

OnInit
./lib/actions/CreditNote_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Currency_Get

OnInit
./lib/actions/Currency_Get.js
OnStartup
-
OnClose
-

Attributes

-

Estimate_Get

EstimateStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"

OnInit
./lib/actions/Estimate_Get.js
OnStartup
-
OnClose
-

Attributes

-

Estimate_GetByID

OnInit
./lib/actions/Estimate_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Expense_Get

OnInit
./lib/actions/Expense_Get.js
OnStartup
-
OnClose
-

Attributes

-

Expense_Post

Create an Expense

OnInit
./lib/actions/Expense_Post.js
OnStartup
-
OnClose
-

Attributes

-

Expense_GetByID

OnInit
./lib/actions/Expense_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Inventory_Get

OnInit
./lib/actions/Inventory_Get.js
OnStartup
-
OnClose
-

Attributes

-

Inventory_GetByID

OnInit
./lib/actions/Inventory_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Invoice_Get

TransactionStatusCode values are: "Draft", "Sent", "Late", "Paid", "Partial", "Void"

OnInit
./lib/actions/Invoice_Get.js
OnStartup
-
OnClose
-

Attributes

-

Invoice_Post

OnInit
./lib/actions/Invoice_Post.js
OnStartup
-
OnClose
-

Attributes

-

Invoice_GetByID

OnInit
./lib/actions/Invoice_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Payment_Get

OnInit
./lib/actions/Payment_Get.js
OnStartup
-
OnClose
-

Attributes

-

Payment_Post

OnInit
./lib/actions/Payment_Post.js
OnStartup
-
OnClose
-

Attributes

-

Payment_GetByID

OnInit
./lib/actions/Payment_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Project_Get

OnInit
./lib/actions/Project_Get.js
OnStartup
-
OnClose
-

Attributes

-

Project_Post

OnInit
./lib/actions/Project_Post.js
OnStartup
-
OnClose
-

Attributes

-

Project_GetByID

OnInit
./lib/actions/Project_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

ProjectTimesheetCategory_Get

OnInit
./lib/actions/ProjectTimesheetCategory_Get.js
OnStartup
-
OnClose
-

Attributes

-

Section_Get

OnInit
./lib/actions/Section_Get.js
OnStartup
-
OnClose
-

Attributes

-

Section_Post

OnInit
./lib/actions/Section_Post.js
OnStartup
-
OnClose
-

Attributes

-

Task_Get

OnInit
./lib/actions/Task_Get.js
OnStartup
-
OnClose
-

Attributes

-

Task_Post

OnInit
./lib/actions/Task_Post.js
OnStartup
-
OnClose
-

Attributes

-

Task_Put

Requires TaskID and a list of field names to update. The FieldsToUpdate field accepts a string array containing field names that should be updated.

OnInit
./lib/actions/Task_Put.js
OnStartup
-
OnClose
-

Attributes

-

Task_GetByID

OnInit
./lib/actions/Task_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

Tax_Get

OnInit
./lib/actions/Tax_Get.js
OnStartup
-
OnClose
-

Attributes

-

Timesheet_Get

OnInit
./lib/actions/Timesheet_Get.js
OnStartup
-
OnClose
-

Attributes

-

Timesheet_Post

OnInit
./lib/actions/Timesheet_Post.js
OnStartup
-
OnClose
-

Attributes

-

Timesheet_Put

The FieldsToUpdate field expects a string array collection of the field names you would like updated.

OnInit
./lib/actions/Timesheet_Put.js
OnStartup
-
OnClose
-

Attributes

-

Timesheet_Delete

OnInit
./lib/actions/Timesheet_Delete.js
OnStartup
-
OnClose
-

Attributes

-

Timesheet_GetByID

OnInit
./lib/actions/Timesheet_GetByID.js
OnStartup
-
OnClose
-

Attributes

-

TimesheetTimer_GetRunningTimer

OnInit
./lib/actions/TimesheetTimer_GetRunningTimer.js
OnStartup
-
OnClose
-

Attributes

-

TimesheetTimer_StopTimer

OnInit
./lib/actions/TimesheetTimer_StopTimer.js
OnStartup
-
OnClose
-

Attributes

-

TimesheetTimer_StartTimer

OnInit
./lib/actions/TimesheetTimer_StartTimer.js
OnStartup
-
OnClose
-

Attributes

-

UserProfile_Get

Admin and Invoice Managers can see all. Other users are limited to seeing their own profile.

OnInit
./lib/actions/UserProfile_Get.js
OnStartup
-
OnClose
-

Attributes

-

Webhook_DeleteByUrl

OnInit
./lib/actions/Webhook_DeleteByUrl.js
OnStartup
-
OnClose
-

Attributes

-

Webhook_Get

OnInit
./lib/actions/Webhook_Get.js
OnStartup
-
OnClose
-

Attributes

-

Webhook_Post

When you receive a webhook, you should respond with Http 200 OK Status Code, otherwise we will retry. Event values are: "company_created", "company_deleted", "company_updated", "contact_created", "contact_deleted", "contact_updated", "invoice_created", "invoice_sent", "project_created", "project_deleted", "project_updated", "task_created", "timesheet_created", "timesheet_deleted", "timesheet_updated". You can subscribe to any webhook, but you will only receive notifications for data appropriate to the roles of your user account. There is an optional Secret parameter (string 255 char max). This allows for webhook authentication. If provided, the Secret will be BASE 64 encoded and passed with notications as a basic authentication http header. i.e. Authorization Basic [BASE64 of Secret]"

OnInit
./lib/actions/Webhook_Post.js
OnStartup
-
OnClose
-

Attributes

-

Webhook_Delete

OnInit
./lib/actions/Webhook_Delete.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-