Appearance
List timesheets
GET
/api/nova/timesheets
Weeks and months of every placement with timesheets that the API user sees on the Timesheets screen (billing visibility applies), newest first. Each says where it stands (status DRAFT, SUBMITTED, APPROVED or REJECTED), its days or hours with any client form's day fields by their labels, the contractor's answers, and its client invoice and self-bill once raised. Optional filters: status, placementId, companyId (the client) and month (yyyy-MM). Paged by page and size (default 20, at most 100). Read only. An invalid apiKey returns 401, a bad filter 400.
Authorizations
privateApiKey
Type
API Key (query: apiKey)
Parameters
Query Parameters
apiKey*
apiKey
Type
Requiredstring
companyId
companyId
Type
string
month
month
Type
string
page
page
Type
integer
Format
"int32"Default
0placementId
placementId
Type
string
size
size
Type
integer
Format
"int32"Default
20status
status
Type
string
Responses
OK
application/json
JSON "data": [ { "answers": [ { "question": "string", "value": "string" } ], "candidateId": "string", "chargeRate": 0, "client": "string", "companyId": "string", "contractor": "string", "currency": "string", "days": [ { "date": "string", "extra": { "additionalProperties": 0 }, "fields": { "additionalProperties": "string" }, "value": 0 } ], "decidedBy": "string", "decidedOn": "string", "decisionNote": "string", "expenses": [ { "amount": 0, "date": "string", "note": "string", "receiptName": "string", "what": "string" } ], "extraCharge": 0, "extraPay": 0, "extraRates": [ { "chargeRate": 0, "name": "string", "payRate": 0 } ], "id": "string", "invoices": [ { "client": "string", "companyId": "string", "contractor": "string", "currency": "string", "dueDate": "string", "expenses": 0, "from": "string", "id": "string", "invoiceDate": "string", "kind": "string", "month": "string", "net": 0, "number": "string", "paid": true, "paidOn": "string", "part": 0, "periodFrom": "string", "periodTo": "string", "placementId": "string", "poNumber": "string", "quantity": 0, "rate": 0, "sentOn": "string", "status": "string", "timesheetId": "string", "to": "string", "total": 0, "unit": "string", "vat": 0 } ], "jobTitle": "string", "month": "string", "part": 0, "payRate": 0, "periodFrom": "string", "periodTo": "string", "placementId": "string", "poNumber": "string", "status": "string", "submittedBy": "string", "submittedOn": "string", "total": 0, "unit": "string" } ], "error": "string", "message": "string", "page": 0, "requestId": "string", "size": 0, "success": true, "total": 0
{
}