---
updatedAt: 2026-05-06T13:39:31.000Z
agentTools:
  projectIndex: https://rivhit-api.readme.io/llms.txt
---

# Item.SaleReport

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Get the Sale Report by Item.",
    "version": "1.0.0"
  },
  "paths": {
    "/online/RivhitOnlineAPI.svc/Item.SaleReport": {
      "post": {
        "summary": "Item.SaleReport",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "api_token": {
                    "type": "string",
                    "format": "uuid",
                    "example": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
                    "description": "Rivhit Merchant API Identifier.\n\n**Default:** No\n",
                    "nullable": false
                  },
                  "start_date": {
                    "type": "string",
                    "format": "date",
                    "example": "01-08-2025",
                    "description": "Start date for the report.\n\n~ combine with end_date\n~ Date format DD-MM-YY or DD/MM/YYYY\n**Default:** No\n",
                    "nullable": false
                  },
                  "end_date": {
                    "type": "string",
                    "format": "date",
                    "example": "12-08-2025",
                    "description": "End date for the report.\n\n~ combine with start_date\n~ Date format DD-MM-YY or DD/MM/YYYY\n**Default:** No\n",
                    "nullable": false
                  },
                  "item_groupId": {
                    "type": "integer",
                    "example": 7,
                    "description": "Item group ID.\n\n**Range:** 0 to 9999999\n**Default:** No\n",
                    "nullable": true
                  },
                  "document_type": {
                    "type": "integer",
                    "example": 1,
                    "description": "Document type.\n\n**Range:** 0 to 999\n**Default:** No\n",
                    "nullable": true
                  },
                  "acc_only": {
                    "type": "boolean",
                    "example": true,
                    "description": "True - Only Accounting Documents Report, False - All Documents Report.\n\n**Default:** False\n",
                    "nullable": false
                  },
                  "item_id": {
                    "type": "integer",
                    "example": 1022,
                    "description": "Item Identifier.\n\n**Range:** 0 to 999999999\n**Default:** No\n",
                    "nullable": true
                  },
                  "project_id": {
                    "type": "integer",
                    "example": 2,
                    "description": "Project Identifier.\n\n**Range:** 0 to 999999999\n**Default:** No\n",
                    "nullable": true
                  }
                },
                "required": [
                  "api_token",
                  "start_date",
                  "end_date"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success - Item Sale Report Returned",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error_code": {
                      "type": "integer",
                      "description": "The Response Error/Status Number (0 = Success)."
                    },
                    "client_message": {
                      "type": "string",
                      "description": "The Client Error Message."
                    },
                    "debug_message": {
                      "type": "string",
                      "description": "The Response Error Message."
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "item_sale_report": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "CategoryName": {
                                "type": "string",
                                "description": "Category Name."
                              },
                              "ItemName": {
                                "type": "string",
                                "description": "Item Name."
                              },
                              "ItemNumber": {
                                "type": "integer",
                                "description": "Item Identifier."
                              },
                              "ItemPartNum": {
                                "type": "string",
                                "description": "Item Catalog Number (SKU)."
                              },
                              "Quantity": {
                                "type": "number",
                                "format": "double",
                                "description": "Items Sold."
                              },
                              "Total": {
                                "type": "number",
                                "format": "double",
                                "description": "Total Sales Amount."
                              },
                              "TotalWithDiscount": {
                                "type": "number",
                                "format": "double",
                                "description": "Total Sales Amount After Discount."
                              }
                            }
                          }
                        }
                      }
                    }
                  },
                  "example": {
                    "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
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Request Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "Request Error"
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error_code": {
                      "type": "integer",
                      "description": "Error code of the response."
                    },
                    "client_message": {
                      "type": "string",
                      "description": "The Client Error Message."
                    },
                    "debug_message": {
                      "type": "string",
                      "description": "The Response Error Message."
                    },
                    "data": {
                      "type": "array",
                      "description": "Error Data."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://api.rivhit.co.il/"
    }
  ]
}
```