---
title: "Document.Cancel"
method: POST
path: "/online/RivhitOnlineAPI.svc/Document.Cancel"
---

# Document.Cancel

`POST /online/RivhitOnlineAPI.svc/Document.Cancel`

## Request body

- object
  - `api_token` string, uuid, required — Rivhit Merchant API Identifier. **Default:** No
  - `document_type` integer, required — Document Type. **Range:** 0 to 999 **Default:** No
  - `document_number` integer, required — The Number of a Document to Cancel. **Range:** 1 to 99999 **Default:** Documents settings
  - `language` 'he' | 'en', nullable — Set the Document Language. **Options:** (he/en) **Default:** he
  - `email_to` string, email, nullable — Customer Email Address. **Length:** 6 to 50 **Default:** Customer details
  - `digital_signature` boolean, nullable — Produce the Document With a Digital Signature. true = With digital signature **Default:** false
  - `signature_pin` string, nullable — The Digital Signature PIN Code. ~ *Send only by API support instructions* **Length:** 3 to 6 **Default:** No
  - `comments` string, nullable — The Customer Comments (to print on the invoice). **Length:** 1 to 400 **Default:** Rivhit system settings
  - `request_reference` string, nullable — The Document Request Reference. ~ Should be unique value **Length:** 2GB **Default:** No
  - `cancellation_date` string, date — Cancellation Date of the Document. **Format:** DD-MM-YY or DD/MM/YYYY **Default:** Current day
  - `cancellation_time` string, nullable — Cancellation Time of the Document. **Format:** HH:MM **Default:** Current time

## Response `200`

Success - Document Canceled

- object
  - `error_code` integer — The Response Error/Status Number (0 = Success).
  - `client_message` string — The Client Error Message.
  - `debug_message` string — The Response Error Message.
  - `data` object
    - `status` integer — Canceled Document Status (0 = Success).
    - `cancel_document_type` integer — Canceled Document Type.
    - `cancel_document_number` integer — Canceled Document Number.
    - `cancel_document_identity` string, uuid — Canceled Document Identifier.
    - `cancel_document_link` string, url — Canceled Document Link.

## Other responses

- `400` — Request Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/rivhit/apis/get-payment-url-22-12.md) · [All operations](https://skmtc.net/rivhit/apis/get-payment-url-22-12/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivhit/get-payment-url-22-12/revisions/ed5261a52458/schema)