Document.Cancel

post

https://api.rivhit.co.il/online/RivhitOnlineAPI.svc/Document.Cancel

Cancel a Document

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

api_token

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

string | null

enum

Set the Document Language.

Options: (he/en)
Default: he

Allowed:

email_to

string | null

Customer Email Address.

Length: 6 to 50
Default: Customer details

digital_signature

boolean | null

Produce the Document With a Digital Signature.

true = With digital signature
Default: false

signature_pin

string | null

The Digital Signature PIN Code.

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

comments

string | null

The Customer Comments (to print on the invoice).

Length: 1 to 400
Default: Rivhit system settings

request_reference

string | null

The Document Request Reference.

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

cancellation_date

date

Cancellation Date of the Document.

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

cancellation_time

string | null

^([01]?[0-9]|2[0-3]):([0-5]?[0-9])$

Cancellation Time of the Document.

Format: HH:MM
Default: Current time

Responses

200Success - Document Canceled

400Request Error

500Internal Server Error