Back to Task

POST Method Details for ValidateNewTask.

Validate if a new task can be created

Definition

https://app[x].timelog.com/[account name]/api/v{version}/task/validate-new-task

Parameters

  • taskModel object
    • AdditionalTextIsRequired boolean Gets or sets a value indicating whether additional text is required
    • BudgetAmount number Gets or sets the budget amount
    • BudgetHours number Gets or sets the budget hours
    • Description string Gets or sets the description
    • EndDate string Gets or sets the end date
    • HourlyRateID integer Gets or sets the hourly rate ID
    • IsBillable boolean Gets or sets a value indicating whether the task is billable
    • IsReadyForInvoicing boolean Gets or sets a value indicating whether the task is ready for invoicing
    • ParentTaskID integer Gets or sets the parent task ID
    • PaymentAmount number Gets or sets the payment amount
    • PaymentInvoiceDate string Gets or sets the payment invoice date for a TDR task
    • PaymentName string Gets or sets the payment name for a TDR task
    • PaymentProductNo string Gets or sets the payment product no. for a TDR task
    • PaymentRecognitionModel integer Gets or sets the PaymentRecognitionModel
    • ProjectID integer Gets or sets the project ID
    • ProjectSubContractID integer Gets or sets the project sub contract ID. When creating a main task, if project sub contract ID is not supplied, the main contract ID of its project will be used. When creating a sub task, if project sub contract ID is not supplied, the contract ID of its parent task will be used.
    • StartDate string Gets or sets the start date
    • TaskHourlyRate number Gets or sets the hourly rate of a TDR task
    • TaskName string Gets or sets the task name
    • TaskNo string Gets or sets the task number
    • TaskTypeID integer Gets or sets the task type ID 
    {
  "AdditionalTextIsRequired": false,
  "BudgetAmount": 0.0,
  "BudgetHours": 0.0,
  "Description": "",
  "EndDate": "2024-04-20T00:00:00+00:00",
  "HourlyRateID": 0,
  "IsBillable": false,
  "IsReadyForInvoicing": false,
  "ParentTaskID": 0,
  "PaymentAmount": 0.0,
  "PaymentInvoiceDate": "2024-04-20T00:00:00+00:00",
  "PaymentName": "",
  "PaymentProductNo": "",
  "PaymentRecognitionModel": 0,
  "ProjectID": 0,
  "ProjectSubContractID": 0,
  "StartDate": "2024-04-20T00:00:00+00:00",
  "TaskHourlyRate": 0.0,
  "TaskName": "",
  "TaskNo": "",
  "TaskTypeID": 0
}
  • version string The requested API version

Returns

  • [200] Validate if new task can be created successfully
  • [401] Invalid authentication token
  • [500] Task validation failed
    • Code integer Gets the code.
    • Details array Gets the details.
    • Message string Gets the message.
    • Parameters string Gets the parameters.
    • Url string Gets the URL. 
    {
  "Code": 0,
  "Details": "",
  "Message": "",
  "Parameters": "",
  "Url": ""
}