GET TimeTrackingProject/GetActiveProjects

Gets a list of active Time Tracking Projects.

Request Information

This method supports OData queries.

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Time Tracking Project
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Time Tracking Project

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "CustomerID": 3,
      "Customer": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-20",
          "Created": "2021-10-20"
        },
        "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": "2021-10-20",
          "Modified": "2021-10-20"
        },
        "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": "4ec0a2e4-b3f8-47b6-9f35-9948fcec03ba",
        "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": "2021-10-20",
        "DateField2": "2021-10-20",
        "DateField3": "2021-10-20",
        "DefaultPriceListId": 1,
        "DefaultPriceList": {
          "ID": 1,
          "Description": "sample string 2",
          "IsDefault": true
        },
        "DefaultPriceListName": "sample string 2",
        "AcceptsElectronicInvoices": true,
        "Modified": "2021-10-20",
        "Created": "2021-10-20",
        "BusinessRegistrationNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-20",
        "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": "2021-10-20",
          "Modified": "2021-10-20",
          "TaxTypeDefaultUID": "f3cf2454-39a6-4933-9858-803e2c64a942",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "CityId": 1,
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "OutstandingInvoices": true,
        "OverdueInvoices": true,
        "OnHold": true,
        "ExcludeFromDebtorsManager": true,
        "ID": 39
      },
      "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": "2021-10-20",
      "EndDate": "2021-10-20",
      "LastInvoiceDate": "2021-10-20",
      "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
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "CustomerID": 3,
      "Customer": {
        "Name": "sample string 1",
        "Category": {
          "Description": "sample string 1",
          "ID": 2,
          "Modified": "2021-10-20",
          "Created": "2021-10-20"
        },
        "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": "2021-10-20",
          "Modified": "2021-10-20"
        },
        "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": "4ec0a2e4-b3f8-47b6-9f35-9948fcec03ba",
        "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": "2021-10-20",
        "DateField2": "2021-10-20",
        "DateField3": "2021-10-20",
        "DefaultPriceListId": 1,
        "DefaultPriceList": {
          "ID": 1,
          "Description": "sample string 2",
          "IsDefault": true
        },
        "DefaultPriceListName": "sample string 2",
        "AcceptsElectronicInvoices": true,
        "Modified": "2021-10-20",
        "Created": "2021-10-20",
        "BusinessRegistrationNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-20",
        "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": "2021-10-20",
          "Modified": "2021-10-20",
          "TaxTypeDefaultUID": "f3cf2454-39a6-4933-9858-803e2c64a942",
          "CompanyId": 9
        },
        "DueDateMethodId": 1,
        "DueDateMethodValue": 1,
        "CityId": 1,
        "HasSpecialCountryTax": true,
        "AccountingAgreement": true,
        "HasSpecialCountryTaxActivity": true,
        "OutstandingInvoices": true,
        "OverdueInvoices": true,
        "OnHold": true,
        "ExcludeFromDebtorsManager": true,
        "ID": 39
      },
      "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": "2021-10-20",
      "EndDate": "2021-10-20",
      "LastInvoiceDate": "2021-10-20",
      "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
    }
  ]
}