Job Payments

Delete a Job Payment

Changed on

In ServiceM8, deleting a record sets its active field to 0. Inactive records are still accessible on the API, but are hidden in the UI. Inactive records can be restored by setting their active field to 1.

OAuth Scope

This endpoint requires the following OAuth scope manage_job_payments.

delete/jobpayment/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/jobpayment/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_job_payments

Path parameters

uuidstring uuid required

UUID of the Job Payment

Response

Job Payment successfully archived (soft deleted)

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e859f8c27a21Revision changes
    • info

      the security scope manage_job_payments was added to the endpoint's security scheme oauth2