GET TimeTrackingProject/Get/{id}

Gets the specified Time Tracking Project based on the identifier.

Request Information

URI Parameters

Name	Type	Additional information	Description
id	integer	Required	The identifier.

Body Parameters

None.

Response Information

Resource Description

Time Tracking Project

Name	Type	Additional information	Description
ID	integer	None.
Name	string	Required String length: inclusive between 0 and 100	The name of the project.
CustomerID	integer	Required	Customer ID allocated to the Project.
Customer	Customer	None.	Customer allocated to the Project.
BillingMethodID	Time Tracking Billing Method Type	Required	The billing method to be used for the project: 1. Single Project Rate. 2. Project Rate Per Hour. 3. Staff Rate Per Hour. 4. Task Rate Per Hour.
InvoicingMethodID	Time Tracking Invoicing Method Type	Required	The invoice method to be used for the project: 1. Task Detailed. 2. Group By Task. 3. Consolidated.
EstimatedHours	decimal	None.	Estimate Hours set for a Project
EstimatedValue	decimal	None.	Estimate Value of a Project
Description	string	None.
FixedRate	decimal	None.	Project Fixed Rate when billing method is set to Single Project Rate.
RatePerHour	decimal	None.	Project Rate Per Hour when billing method is set to Project Rate Per Hour.
PONumber	string	None.
StartDate	date	Required
EndDate	nullable date	None.
LastInvoiceDate	nullable date	None.
LastInvoiceDocumentHeaderId	integer	None.
AmountInvoiced	decimal	None.
ToBeInvoiced	decimal	None.
TotalHours	decimal	None.
UnbilledHours	decimal	None.
NonBillableHours	decimal	None.
BillableHours	decimal	None.
BillableAmount	decimal	None.
BudgetedHours	decimal	None.
ProjectTasks	Collection of Time Tracking Project Task	Required	Represents a lookup record between a Project and a Task. This is being used by Time Sheets to set Billing Rates and Budget Hours
ProjectStaff	Collection of Time Tracking Project Staff	None.
Tasks	Collection of Time Tracking Task	Read Only / System Generated	Tasks which is curently linked to a project.
Billable	bool	None.
Active	bool	None.
InvoicedHours	decimal	None.
WrittenOffTime	decimal	None.
BudgetBasedOn	integer	Required	Budget based on: 1. Project 2. Task

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "CustomerID": 3,
  "Customer": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2024-11-15",
      "Created": "2024-11-15"
    },
    "SalesRepresentativeId": 1,
    "SalesRepresentative": {
      "ID": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Name": "sample string 2 sample string 3",
      "Active": true,
      "Email": "sample string 6",
      "Mobile": "sample string 7",
      "Telephone": "sample string 8",
      "Created": "2024-11-15",
      "Modified": "2024-11-15"
    },
    "TaxReference": "sample string 2",
    "ContactName": "sample string 3",
    "Telephone": "sample string 4",
    "Fax": "sample string 5",
    "Mobile": "sample string 6",
    "Email": "sample string 7",
    "WebAddress": "sample string 8",
    "Active": true,
    "IsObfuscated": true,
    "Balance": 11.0,
    "CreditLimit": 12.0,
    "CommunicationMethod": 1,
    "PostalAddress01": "sample string 13",
    "PostalAddress02": "sample string 14",
    "PostalAddress03": "sample string 15",
    "PostalAddress04": "sample string 16",
    "PostalAddress05": "sample string 17",
    "DeliveryAddress01": "sample string 18",
    "DeliveryAddress02": "sample string 19",
    "DeliveryAddress03": "sample string 20",
    "DeliveryAddress04": "sample string 21",
    "DeliveryAddress05": "sample string 22",
    "AutoAllocateToOldestInvoice": true,
    "EnableCustomerZone": true,
    "CustomerZoneGuid": "1816f076-2689-494a-9bba-bf36e8273129",
    "CashSale": true,
    "TextField1": "sample string 25",
    "TextField2": "sample string 26",
    "TextField3": "sample string 27",
    "NumericField1": 1.0,
    "NumericField2": 1.0,
    "NumericField3": 1.0,
    "YesNoField1": true,
    "YesNoField2": true,
    "YesNoField3": true,
    "DateField1": "2024-11-15",
    "DateField2": "2024-11-15",
    "DateField3": "2024-11-15",
    "DefaultPriceListId": 1,
    "DefaultPriceList": {
      "ID": 1,
      "Description": "sample string 2",
      "IsDefault": true
    },
    "DefaultPriceListName": "sample string 2",
    "AcceptsElectronicInvoices": true,
    "Modified": "2024-11-15",
    "Created": "2024-11-15",
    "BusinessRegistrationNumber": "sample string 34",
    "TaxStatusVerified": "2024-11-15",
    "CurrencyId": 1,
    "CurrencySymbol": "sample string 35",
    "HasActivity": true,
    "DefaultDiscountPercentage": 1.0,
    "DefaultTaxTypeId": 1,
    "DefaultTaxType": {
      "ID": 1,
      "Name": "sample string 2",
      "Percentage": 3.1,
      "IsDefault": true,
      "HasActivity": true,
      "IsManualTax": true,
      "Active": true,
      "Created": "2024-11-15",
      "Modified": "2024-11-15",
      "TaxTypeDefaultUID": "c9bcfc4b-3725-4e74-99c4-258ff8cbe5f4",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "CityId": 1,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "OutstandingInvoices": true,
    "OverdueInvoices": true,
    "OnHold": true,
    "ExcludeFromDebtorsManager": true,
    "SubjectToDRCVat": true,
    "ID": 40
  },
  "BillingMethodID": 1,
  "InvoicingMethodID": 1,
  "TrackHours": true,
  "TrackValue": true,
  "EstimatedHours": 6.0,
  "EstimatedValue": 7.0,
  "Description": "sample string 8",
  "FixedRate": 9.0,
  "RatePerHour": 10.0,
  "PONumber": "sample string 11",
  "StartDate": "2024-11-15",
  "EndDate": "2024-11-15",
  "LastInvoiceDate": "2024-11-15",
  "LastInvoiceDocumentHeaderId": 1,
  "AmountInvoiced": 12.0,
  "ToBeInvoiced": 13.0,
  "TotalHours": 14.0,
  "UnbilledHours": 15.0,
  "NonBillableHours": 16.0,
  "BillableHours": 17.0,
  "BillableAmount": 18.0,
  "BudgetedHours": 19.0,
  "ProjectTasks": [
    {
      "ID": 1,
      "ProjectID": 2,
      "TaskID": 3,
      "BillToClient": true,
      "BillingRate": 5.0,
      "BudgetedHours": 6.0,
      "TotalHoursLogged": 7.0
    },
    {
      "ID": 1,
      "ProjectID": 2,
      "TaskID": 3,
      "BillToClient": true,
      "BillingRate": 5.0,
      "BudgetedHours": 6.0,
      "TotalHoursLogged": 7.0
    }
  ],
  "ProjectStaff": [
    {
      "ProjectID": 1,
      "TimeTrackingUserId": 2,
      "BillingRate": 3.0,
      "CostPerHour": 4.0,
      "UserType": 5
    },
    {
      "ProjectID": 1,
      "TimeTrackingUserId": 2,
      "BillingRate": 3.0,
      "CostPerHour": 4.0,
      "UserType": 5
    }
  ],
  "Tasks": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "BillingRate": 4.0,
      "BillToClient": true,
      "DefaultTask": true,
      "Active": true,
      "ProjectTasks": [
        {
          "ID": 1,
          "ProjectID": 2,
          "TaskID": 3,
          "BillToClient": true,
          "BillingRate": 5.0,
          "BudgetedHours": 6.0,
          "TotalHoursLogged": 7.0
        },
        {
          "ID": 1,
          "ProjectID": 2,
          "TaskID": 3,
          "BillToClient": true,
          "BillingRate": 5.0,
          "BudgetedHours": 6.0,
          "TotalHoursLogged": 7.0
        }
      ]
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "BillingRate": 4.0,
      "BillToClient": true,
      "DefaultTask": true,
      "Active": true,
      "ProjectTasks": [
        {
          "ID": 1,
          "ProjectID": 2,
          "TaskID": 3,
          "BillToClient": true,
          "BillingRate": 5.0,
          "BudgetedHours": 6.0,
          "TotalHoursLogged": 7.0
        },
        {
          "ID": 1,
          "ProjectID": 2,
          "TaskID": 3,
          "BillToClient": true,
          "BillingRate": 5.0,
          "BudgetedHours": 6.0,
          "TotalHoursLogged": 7.0
        }
      ]
    }
  ],
  "Billable": true,
  "Active": true,
  "InvoicedHours": 22.0,
  "WrittenOffTime": 23.0,
  "BudgetBasedOn": 24
}