Accelo
52 min
accelo is an end to end cloud based platform that manages all aspects of client work delivery the accelo connector help companies connect their client projects with turbine, enabling them with automation in different aspects of project management including contracts, implementations, and custom profile values additionally, using the accelo connector, you can create accounts and contacts, activate and deactivate accounts, retrieve and update contracts, profile values, and more within the accelo platform prerequisites a valid accelo account with admin privileges is required capabilities accelo connector provides the following capabilities retrive ,create and update accounts retrive and filter contracts activate and deactivate the accounts retrive and update custom profile values create contacts with company link asset setup before doing anything, you will need to register your application with accelo this is done from your deployment under "configuration" → "api" → "register application" accelo currently offers three types of applications installed application web application service application note an application can only be registered with one type if your application requires multiple types you will need to register multiple applications once registered, your application will be given a client id and client secret, which are required to authenticate authentication will require client id client secret deployment/base url token url notes accelo api documentation https //api accelo com/docs configurations auth client credentials authenticates using client credentials configuration parameters parameter description type required url a url to the target host string required token url string required client id the client id string required client secret the client secret string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions activate account set account status to active endpoint url api/v0/companies/{{accelo id}}/progressions/6/auto method put input argument name type required description path parameters accelo id string optional parameters for the activate account action input example {"path parameters" {"accelo id" "3653"}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response id string unique identifier response name string name of the resource meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info output example {"status code" 200,"response headers" {"date" "fri, 21 jul 2023 04 14 06 gmt","content type" "application/json; charset=utf 8","content length" "181","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4996","x ratelimit reset" "1689916124","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" {"id" "3653","name" "turbine playbook test"},"meta" {"message" "everything executed as exp create account create an account in accelo endpoint url api/v0/companies method post input argument name type required description name string optional name of the resource status id string optional unique identifier comments string optional parameter for create account custom id string optional unique identifier website string optional parameter for create account input example {"json body" {"name" "connector test 1","status id" "7","comments" "testoing connector","custom id" "111111","website" "turbineconnector com"}} output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta meta message string response message meta more info string output field meta more info meta status string status value response object output field response response id string unique identifier response name string name of the resource output example {"status code" 200,"response headers" {"date" "fri, 21 jul 2023 03 03 17 gmt","content type" "application/json; charset=utf 8","content length" "176","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4999","x ratelimit reset" "1689912196","x status reason" "everything executed as expected "},"reason" "ok","json body" {"meta" {"message" "everything executed as expected ","more info" "https //api accelo com/docs/#status create contact create a contact endpoint url /api/v0/contacts method post input argument name type required description company id string optional unique identifier firstname string optional name of the resource surname string optional name of the resource email string optional parameter for create contact comments string optional parameter for create contact phone number optional parameter for create contact username string optional name of the resource middlename string optional unique identifier title string optional parameter for create contact timezone string optional parameter for create contact position string optional parameter for create contact input example {"json body" {"company id" "3654","firstname" "dummy","surname" "mohammed","email" "dummy\@dummy dummy","comments" "something","phone" 1234567890,"username" "mab","middlename" "baseer","title" "mr","timezone" "mst","position" "intern"}} output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info response object output field response response mobile string output field response mobile response surname string name of the resource response firstname string name of the resource response email string output field response email response id string unique identifier output example {"status code" 200,"response headers" {"date" "mon, 24 jul 2023 20 57 27 gmt","content type" "application/json; charset=utf 8","content length" "232","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4998","x ratelimit reset" "1690235556","x status reason" "everything executed as expected "},"reason" "ok","json body" {"meta" {"message" "everything executed as expected ","status" "ok","more info" "https //api accelo co deactivate account deactivate an accelo account endpoint url api/v0/companies/{{accelo id}}/progressions/8/auto method put input argument name type required description path parameters accelo id string required parameters for the deactivate account action input example {"path parameters" {"accelo id" "3653"}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response name string name of the resource response id string unique identifier meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info output example {"status code" 200,"response headers" {"date" "fri, 21 jul 2023 04 13 16 gmt","content type" "application/json; charset=utf 8","content length" "181","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4997","x ratelimit reset" "1689916124","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" {"name" "turbine playbook test","id" "3653"},"meta" {"message" "everything executed as exp get accounts get all acounts from accelo (limit 100 accounts) endpoint url api/v0/companies method get input argument name type required description parameters limit string optional parameters for the get accounts action parameters fields string optional parameters for the get accounts action parameters offset string optional parameters for the get accounts action parameters filters string optional parameters for the get accounts action input example {"parameters" {" limit" "100"," fields" " all"," offset" ""," filters" "custom id(12345)"}} output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info meta warnings array output field meta warnings response array output field response response standing string output field response standing response date created string output field response date created response custom id string unique identifier response phone object output field response phone response name string name of the resource response website string output field response website response status string status value response company status string status value response comments object output field response comments response postal address string output field response postal address response default affiliation string output field response default affiliation response id string unique identifier response date last interacted string output field response date last interacted response staff bookmarked string output field response staff bookmarked response fax object output field response fax response date modified string output field response date modified output example {"status code" 200,"response headers" {"date" "wed, 26 jul 2023 12 25 46 gmt","content type" "application/json; charset=utf 8","content length" "639","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4998","x ratelimit reset" "1690377857","x status reason" "everything executed as expected "},"reason" "ok","json body" {"meta" {"message" "everything executed as expected ","status" "ok","more info" "https //api accelo co get contract periods get contract periods by contract id endpoint url api/v0/contracts/{{contract id}}/periods method get input argument name type required description path parameters contract id string required parameters for the get contract periods action parameters limit number optional parameters for the get contract periods action parameters fields string optional parameters for the get contract periods action input example {"parameters" {" limit" 100," fields" " all"},"path parameters" {"contract id" "113"}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response periods array output field response periods response periods allowance type string type of the resource response periods on budget number output field response periods on budget response periods budget type string type of the resource response periods contract budget string output field response periods contract budget response periods allowance object output field response periods allowance response periods allowance charged string output field response periods allowance charged response periods allowance billable string output field response periods allowance billable response periods time allocations array output field response periods time allocations response periods time allocations nonbillable string output field response periods time allocations nonbillable response periods time allocations period id string unique identifier response periods time allocations charged string output field response periods time allocations charged response periods time allocations against type string type of the resource response periods time allocations against id string unique identifier response periods time allocations against title string output field response periods time allocations against title response periods time allocations billable string output field response periods time allocations billable response periods overflow number output field response periods overflow response periods duration type string type of the resource response periods unapproved budget used string output field response periods unapproved budget used response periods standing string output field response periods standing response periods total string output field response periods total response periods contract id string unique identifier output example {"status code" 200,"response headers" {"date" "sun, 23 jul 2023 03 01 31 gmt","content type" "application/json; charset=utf 8","content length" "1155","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4999","x ratelimit reset" "1690084891","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" {"periods" \[]},"meta" {"message" "everything executed as expected ","status" "ok","more i get contracts get contracts from accelo endpoint url api/v0/contracts method get input argument name type required description parameters limit string optional parameters for the get contracts action parameters fields string optional parameters for the get contracts action parameters filters string optional parameters for the get contracts action input example {"parameters" {" limit" "100"," fields" " all"," filters" "against id(3029)"}} output parameter type description status code number http status code of the response reason string response reason phrase response array output field response response staff bookmarked string output field response staff bookmarked response auto renew string output field response auto renew response billable string output field response billable response affiliation string output field response affiliation response manager string output field response manager response job object output field response job response standing string output field response standing response contract status string status value response send invoice string output field response send invoice response type string type of the resource response value string value for the parameter response date started string output field response date started response against type string type of the resource response id string unique identifier response owner affiliation string output field response owner affiliation response against id string unique identifier response date last interacted object output field response date last interacted response title string output field response title response against string output field response against response renew days string output field response renew days response date created string output field response date created response date period expires string output field response date period expires output example {"status code" 200,"response headers" {"date" "sun, 23 jul 2023 02 53 06 gmt","content type" "application/json; charset=utf 8","content length" "1345","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4241","x ratelimit reset" "1690081206","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" \[{}],"meta" {"message" "everything executed as expected ","warnings" \[],"status" "ok","mo get profile fields get all profile fields in accelo endpoint url api/v0/companies/profiles/fields method get input argument name type required description parameters limit number optional parameters for the get profile fields action parameters fields string optional parameters for the get profile fields action input example {"parameters" {" limit" 100," fields" " all"}} output parameter type description status code number http status code of the response reason string response reason phrase response array output field response response restrictions string output field response restrictions response lookup type object type of the resource response field type string type of the resource response exported string output field response exported response required string output field response required response description object output field response description response confidential string unique identifier response id string unique identifier response parent id string unique identifier response field name string name of the resource response link type string type of the resource response options array output field response options meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info output example {"status code" 200,"response headers" {"date" "thu, 27 jul 2023 19 16 37 gmt","content type" "application/json; charset=utf 8","content length" "4364","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4999","x ratelimit reset" "1690488997","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" \[{"restrictions" "all","lookup type"\ null,"field type" "multi select","exported" "yes","r get profile values get profile values of an account endpoint url api/v0/companies/{{accelo id}}/profiles/values method get input argument name type required description path parameters accelo id string required parameters for the get profile values action parameters limit number optional parameters for the get profile values action parameters fields string optional parameters for the get profile values action input example {"parameters" {" limit" 100," fields" " all"},"path parameters" {"accelo id" "2638"}} output parameter type description status code number http status code of the response reason string response reason phrase response array output field response response link id string unique identifier response field id string unique identifier response id string unique identifier response value type object type of the resource response field type string type of the resource response value string value for the parameter response modified by string output field response modified by response date modified string output field response date modified response link type string type of the resource response field name string name of the resource response values array value for the parameter meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info output example {"status code" 200,"response headers" {"date" "fri, 21 jul 2023 15 06 38 gmt","content type" "application/json; charset=utf 8","content length" "1236","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4999","x ratelimit reset" "1689955598","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" \[{"link id" "2638","field id" "12","id" "20","value type"\ null,"field type" "select","val update account update an account in accelo endpoint url api/v0/companies/{{accelo id}} method put input argument name type required description path parameters accelo id string required parameters for the update account action name string optional name of the resource fax string optional parameter for update account phone number optional parameter for update account comments string optional parameter for update account website string optional parameter for update account input example {"json body" {"name" "connector test update","fax" "121212121","phone" 7854238596,"comments" "some comment","website" "updatewebsite com"},"path parameters" {"accelo id" "3654"}} output parameter type description status code number http status code of the response reason string response reason phrase response object output field response response id string unique identifier response name string name of the resource meta object output field meta meta more info string output field meta more info meta status string status value meta message string response message output example {"status code" 200,"response headers" {"date" "fri, 21 jul 2023 03 08 17 gmt","content type" "application/json; charset=utf 8","content length" "181","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4998","x ratelimit reset" "1689912196","x status reason" "everything executed as expected "},"reason" "ok","json body" {"response" {"id" "3654","name" "connector test update"},"meta" {"more info" "https //api accelo com/d update profile value update specific profile value of an accelo account endpoint url api/v0/companies/{{accelo id}}/profiles/values/{{value id}} method put input argument name type required description path parameters accelo id string required parameters for the update profile value action path parameters value id string required parameters for the update profile value action value string optional value for the parameter input example {"json body" {"value" "dev"},"path parameters" {"accelo id" "2638","value id" "864"}} output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta meta message string response message meta status string status value meta more info string output field meta more info response object output field response response id string unique identifier response value type object type of the resource response value string value for the parameter response field type string type of the resource response values array value for the parameter response field name string name of the resource output example {"status code" 200,"response headers" {"date" "fri, 21 jul 2023 15 19 17 gmt","content type" "application/json; charset=utf 8","content length" "261","connection" "keep alive","server" "nginx","access control allow origin" " ","x ratelimit limit" "5000","x ratelimit remaining" "4998","x ratelimit reset" "1689955598","x status reason" "everything executed as expected "},"reason" "ok","json body" {"meta" {"message" "everything executed as expected ","status" "ok","more info" "https //api accelo co response headers header description example access control allow origin http response header access control allow origin connection http response header connection keep alive content length the length of the response body in bytes 181 content type the media type of the resource application/json; charset=utf 8 date the date and time at which the message was originated wed, 26 jul 2023 12 25 46 gmt server information about the software used by the origin server nginx x ratelimit limit the number of requests allowed in the current rate limit window 5000 x ratelimit remaining the number of requests remaining in the current rate limit window 4999 x ratelimit reset the time at which the current rate limit window resets 1690235556 x status reason http response header x status reason everything executed as expected