Timesheets

Send back a timesheet for review or modification

Sends the given timesheet back to the employee for review or modification.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage timeoffs (time_and_attendance)-Manage timesheets (timesheet:write)
Company-scoped access token (assertion)Manage timeoffs (time_and_attendance)-Manage timesheets (timesheet:write)
Customer API tokenManage timeoffs (time_and_attendance)-Manage timesheets (timesheet:write)
post/v1/timesheets/{timesheet_id}/send-back

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/timesheets/{timesheet_id}/send-back
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: timesheet:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: timesheet:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Path parameters

timesheet_idstring required

Timesheet ID

Request body

sent_back_reasonstring required

A required explanation of why the timesheet is being sent back. This will be visible to the employee.

Example request

{
  "sent_back_reason": "Please review the timesheet."
}

Response

Success

Example response

{
  "data": {
    "timesheet": {
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "sent_back": true,
      "sent_back_reason": "Please review the timesheet.",
      "status": "submitted"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.