v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Document.Close

post/online/RivhitOnlineAPI.svc/Document.Close

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

document_typeinteger required

The Type of the Document to Close.

Range: 0 to 999 Default: No

document_numberinteger required

The Number of the Document to Close.

Range: 0 to 999999 Default: No

closing_typeinteger required

The Type of the Document that is Closing.

~ For manual closing send 0 Range: 0 to 999 Default: No

closing_numberinteger required

The Number of the Document that is Closing.

~ For manual closing send 0 Range: 0 to 999999 Default: No

closing_datestring date required

The Closing Date.

Format: DD-MM-YY or DD/MM/YYYY Default: No

amount_closenumber double required

Amount to Close.

Default: No

document_is_receiptboolean required

Set if the Closing Document is a Receipt.

~ For manual closing send true Default: No

request_referencestring nullable

Closing Action Request Reference.

~ Use for future search with method - Status.LastRequest ~ Should be unique value Length: 2GB Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 1,
  "document_number": 10,
  "closing_date": "15-01-2025",
  "amount_close": 10,
  "document_is_receipt": true,
  "request_reference": "abcdefg-&123456789"
}

Response

Success - Document Closed

error_codeinteger

The Response Error/Status Number (0 = Success)

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Example response

{
  "data": {
    "status": true
  }
}