Business activities API

List business activities

GET /client_service
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • name
  • id

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 318
Content-Type: application/json
[
  {
    "id": 1,
    "name": "Verschiedenes",
    "default_is_billable": null,
    "default_price_per_hour": null,
    "account_id": null
  },
  {
    "id": 2,
    "name": "Meeting",
    "default_is_billable": null,
    "default_price_per_hour": null,
    "account_id": null
  },
  {
    "id": 3,
    "name": "programming",
    "default_is_billable": false,
    "default_price_per_hour": "20.50",
    "account_id": null
  }
]

Search business activities

POST /client_service/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "name",
    "value": "Verschiedenes"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • name
Name Required Type Description
name optional string

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 108
Content-Type: application/json
[
  {
    "id": 1,
    "name": "Verschiedenes",
    "default_is_billable": null,
    "default_price_per_hour": null,
    "account_id": null
  }
]

Show business activity

GET /client_service/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 108
Content-Type: application/json
{
  "id": 3,
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": "20.50",
  "account_id": null
}

Create business activity

POST /client_service
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": 20.5,
  "account_id": null
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
name required string (80)
account_id optional Resource account Only income account allowed.
default_is_billable optional boolean
default_price_per_hour optional decimal

The following scopes are needed:

  • general
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 107
Content-Type: application/json
{
  "id": 3,
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": "20.5",
  "account_id": null
}

Overwrite business activity

PUT /client_service/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": 20.5,
  "account_id": null
}
Name Required Type Description
callback optional string
Name Required Type Description
name required string (80)
account_id optional Resource account Only income account allowed.
default_is_billable optional boolean
default_price_per_hour optional decimal

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 107
Content-Type: application/json
{
  "id": 3,
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": "20.5",
  "account_id": null
}

Edit business activity

POST /client_service/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": 20.5,
  "account_id": null
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
account_id optional Resource account Only income account allowed.
default_is_billable optional boolean
default_price_per_hour optional decimal
name optional string (80)

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 107
Content-Type: application/json
{
  "id": 3,
  "name": "programming",
  "default_is_billable": false,
  "default_price_per_hour": "20.5",
  "account_id": null
}

Delete business activity

Please note that the business activity in use can not be deleted.

DELETE /client_service/3
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • general
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}