API Documentation

API Endpoint

Overheads

Overheads

GET /api/v2/overheads
Requestsreturns overheads

GET  /api/v2/overheads

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "1",
      "type": "overheads",
      "attributes": {
        "started_on": "2021-08-21",
        "ended_on": null,
        "total_hours": 0,
        "client_hours": 0,
        "internal_hours": 0,
        "time_off_hours": 0,
        "overhead_hours": 0,
        "client_overhead_hours": 0,
        "internal_overhead_hours": 0,
        "time_off_overhead_hours": 0,
        "updated_at": "2021-09-21T01:05:31.778+02:00",
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "facility_costs": 0,
        "facility_costs_default": 0,
        "facility_costs_normalized": 0,
        "internal_costs": 0,
        "internal_costs_default": 0,
        "internal_costs_normalized": 0,
        "facility_cost_per_hour": 1500,
        "facility_cost_per_hour_default": 1500,
        "facility_cost_per_hour_normalized": 1500,
        "internal_cost_per_hour": 800,
        "internal_cost_per_hour_default": 800,
        "internal_cost_per_hour_normalized": 800
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 483
          }
        },
        "updater": {
          "data": {
            "type": "people",
            "id": "1264"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "1264",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1249@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:31.000+02:00",
        "last_seen_at": "2021-09-21T01:05:31.791+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1273,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:31.741+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 483
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1757"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1757",
      "type": "companies",
      "attributes": {
        "name": "Organization483",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:31.740+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 483
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/overheads?page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/overheads?page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Get overheads
GET/api/v2/overheads


GET /api/v2/overheads/1
Requestsreturns overhead

GET  /api/v2/overheads/2

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "2",
    "type": "overheads",
    "attributes": {
      "started_on": "2021-08-21",
      "ended_on": null,
      "total_hours": 0,
      "client_hours": 0,
      "internal_hours": 0,
      "time_off_hours": 0,
      "overhead_hours": 0,
      "client_overhead_hours": 0,
      "internal_overhead_hours": 0,
      "time_off_overhead_hours": 0,
      "updated_at": "2021-09-21T01:05:31.870+02:00",
      "currency": "USD",
      "currency_default": "USD",
      "currency_normalized": "USD",
      "facility_costs": 0,
      "facility_costs_default": 0,
      "facility_costs_normalized": 0,
      "internal_costs": 0,
      "internal_costs_default": 0,
      "internal_costs_normalized": 0,
      "facility_cost_per_hour": 1500,
      "facility_cost_per_hour_default": 1500,
      "facility_cost_per_hour_normalized": 1500,
      "internal_cost_per_hour": 800,
      "internal_cost_per_hour_default": 800,
      "internal_cost_per_hour_normalized": 800
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 484
        }
      },
      "updater": {
        "data": {
          "type": "people",
          "id": "1265"
        }
      }
    }
  },
  "included": [
    {
      "id": "1265",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1250@email.com",
        "title": null,
        "joined_at": "2021-09-21T01:05:31.000+02:00",
        "last_seen_at": "2021-09-21T01:05:31.882+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "setting_role_id": null,
        "invited_at": null,
        "is_user": true,
        "user_id": 1274,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2021-09-21T01:05:31.846+02:00",
        "placeholder": false,
        "color_id": null,
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 484
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1758"
          }
        },
        "subsidiary": {
          "data": null
        },
        "holiday_calendar": {
          "data": null
        }
      }
    },
    {
      "id": "1758",
      "type": "companies",
      "attributes": {
        "name": "Organization484",
        "billing_name": null,
        "vat": null,
        "default_currency": "USD",
        "created_at": "2021-09-21T01:05:31.845+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": [],
        "contact": {},
        "sample_data": false
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 484
          }
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 100
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30
      },
      "public_project_reports": {
        "type": "metered",
        "limit": 30
      },
      "private_project_reports": {
        "type": "metered",
        "limit": 10
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5
      },
      "recycle_bin": {
        "type": "restricted",
        "available": true,
        "limit": 180
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      },
      "duplicate_tasks": {
        "type": "switch",
        "available": true
      },
      "billable_time_rounding": {
        "type": "switch",
        "available": true
      },
      "payment_sync": {
        "type": "switch",
        "available": true
      },
      "booking_methods": {
        "type": "switch",
        "available": true
      },
      "import_tasks_csv": {
        "type": "switch",
        "available": true
      },
      "reactions": {
        "type": "switch",
        "available": true
      },
      "time_week_view": {
        "type": "switch",
        "available": true
      },
      "subtasks": {
        "type": "switch",
        "available": true
      },
      "time_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "theming": {
        "type": "switch",
        "available": true
      },
      "remove_branding": {
        "type": "switch",
        "available": true
      },
      "custom_invoicing_email": {
        "type": "switch",
        "available": true
      },
      "google_calendar_layout": {
        "type": "switch",
        "available": true
      },
      "pulse": {
        "type": "switch",
        "available": true
      },
      "slack": {
        "type": "switch",
        "available": true
      },
      "task_custom_fields_library": {
        "type": "switch",
        "available": true
      },
      "timeline_layout": {
        "type": "switch",
        "available": true
      },
      "comment_visibility": {
        "type": "switch",
        "available": true
      }
    },
    "settings": {}
  }
}

Gets an overhead
GET/api/v2/overheads/{id}

URI Parameters
HideShow
id
number (required) Example: 1

overhead id


PATCH /api/v2/overheads/1
Requestsreturns error

PATCH  /api/v2/overheads/4

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "overheads",
    "attributes": {
      "facility_costs": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/facility_costs"
      }
    }
  ]
}

Update a overhead
PATCH/api/v2/overheads/{id}

URI Parameters
HideShow
id
number (required) Example: 1

overhead id


Generated by aglio on 20 Sep 2021