Accelo

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 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 accelo id string optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase response object output field response id string unique identifier name string name of the resource meta object output field meta message string response message status string status value more info string output field more info 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" {}, "meta" {} } } ] 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 output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta message string response message more info string output field more info status string status value response object output field response id string unique identifier name string name of the resource 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" {}, "response" {} } } ] 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 required name of the resource surname string required 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 output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta message string response message status string status value more info string output field more info response object output field response mobile string output field mobile surname string name of the resource firstname string name of the resource email string output field email id string unique identifier 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" {}, "response" {} } } ] deactivate account deactivate an accelo account endpoint url api/v0/companies/{{accelo id}}/progressions/8/auto method put input argument name type required description accelo id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase response object output field response name string name of the resource id string unique identifier meta object output field meta message string response message status string status value more info string output field more info 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" {}, "meta" {} } } ] get accounts get all acounts from accelo (limit 100 accounts) endpoint url api/v0/companies method get input argument name type required description limit string optional parameter for get accounts fields string optional parameter for get accounts offset string optional parameter for get accounts filters string optional parameter for get accounts output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta message string response message status string status value more info string output field more info warnings array output field warnings response array output field response standing string output field standing date created string output field date created custom id string unique identifier phone object output field phone name string name of the resource website string output field website status string status value company status string status value comments object output field comments postal address string output field postal address default affiliation string output field default affiliation id string unique identifier date last interacted string output field date last interacted staff bookmarked string output field staff bookmarked fax object output field fax date modified string output field date modified 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" {}, "response" \[] } } ] 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 contract id string required unique identifier limit number optional parameter for get contract periods fields string optional parameter for get contract periods output parameter type description status code number http status code of the response reason string response reason phrase response object output field response periods array output field periods allowance type string type of the resource on budget number output field on budget budget type string type of the resource contract budget string output field contract budget allowance object output field allowance charged string output field charged billable string output field billable time allocations array output field time allocations nonbillable string output field nonbillable period id string unique identifier charged string output field charged against type string type of the resource against id string unique identifier against title string output field against title billable string output field billable overflow number output field overflow duration type string type of the resource unapproved budget used string output field unapproved budget used standing string output field standing total string output field total contract id string unique identifier 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" {}, "meta" {} } } ] get contracts get contracts from accelo endpoint url api/v0/contracts method get input argument name type required description limit string optional parameter for get contracts fields string optional parameter for get contracts filters string optional parameter for get contracts output parameter type description status code number http status code of the response reason string response reason phrase response array output field response staff bookmarked string output field staff bookmarked auto renew string output field auto renew billable string output field billable affiliation string output field affiliation manager string output field manager job object output field job standing string output field standing contract status string status value send invoice string output field send invoice type string type of the resource value string value for the parameter date started string output field date started against type string type of the resource id string unique identifier owner affiliation string output field owner affiliation against id string unique identifier date last interacted object output field date last interacted title string output field title against string output field against renew days string output field renew days date created string output field date created date period expires string output field date period expires 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" {} } } ] get profile fields get all profile fields in accelo endpoint url api/v0/companies/profiles/fields method get input argument name type required description limit number optional parameter for get profile fields fields string optional parameter for get profile fields output parameter type description status code number http status code of the response reason string response reason phrase response array output field response restrictions string output field restrictions lookup type object type of the resource field type string type of the resource exported string output field exported required string output field required description object output field description confidential string unique identifier id string unique identifier parent id string unique identifier field name string name of the resource link type string type of the resource options array output field options meta object output field meta message string response message status string status value more info string output field more info 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" \[], "meta" {} } } ] 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 accelo id string required unique identifier limit number optional parameter for get profile values fields string optional parameter for get profile values output parameter type description status code number http status code of the response reason string response reason phrase response array output field response link id string unique identifier field id string unique identifier id string unique identifier value type object type of the resource field type string type of the resource value string value for the parameter modified by string output field modified by date modified string output field date modified link type string type of the resource field name string name of the resource values array value for the parameter meta object output field meta message string response message status string status value more info string output field more info 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" \[], "meta" {} } } ] update account update an account in accelo endpoint url api/v0/companies/{{accelo id}} method put input argument name type required description accelo id string required unique identifier 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 output parameter type description status code number http status code of the response reason string response reason phrase response object output field response id string unique identifier name string name of the resource meta object output field meta more info string output field more info status string status value message string response message 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" {}, "meta" {} } } ] 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 accelo id string required unique identifier value id string required unique identifier value string optional value for the parameter output parameter type description status code number http status code of the response reason string response reason phrase meta object output field meta message string response message status string status value more info string output field more info response object output field response id string unique identifier value type object type of the resource value string value for the parameter field type string type of the resource values array value for the parameter field name string name of the resource 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" {}, "response" {} } } ] 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 1155 content type the media type of the resource application/json; charset=utf 8 date the date and time at which the message was originated sun, 23 jul 2023 03 01 31 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 4241 x ratelimit reset the time at which the current rate limit window resets 1690081206 x status reason http response header x status reason everything executed as expected notes accelo api documentation https //api accelo com/docs https //api accelo com/docs