Service Level Agreements - Effort Class Charge IDs API

This API works only for service level agreements where you have the Financial Manager role in that account.

List all effort class charge IDs of a service level agreement

List all effort class charge IDs of a service level agreement with a specific ID.

GET /slas/:id/effort_class_chargeIDs

Response

Status: 200 OK

[
  {
    "id": 97,
    "nodeID": "...",
    "chargeID": "charge-identifier",
    "effort_class": {
      "id": 10,
      "name": "Billable Project Management - Business Hours",
      "account": {
        "id": "widget",
        "name": "Widget International"
      },
      "nodeID": "..."
    }
  }
]

Add an effort class charge ID to a service level agreement

Add an effort class charge ID to a service offering with a specific ID.

POST /slas/:id/effort_class_chargeIDs

When creating a new effort class charge ID for a service level agreement these fields are available.

Response

Status: 200 OK

{
  "chargeID": "billing-123",
  "effort_class": {
    "id": 10,
    "name": "Billable Project Management - Business Hours",
    "account": {
      "id": "widget",
      "name": "Widget International"
    },
    "nodeID": "..."
  },
  "id": 100,
  "nodeID": "..."
}

Update an effort class charge ID of a service level agreement

Update an effort class charge ID with a specific ID of a service level agreement with a specific ID.

PATCH /slas/:id/effort_class_chargeIDs/:effort_class_chargeID_id

When updating an existing effort class charge ID for a service level agreement these fields are available.

Response

Status: 200 OK

{
  "chargeID": "billing-123",
  "effort_class": {
    "id": 10,
    "name": "Billable Project Management - Business Hours",
    "account": {
      "id": "widget",
      "name": "Widget International"
    },
    "nodeID": "..."
  },
  "id": 100,
  "nodeID": "..."
}

Remove an effort class charge ID from a service level agreement

Remove an effort class charge ID with a specific ID from a service level agreement with a specific ID.

DELETE /slas/:id/effort_class_chargeIDs/:effort_class_chargeID_id

Response

Status: 204 No Content

Fields

id: Readonly integer — The unique ID of the effort class charge ID.
chargeID: Required string — The Charge ID is the unique identifier by which an effort class that is linked to a time entry when an activity was performed through the coverage of the SLA is known in the billing system of the service provider.
effort_class: Required reference to Effort class — The ID of the effort class related to the effort class charge ID.