ed5261a52458

latestOpenAPI 3.0.02026-08-04880393.1 KB

Document.Cancel

post/online/RivhitOnlineAPI.svc/Document.Cancel

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

document_typeinteger required

Document Type.

Range: 0 to 999 Default: No

document_numberinteger 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_tostring email nullable

Customer Email Address.

Length: 6 to 50 Default: Customer details

digital_signatureboolean nullable

Produce the Document With a Digital Signature.

true = With digital signature
Default: false

signature_pinstring nullable

The Digital Signature PIN Code.

~ Send only by API support instructions Length: 3 to 6 Default: No

commentsstring nullable

The Customer Comments (to print on the invoice).

Length: 1 to 400 Default: Rivhit system settings

request_referencestring nullable

The Document Request Reference.

~ Should be unique value Length: 2GB Default: No

cancellation_datestring date

Cancellation Date of the Document.

Format: DD-MM-YY or DD/MM/YYYY Default: Current day

cancellation_timestring nullable

Cancellation Time of the Document.

Format: HH:MM Default: Current time

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 1,
  "document_number": 1000,
  "language": "he",
  "email_to": "a@a.com",
  "digital_signature": true,
  "signature_pin": "Ab123",
  "comments": "Comments will be here",
  "request_reference": "abcdefg-&123456789",
  "cancellation_date": "01-01-2025",
  "cancellation_time": "10:30"
}

Response

Success - Document Canceled

error_codeinteger

The Response Error/Status Number (0 = Success).

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.