v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Item.SaleReport

post/online/RivhitOnlineAPI.svc/Item.SaleReport

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

start_datestring date required

Start date for the report.

~ combine with end_date ~ Date format DD-MM-YY or DD/MM/YYYY Default: No

end_datestring date required

End date for the report.

~ combine with start_date ~ Date format DD-MM-YY or DD/MM/YYYY Default: No

item_groupIdinteger nullable

Item group ID.

Range: 0 to 9999999 Default: No

document_typeinteger nullable

Document type.

Range: 0 to 999 Default: No

acc_onlyboolean

True - Only Accounting Documents Report, False - All Documents Report.

Default: False

item_idinteger nullable

Item Identifier.

Range: 0 to 999999999 Default: No

project_idinteger nullable

Project Identifier.

Range: 0 to 999999999 Default: No

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "start_date": "01-08-2025",
  "end_date": "12-08-2025",
  "item_groupId": 7,
  "document_type": 1,
  "acc_only": true,
  "item_id": 1022,
  "project_id": 2
}

Response

Success - Item Sale Report Returned

error_codeinteger

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

client_messagestring

The Client Error Message.

debug_messagestring

The Response Error Message.

Example response

{
  "error_code": 0,
  "client_message": "",
  "debug_message": "",
  "data": {
    "item_sale_report": [
      {
        "CategoryName": "קיר - פאנל",
        "ItemName": "מלל חופשי",
        "ItemNumber": 0,
        "ItemPartNum": "",
        "Quantity": 945,
        "Total": 59156.122136,
        "TotalWithDiscount": 59156.12
      },
      {
        "CategoryName": "קיר - פאנל",
        "ItemName": "בדיקה של אב",
        "ItemNumber": 1007,
        "ItemPartNum": "",
        "Quantity": -1,
        "Total": -20,
        "TotalWithDiscount": -20
      }
    ]
  }
}