Timesheet Metadata

GET {{base_url}}/metadata/TSEntry

Use this endpoint to retrieve the Timesheet metadata.

The metadata describes the fields in each table of the database for the record and describes whether or not the table is a custom table and whether or not it has a grid ID. Each field describes whether or not the field is required, the data type, the default value, whether or not it is updateable, and other useful minimums, limits, and maximum details.

For more information, see Metadata Reference.

HEADERS

The type of content supported by the API endpoint. | | Authorization | string | | Required.

The type of authorization supported by the API endpoint. |

RESPONSES

status: OK

{"tsControl":{"Keys":"Batch","TableName":"tsControl","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Description","FieldType":"String","Caption":"Description","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Recurring","FieldType":"Checkbox","Caption":"Recurring","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"StartDate","FieldType":"Date","Caption":"Start Date","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"EndDate","FieldType":"Date","Caption":"End Date","DefaultValue":"2007-12-31T00:00:00.000","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"RegHrsTotal","FieldType":"Numeric","Caption":"Regular Hours Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":2},{"FieldName":"SumRegHrsTotal","FieldType":"Numeric","Caption":"Regular Hours File Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"DiffRegHrsTotal","FieldType":"Numeric","Caption":"Regular Hours Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false,"Decimals":2},{"FieldName":"OvtHrsTotal","FieldType":"Numeric","Caption":"Overtime Hours Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":2},{"FieldName":"SumOvtHrsTotal","FieldType":"Numeric","Caption":"Overtime Hours File Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"DiffOvtHrsTotal","FieldType":"Numeric","Caption":"Overtime Hours Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false,"Decimals":2},{"FieldName":"SpecialOvtHrsTotal","FieldType":"Numeric","Caption":"Overtime-2 Hours Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":2},{"FieldName":"SumSpecialOvtHrsTotal","FieldType":"Numeric","Caption":"Overtime-2 Hours File Total","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"DiffSpecialOvtHrsTotal","FieldType":"Numeric","Caption":"Overtime-2 Hours Difference","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false,"Decimals":2},{"FieldName":"Selected","FieldType":"String","Caption":"Selected","DefaultValue":"Y","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Creator","FieldType":"String","Caption":"Creator","DefaultValue":"ADMIN","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Period","FieldType":"Numeric","Caption":"Period","DefaultValue":"200712","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Company","FieldType":"Company","Caption":"Company","DefaultValue":"[CURRENTCOMPANY]","Hidden":false,"Required":true,"Updateable":true,"MaxLength":14},{"FieldName":"Diary","FieldType":"Dropdown","Caption":"Diary","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CodeTable":"CFGDiaryAutoNum LEFT JOIN CFGDiary ON CFGDiaryAutoNum.Code = CFGDiary.Code LEFT JOIN CFGDatesStatus ON CFGDiaryAutoNum.Period = CFGDatesStatus.Period and CFGDiaryAutoNum.Company = CFGDatesStatus.Company LEFT JOIN (SELECT '0/'+CONVERT(varchar,Years) AS Pd, Years * 100 AS Period FROM (SELECT Distinct Period/100 AS Years FROM CFGDatesStatus WHERE Closed = 'N' and CFGDatesStatus.Company = /*N*/'PR') x) _OpenYear ON CFGDiaryAutoNum.Period = _OpenYear.Period","LimitToList":true},{"FieldName":"DiaryNo","FieldType":"Numeric","Caption":"Diary Number","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":false}],"Caption":"tsControl"},"tsMasterKey":{"Keys":"Batch,Employee","TableName":"tsMasterKey","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Employee","FieldType":"Employee","Caption":"Employee","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":5},{"FieldName":"EmployeeName","FieldType":"Employee","Caption":"EmployeeName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":5},{"FieldName":"StatusDesc","FieldType":"String","Caption":"StatusDesc","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true}],"Caption":"tsMasterKey"},"tsMaster":{"Keys":"Batch,Employee","TableName":"tsMaster","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Employee","FieldType":"Employee","Caption":"Employee","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":5},{"FieldName":"EmplName","FieldType":"String","Caption":"EmplName","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"BillingCategory","FieldType":"String","Caption":"BillingCategory","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"LocaleMethod","FieldType":"String","Caption":"LocaleMethod","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Locale","FieldType":"String","Caption":"Locale","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Posted","FieldType":"String","Caption":"Posted","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Status","FieldType":"String","Caption":"Status","DefaultValue":"N","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"StatusDescription","FieldType":"String","Caption":"Status","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AuthorizedByName","FieldType":"String","Caption":"Approved By","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"AuthorizedBy","FieldType":"String","Caption":"AuthorizedBy","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"RejectReason","FieldType":"String","Caption":"Reject Reason","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":500},{"FieldName":"ModUser","FieldType":"String","Caption":"ModUser","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true},{"FieldName":"ModUserEmployee","FieldType":"String","Caption":"ModUserEmployee","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ModDate","FieldType":"Datetime","Caption":"ModDate","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true}],"Caption":"tsMaster"},"tsDetail":{"Keys":"Batch,Employee,PKey","TableName":"tsDetail","GridID":null,"Hidden":false,"Updateable":true,"Fields":[{"FieldName":"Batch","FieldType":"String","Caption":"Batch","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Employee","FieldType":"Employee","Caption":"Employee","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":5},{"FieldName":"PKey","FieldType":"String","Caption":"PKey","DefaultValue":"[GUID]","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"Seq","FieldType":"Numeric","Caption":"Seq","DefaultValue":"0","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"TransDate","FieldType":"Date","Caption":"\u003cbr /\u003eDate","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true},{"FieldName":"WBS1","FieldType":"WBS1","Caption":"\u003cbr /\u003eProject","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":10},{"FieldName":"WBS1Name","FieldType":"String","Caption":"\u003cbr /\u003eProject Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"ClientName","FieldType":"String","Caption":"\u003cbr /\u003eClient Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2Level","FieldType":"String","Caption":"WBS2Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS1Locale","FieldType":"String","Caption":"WBS1Locale","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2","FieldType":"WBS2","Caption":"\u003cbr /\u003ePhase","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS2Name","FieldType":"String","Caption":"\u003cbr /\u003ePhase Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3Level","FieldType":"String","Caption":"WBS3Level","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS2Locale","FieldType":"String","Caption":"WBS2Locale","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3","FieldType":"WBS3","Caption":"\u003cbr /\u003eTask","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"MaxLength":3},{"FieldName":"WBS3Name","FieldType":"String","Caption":"\u003cbr /\u003eTask Name","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"WBS3Locale","FieldType":"String","Caption":"WBS3Locale","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"LaborCode","FieldType":"LABCD","Caption":"\u003cbr /\u003eLabor Code","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"MaxLength":5},{"FieldName":"LCName","FieldType":"String","Caption":"Labor Code\u003cbr/\u003eDescription","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"Org","FieldType":"String","Caption":"Org","DefaultValue":"","Hidden":false,"Required":false,"Updateable":false},{"FieldName":"BillCategory","FieldType":"Dropdown","Caption":"Labor\u003cbr /\u003eCategory","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CodeTable":"BTLaborCats","LimitToList":true},{"FieldName":"Locale","FieldType":"Dropdown","Caption":"Payroll\u003cbr /\u003eTax Locale","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"LimitToList":true},{"FieldName":"RegHrs","FieldType":"Numeric","Caption":"Regular\u003cbr /\u003eHours","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":2},{"FieldName":"OvtHrs","FieldType":"Numeric","Caption":"Overtime \u003cbr /\u003eHours","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":2},{"FieldName":"SpecialOvtHrs","FieldType":"Numeric","Caption":"Overtime-2\u003cbr /\u003eHours","DefaultValue":"0","Hidden":false,"Required":false,"Updateable":true,"Decimals":2},{"FieldName":"TransComment","FieldType":"String","Caption":"\u003cbr /\u003eComment","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true}],"Caption":"tsDetail"}}