TimeRecord
URL
https://api.primaerp.com/v1/time/timerecords
https://api.primaerp.com/v1/time/timerecords/$calculateprice
https://api.primaerp.com/v1/time/timerecords/$unbilled
https://api.primaerp.com/v1/time/timerecords/$unbilledsummary
https://api.primaerp.com/v1/time/timerecords/{id}/$updateprice
https://api.primaerp.com/v1/time/projects/{id}/timerecords
https://api.primaerp.com/v1/time/projects/{id}/timerecords/$calculateprice
https://api.primaerp.com/v1/time/projects/{id}/timerecords/$unbilled
https://api.primaerp.com/v1/time/projects/{id}/timerecords/$unbilledsummary
https://api.primaerp.com/v1/time/projects/{id}/timerecords/{id}/$updateprice
https://api.primaerp.com/v1/time/tasks/{id}/timerecords
https://api.primaerp.com/v1/time/tasks/{id}/timerecords/$calculateprice
https://api.primaerp.com/v1/time/tasks/{id}/timerecords/$unbilled
https://api.primaerp.com/v1/time/tasks/{id}/timerecords/$unbilledsummary
https://api.primaerp.com/v1/time/tasks/{id}/timerecords/{id}/$updateprice
https://api.primaerp.com/v1/time/users/{id}/timerecords
https://api.primaerp.com/v1/time/users/{id}/timerecords/$calculateprice
https://api.primaerp.com/v1/time/users/{id}/timerecords/$unbilled
https://api.primaerp.com/v1/time/users/{id}/timerecords/$unbilledsummary
https://api.primaerp.com/v1/time/users/{id}/timerecords/{id}/$updateprice
https://api.primaerp.com/v1/time/tags/{id}/timerecords
https://api.primaerp.com/v1/time/tags/{id}/timerecords/$calculateprice
https://api.primaerp.com/v1/time/tags/{id}/timerecords/$unbilled
https://api.primaerp.com/v1/time/tags/{id}/timerecords/$unbilledsummary
https://api.primaerp.com/v1/time/tags/{id}/timerecords/{id}/$updateprice
https://api.primaerp.com/v1/time/worktypes/{id}/timerecords
https://api.primaerp.com/v1/time/worktypes/{id}/timerecords/$calculateprice
https://api.primaerp.com/v1/time/worktypes/{id}/timerecords/$unbilled
https://api.primaerp.com/v1/time/worktypes/{id}/timerecords/$unbilledsummary
https://api.primaerp.com/v1/time/worktypes/{id}/timerecords/{id}/$updateprice
Properties
| Name |
Type |
Access |
Required |
Description |
| approved |
Boolean |
read write |
no |
Determines whether the record was approved. |
| billable |
Boolean |
read write |
no |
Determines whether the time record can be billed. A price will be stored only if the value is 'true'. |
| billed |
Boolean |
read only |
no |
Determines whether the record was billed. |
| client |
Client |
read write |
no |
A client belongs to this object. |
| createdAt |
Date |
read only |
no |
Date of creation. |
| description |
String |
read write |
no |
Some description of the record. |
| displayName |
String |
read only |
no |
Describes an object in human readable form. |
| duration |
Long |
read write |
no |
Recording length (in milliseconds). |
| effective |
Boolean |
read write |
YES |
Determines whether the record is effective. Default value is true. |
| externalBrowsableUrl |
String |
read write |
no |
Human accessible link in external system. |
| externalResourceId |
String |
read write |
no |
Unique external system identifier. |
| externalSynced |
Boolean |
write only |
no |
Determines whether an object was synced with the external system. |
| externalSyncedAt |
Date |
read only |
no |
Date of the last sync with the external system. It is set when the 'externalSynced' flag is true. |
| externalSystem |
ExternalSystem |
read write |
no |
External system which maintains this object. |
| id |
String |
read write |
no |
Unique object identifier. |
| price |
Double |
read write |
no |
The price of the time record is calculated by the formula: 'unitPrice * duration'. |
| priceAutoCalculation |
Boolean |
read write |
no |
deprecated |
| priceModified |
Boolean |
read write |
no |
If the value is 'true', the price won't be calculated by the price list. |
| project |
Project |
read write |
no |
Task belongs to this project. |
| recordType |
TimeRecordType |
read only |
no |
A record type. |
| start |
Date |
read write |
no |
Date when recording starts. |
| stop |
Date |
read write |
no |
Date when recording stops. |
| task |
Task |
read write |
no |
A task belonging to this project. |
| trashItem |
TrashItem |
read write |
no |
Informs whether an object is in the trash. An object is in the trash if a trash item was specified. |
| unitPrice |
Double |
read write |
no |
The unit price is the price per hour. |
| updatedAt |
Date |
read only |
no |
Last modified date. |
| user |
User |
read write |
YES |
The user for whom the time on the task is recorded. |
| version |
Long |
read write |
no |
Object version number. |
| workType |
WorkType |
read write |
no |
User which time on task is recorded. |
{
"type" : "TimeRecord",
"path" : "/v1/time/timerecords",
"fields" : [
{
"type" : "Boolean",
"name" : "approved",
"description" : "Determines whether the record was approved.",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "billable",
"description" : "Determines whether the time record can be billed. A price will be stored only if the value is 'true'.",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "billed",
"description" : "Determines whether the record was billed.",
"access" : "READ_ONLY"
},
{
"type" : "Client",
"path" : "/v1/time/clients",
"name" : "client",
"description" : "A client belongs to this object.",
"access" : "READ_WRITE"
},
{
"type" : "Date",
"name" : "createdAt",
"description" : "Date of creation.",
"access" : "READ_ONLY"
},
{
"type" : "String",
"name" : "description",
"description" : "Some description of the record.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "displayName",
"description" : "Describes an object in human readable form.",
"access" : "READ_ONLY"
},
{
"type" : "Long",
"name" : "duration",
"description" : "Recording length (in milliseconds).",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "Min",
"details" : "value 0"
}
]
},
{
"type" : "Boolean",
"name" : "effective",
"description" : "Determines whether the record is effective.",
"defaultValue" : "true",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "NotNull"
}
]
},
{
"type" : "String",
"name" : "externalBrowsableUrl",
"description" : "Human accessible link in external system.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "externalResourceId",
"description" : "Unique external system identifier.",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "externalSynced",
"description" : "Determines whether an object was synced with the external system.",
"access" : "WRITE_ONLY"
},
{
"type" : "Date",
"name" : "externalSyncedAt",
"description" : "Date of the last sync with the external system. It is set when the 'externalSynced' flag is true.",
"access" : "READ_ONLY"
},
{
"type" : "ExternalSystem",
"path" : "/v1/externalsystems",
"name" : "externalSystem",
"description" : "External system which maintains this object.",
"access" : "READ_WRITE"
},
{
"type" : "String",
"name" : "id",
"description" : "Unique object identifier.",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "Pattern",
"details" : "regexp [0-9a-f]{8}(?:-[0-9a-f]{4}){3}-[0-9a-f]{12}"
},
{
"type" : "NotNull"
}
]
},
{
"type" : "Double",
"name" : "price",
"description" : "The price of the time record is calculated by the formula: 'unitPrice * duration'. ",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "priceAutoCalculation",
"description" : "deprecated",
"access" : "READ_WRITE"
},
{
"type" : "Boolean",
"name" : "priceModified",
"description" : "If the value is 'true', the price won't be calculated by the price list.",
"access" : "READ_WRITE"
},
{
"type" : "Project",
"path" : "/v1/time/projects",
"name" : "project",
"description" : "Task belongs to this project.",
"access" : "READ_WRITE"
},
{
"type" : "TimeRecordType",
"name" : "recordType",
"description" : "A record type.",
"access" : "READ_ONLY",
"constraints" : [
{
"type" : "Enum",
"details" : "ATTENDANCE"
}
]
},
{
"type" : "Date",
"name" : "start",
"description" : "Date when recording starts.",
"access" : "READ_WRITE"
},
{
"type" : "Date",
"name" : "stop",
"description" : "Date when recording stops.",
"access" : "READ_WRITE"
},
{
"type" : "Task",
"path" : "/v1/time/tasks",
"name" : "task",
"description" : "A task belonging to this project.",
"access" : "READ_WRITE"
},
{
"type" : "TrashItem",
"path" : "/v1/trash",
"name" : "trashItem",
"description" : "Informs whether an object is in the trash. An object is in the trash if a trash item was specified.",
"access" : "READ_WRITE"
},
{
"type" : "Double",
"name" : "unitPrice",
"description" : "The unit price is the price per hour.",
"access" : "READ_WRITE"
},
{
"type" : "Date",
"name" : "updatedAt",
"description" : "Last modified date.",
"access" : "READ_ONLY"
},
{
"type" : "User",
"path" : "/v1/users",
"name" : "user",
"description" : "The user for whom the time on the task is recorded.",
"access" : "READ_WRITE",
"constraints" : [
{
"type" : "NotNull"
}
]
},
{
"type" : "Long",
"name" : "version",
"description" : "Object version number.",
"access" : "READ_WRITE"
},
{
"type" : "WorkType",
"path" : "/v1/time/worktypes",
"name" : "workType",
"description" : "User which time on task is recorded.",
"access" : "READ_WRITE"
}
],
"cascades" : [
{
"cascadeType" : "REMOVE",
"objectTypes" : [
"TrashItem"
]
}
]
}
Dummy data
{
"id" : "0a9c3af3-4bf7-4435-b4e7-cb66da031996",
"createdAt" : "/Date(1489386674660)/",
"updatedAt" : "/Date(1489409594660)/",
"version" : 3,
"externalSystem" : {
"id" : "fd5c03c7-ef81-4b45-b88b-521bcd0d154c",
"createdAt" : "/Date(1489384574660)/",
"updatedAt" : "/Date(1489416794660)/",
"version" : 4,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "time-55567",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221/tasks/334/time/55567",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"user" : {
"id" : "36e159ad-fc4f-46bf-8085-1e1cf1f5a40f",
"createdAt" : "/Date(1489385294660)/",
"updatedAt" : "/Date(1489391594660)/",
"version" : 4,
"firstName" : "John",
"lastName" : "Smith",
"nickName" : "Smith, J.",
"email" : "john.smith@example.com",
"phone" : "55 123 444 567",
"position" : "Chief developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "dd/MM/yyyy",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "en_US",
"password" : "",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1490223600000)/",
"workingTimeStart" : "/Date(1489388400000)/",
"workingTimeEnd" : "/Date(1489420800000)/",
"created" : "/Date(1489301594659)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Smith John"
},
"project" : {
"id" : "3ee814df-75c2-4024-8e79-2390c5d0dfdf",
"createdAt" : "/Date(1489385594660)/",
"updatedAt" : "/Date(1489456394660)/",
"version" : 4,
"externalSystem" : {
"id" : "e8accba6-acd6-41b2-b794-c76060278ff3",
"createdAt" : "/Date(1489386554660)/",
"updatedAt" : "/Date(1489438394660)/",
"version" : 7,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "project-221",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"name" : "Content management system",
"code" : "CMS",
"note" : "core feature",
"begins" : "/Date(1489301594659)/",
"ends" : "/Date(1489474394659)/",
"timeBudget" : 604800000,
"priceBudget" : 100000.0,
"personal" : true,
"owner" : {
"id" : "120ca8db-7029-4829-8118-e047c9726278",
"createdAt" : "/Date(1489385894660)/",
"updatedAt" : "/Date(1489449194660)/",
"version" : 4,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "john.doe@example.com",
"phone" : "55 234 555 678",
"position" : "Senior developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "yyyy-MM-dd",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "pt_BR",
"password" : "",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1491256800000)/",
"workingTimeStart" : "/Date(1489388400000)/",
"workingTimeEnd" : "/Date(1489420800000)/",
"created" : "/Date(1489301594659)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"client" : {
"id" : "c8be8ad2-3439-4782-88d4-2aa7bb3a1581",
"createdAt" : "/Date(1489387034660)/",
"updatedAt" : "/Date(1489405994660)/",
"version" : 3,
"externalSystem" : {
"id" : "b6bf58fd-75e6-4307-8227-806a30c1c7f4",
"createdAt" : "/Date(1489385474660)/",
"updatedAt" : "/Date(1489459994660)/",
"version" : 8,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "customer-996",
"externalBrowsableUrl" : "http://www.vendor.com/customers/996",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"name" : "Example Ltd.",
"code" : "EXL",
"email" : "info@example.com",
"billsCount" : 2,
"projectsCount" : 1,
"streetAddress" : "Rua 123 Sul Avenida Lo 15",
"additionalAddressInfo" : "",
"zipCode" : "89020-000",
"city" : "Palmas",
"state" : "Tocantins",
"countryCode" : "BRA",
"phone" : "+66 987 654 321",
"vatId" : "23.456.789/0001-77",
"website" : "http://www.example.com/",
"displayName" : "Example Ltd."
},
"billable" : true,
"autoMembership" : false,
"membersCount" : 1,
"tasksCount" : 3,
"timeRecordsCount" : 2,
"displayName" : "Content management system"
},
"task" : {
"id" : "42930c1e-ab0b-4f37-869d-9a0e45d03896",
"createdAt" : "/Date(1489387274660)/",
"updatedAt" : "/Date(1489441994660)/",
"version" : 1,
"externalSystem" : {
"id" : "b2ec0def-6a44-4106-b09c-442ff7975802",
"createdAt" : "/Date(1489386134660)/",
"updatedAt" : "/Date(1489391594660)/",
"version" : 9,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "task-334",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221/tasks/334",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"project" : {
"id" : "3ee814df-75c2-4024-8e79-2390c5d0dfdf",
"createdAt" : "/Date(1489385594660)/",
"updatedAt" : "/Date(1489456394660)/",
"version" : 4,
"externalSystem" : {
"id" : "e8accba6-acd6-41b2-b794-c76060278ff3",
"createdAt" : "/Date(1489386554660)/",
"updatedAt" : "/Date(1489438394660)/",
"version" : 7,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "project-221",
"externalBrowsableUrl" : "http://www.vendor.com/projects/221",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"name" : "Content management system",
"code" : "CMS",
"note" : "core feature",
"begins" : "/Date(1489301594659)/",
"ends" : "/Date(1489474394659)/",
"timeBudget" : 604800000,
"priceBudget" : 100000.0,
"personal" : true,
"owner" : {
"id" : "120ca8db-7029-4829-8118-e047c9726278",
"createdAt" : "/Date(1489385894660)/",
"updatedAt" : "/Date(1489449194660)/",
"version" : 4,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "john.doe@example.com",
"phone" : "55 234 555 678",
"position" : "Senior developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "yyyy-MM-dd",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "pt_BR",
"password" : "",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1491256800000)/",
"workingTimeStart" : "/Date(1489388400000)/",
"workingTimeEnd" : "/Date(1489420800000)/",
"created" : "/Date(1489301594659)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"client" : {
"id" : "c8be8ad2-3439-4782-88d4-2aa7bb3a1581",
"createdAt" : "/Date(1489387034660)/",
"updatedAt" : "/Date(1489405994660)/",
"version" : 3,
"externalSystem" : {
"id" : "b6bf58fd-75e6-4307-8227-806a30c1c7f4",
"createdAt" : "/Date(1489385474660)/",
"updatedAt" : "/Date(1489459994660)/",
"version" : 8,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "customer-996",
"externalBrowsableUrl" : "http://www.vendor.com/customers/996",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"name" : "Example Ltd.",
"code" : "EXL",
"email" : "info@example.com",
"billsCount" : 2,
"projectsCount" : 1,
"streetAddress" : "Rua 123 Sul Avenida Lo 15",
"additionalAddressInfo" : "",
"zipCode" : "89020-000",
"city" : "Palmas",
"state" : "Tocantins",
"countryCode" : "BRA",
"phone" : "+66 987 654 321",
"vatId" : "23.456.789/0001-77",
"website" : "http://www.example.com/",
"displayName" : "Example Ltd."
},
"billable" : true,
"autoMembership" : false,
"membersCount" : 1,
"tasksCount" : 3,
"timeRecordsCount" : 2,
"displayName" : "Content management system"
},
"name" : "Article editation",
"code" : "ART",
"note" : "form with validation",
"done" : false,
"author" : {
"id" : "120ca8db-7029-4829-8118-e047c9726278",
"createdAt" : "/Date(1489385894660)/",
"updatedAt" : "/Date(1489449194660)/",
"version" : 4,
"firstName" : "John",
"lastName" : "Doe",
"nickName" : "Johny D.",
"email" : "john.doe@example.com",
"phone" : "55 234 555 678",
"position" : "Senior developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "yyyy-MM-dd",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "pt_BR",
"password" : "",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1491256800000)/",
"workingTimeStart" : "/Date(1489388400000)/",
"workingTimeEnd" : "/Date(1489420800000)/",
"created" : "/Date(1489301594659)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Doe John"
},
"owner" : {
"id" : "36e159ad-fc4f-46bf-8085-1e1cf1f5a40f",
"createdAt" : "/Date(1489385294660)/",
"updatedAt" : "/Date(1489391594660)/",
"version" : 4,
"firstName" : "John",
"lastName" : "Smith",
"nickName" : "Smith, J.",
"email" : "john.smith@example.com",
"phone" : "55 123 444 567",
"position" : "Chief developer",
"timeZone" : "America/Sao_Paulo",
"dateFormat" : "dd/MM/yyyy",
"timeFormat" : "K:mm a",
"weekStart" : 7,
"language" : "en_US",
"password" : "",
"secretKey" : "userSecretKey",
"confirmed" : false,
"confirmedEmail" : false,
"active" : false,
"birthdayRemind" : "/Date(1490223600000)/",
"workingTimeStart" : "/Date(1489388400000)/",
"workingTimeEnd" : "/Date(1489420800000)/",
"created" : "/Date(1489301594659)/",
"admin" : false,
"projectManager" : false,
"displayName" : "Smith John"
},
"timeBudget" : 86400000,
"priceBudget" : 1000.0,
"displayName" : "Article editation"
},
"workType" : {
"id" : "238120aa-549c-43f7-ab40-478407060dad",
"createdAt" : "/Date(1489387454660)/",
"updatedAt" : "/Date(1489387994660)/",
"version" : 6,
"externalSystem" : {
"id" : "6ca27342-7063-4f1b-b632-281deaa78537",
"createdAt" : "/Date(1489386914660)/",
"updatedAt" : "/Date(1489398794660)/",
"version" : 6,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "wt-058",
"externalBrowsableUrl" : "http://www.vendor.com/worktypes/058",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"name" : "Software development",
"code" : "SW",
"category" : "WORK",
"displayName" : "Software development"
},
"client" : {
"id" : "c8be8ad2-3439-4782-88d4-2aa7bb3a1581",
"createdAt" : "/Date(1489387034660)/",
"updatedAt" : "/Date(1489405994660)/",
"version" : 3,
"externalSystem" : {
"id" : "b6bf58fd-75e6-4307-8227-806a30c1c7f4",
"createdAt" : "/Date(1489385474660)/",
"updatedAt" : "/Date(1489459994660)/",
"version" : 8,
"name" : "Vendor system",
"integrationPlugin" : "vendor",
"displayName" : "Vendor system"
},
"externalResourceId" : "customer-996",
"externalBrowsableUrl" : "http://www.vendor.com/customers/996",
"externalSyncedAt" : "/Date(1489387994659)/",
"externalSynced" : true,
"name" : "Example Ltd.",
"code" : "EXL",
"email" : "info@example.com",
"billsCount" : 2,
"projectsCount" : 1,
"streetAddress" : "Rua 123 Sul Avenida Lo 15",
"additionalAddressInfo" : "",
"zipCode" : "89020-000",
"city" : "Palmas",
"state" : "Tocantins",
"countryCode" : "BRA",
"phone" : "+66 987 654 321",
"vatId" : "23.456.789/0001-77",
"website" : "http://www.example.com/",
"displayName" : "Example Ltd."
},
"start" : "/Date(1489301594659)/",
"stop" : "/Date(1489323194659)/",
"duration" : 21600000,
"description" : "Form validations and CRUD.",
"billable" : true,
"price" : 648.5,
"unitPrice" : 3.0023E-5,
"priceAutoCalculation" : true,
"priceModified" : false,
"approved" : true,
"billed" : false,
"recordType" : "ATTENDANCE",
"displayName" : "Smith John"
}