v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Get the Customer Open Documents Report.

post/online/RivhitOnlineAPI.svc/Customer.OpenDocuments

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

customer_idinteger nullable

Rivhit Customer Identifier.

Range: 0 to 999999999 Default: No

document_typeinteger nullable

The Document Type.

Range: 0 to 999 Default: No

until_datestring date nullable

Limit the Documents Last Date to Display.

~ Date format DD-MM-YY or DD/MM/YYYY Length: 1 to 10 Default: Current day

by_produce_dateboolean nullable

Filter the Documents by Produce Date.

Default: false

accounting_onlyboolean nullable

Return only Accounting Documents (Invoice,Invoice Receipt, etc..).

Default: false

no_accountingboolean nullable

Return only Non-Accounting Documents (Order, Price Quote, etc..).

Default: false

agent_idinteger nullable

Rivhit Agent Identifier.

Range: 0 to 999999999 Default: No

from_datestring date nullable

Limit the Documents First Date to Display.

~ Date format DD-MM-YY or DD/MM/YYYY Length: 1 to 10 Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "document_type": 1,
  "until_date": "01-01-2025",
  "by_produce_date": true,
  "from_date": "01-01-2025"
}

Response

Success

error_codeinteger

The Response Error/Status Number (0 = Success)

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.