Sign in

v1

latestOpenAPI 3.0.02026-08-04880393.1 KB

Company.SummaryReport

Get Company Summary Documents report

post/online/RivhitOnlineAPI.svc/Company.SummaryReport

Request body

api_tokenstring uuid required

Rivhit Merchant API Identifier.

Default: No

yearinteger required

Year to Filter by.

Default: No Format: YYYY

monthinteger required

Month to Filter by.

Default: No Format: MM

dayinteger nullable

Day to Filter by.

Default: No Format: DD

project_idinteger nullable

Project ID to Filter by.

Default: No Range: 0 to 999999999

Example request

{
  "api_token": "DECD03E5-E35C-41E8-84F7-FBA2FB483928",
  "year": 2025,
  "month": 10,
  "day": 1,
  "project_id": 123
}

Response

Success - Company Summary 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": {
    "Documents": [
      {
        "DocCount": 581,
        "DocType": 1,
        "DocTypeName": "חשבונית מס",
        "TotalDiscount": -8338.3,
        "TotalVat": 270733.9,
        "TotalWithVat": 1779965.56,
        "TotalWithoutVat": 1517569.96
      },
      {
        "DocCount": 747,
        "DocType": 2,
        "DocTypeName": "חשבונית מס קבלה",
        "TotalDiscount": 0.75,
        "TotalVat": 79171.35,
        "TotalWithVat": 519009.21,
        "TotalWithoutVat": 439837.11
      },
      {
        "DocCount": 67,
        "DocType": 3,
        "DocTypeName": "חשבונית מס זיכוי",
        "TotalDiscount": 3450.8,
        "TotalVat": -22532.82,
        "TotalWithVat": -150817.24,
        "TotalWithoutVat": -131735.22
      },
      {
        "DocCount": 1114,
        "DocType": 4,
        "DocTypeName": "תעודת משלוח",
        "TotalDiscount": -18058.55,
        "TotalVat": 81416.5,
        "TotalWithVat": 533722.96,
        "TotalWithoutVat": 470365.01
      },
      {
        "DocCount": 10,
        "DocType": 6,
        "DocTypeName": "הצעת מחיר",
        "TotalDiscount": -1050.2,
        "TotalVat": 8879.75,
        "TotalWithVat": 58211.66,
        "TotalWithoutVat": 50382.11
      },
      {
        "DocCount": 6,
        "DocType": 7,
        "DocTypeName": "הזמנה",
        "TotalDiscount": 0.17,
        "TotalVat": 693.98,
        "TotalWithVat": 4549.4,
        "TotalWithoutVat": 3855.25
      },
      {
        "DocCount": 50,
        "DocType": 8,
        "DocTypeName": "חשבון חיוב",
        "TotalDiscount": -0.14,
        "TotalVat": 30248.09,
        "TotalWithVat": 198293,
        "TotalWithoutVat": 168045.05
      },
      {
        "DocCount": 1,
        "DocType": 9,
        "DocTypeName": "חשבונית קניות למלאי",
        "TotalDiscount": 0,
        "TotalVat": 3.05,
        "TotalWithVat": 20,
        "TotalWithoutVat": 16.95
      },
      {
        "DocCount": 1,
        "DocType": 10,
        "DocTypeName": "תעודת יציאה ממלאי",
        "TotalDiscount": 0,
        "TotalVat": 3.05,
        "TotalWithVat": 20,
        "TotalWithoutVat": 16.95
      },
      {
        "DocCount": 1,
        "DocType": 11,
        "DocTypeName": "תעודת כניסה למלאי",
        "TotalDiscount": 0,
        "TotalVat": 3.05,
        "TotalWithVat": 20,
        "TotalWithoutVat": 16.95
      },
      {
        "DocCount": 1,
        "DocType": 12,
        "DocTypeName": "חשבונית-קליטה מפנקס",
        "TotalDiscount": 0,
        "TotalVat": 3.05,
        "TotalWithVat": 20,
        "TotalWithoutVat": 16.95
      },
      {
        "DocCount": 1,
        "DocType": 999,
        "DocTypeName": "ת.משלוח בין מחסנים",
        "TotalDiscount": 0.34,
        "TotalVat": -104.34,
        "TotalWithVat": -684,
        "TotalWithoutVat": -580
      }
    ],
    "PayCodes": [
      {
        "Count": 36,
        "PayCodeType": 1,
        "PayCodeTypeName": "שיק",
        "TotalAmount": 56965
      },
      {
        "Count": 137,
        "PayCodeType": 2,
        "PayCodeTypeName": "מזומן",
        "TotalAmount": 47522.71
      },
      {
        "Count": 6,
        "PayCodeType": 3,
        "PayCodeTypeName": "נ.מס במקור",
        "TotalAmount": 6400
      },
      {
        "Count": 49,
        "PayCodeType": 4,
        "PayCodeTypeName": "ישראכרט",
        "TotalAmount": 203358
      },
      {
        "Count": 79,
        "PayCodeType": 5,
        "PayCodeTypeName": "ויזה",
        "TotalAmount": 190717.63
      },
      {
        "Count": 819,
        "PayCodeType": 6,
        "PayCodeTypeName": "כ. אשראי אחר",
        "TotalAmount": 199389.9
      },
      {
        "Count": 1,
        "PayCodeType": 7,
        "PayCodeTypeName": "דיינרס",
        "TotalAmount": 11.8
      },
      {
        "Count": 66,
        "PayCodeType": 9,
        "PayCodeTypeName": "העברה בנקאית",
        "TotalAmount": 312348.28
      },
      {
        "Count": 5,
        "PayCodeType": 14,
        "PayCodeTypeName": "מפורט",
        "TotalAmount": 1000
      }
    ],
    "Receipts": [
      {
        "ReceiptCount": 186,
        "ReceiptType": 1,
        "ReceiptTypeName": "קבלה",
        "TotalAmount": 466943.11
      },
      {
        "ReceiptCount": 747,
        "ReceiptType": 2,
        "ReceiptTypeName": "קבלה מחשבונית מס",
        "TotalAmount": 519009.21
      },
      {
        "ReceiptCount": 5,
        "ReceiptType": 3,
        "ReceiptTypeName": "קבלת דחויים",
        "TotalAmount": 30511
      },
      {
        "ReceiptCount": 1,
        "ReceiptType": 4,
        "ReceiptTypeName": "קבלה מפנקס",
        "TotalAmount": 1250
      }
    ]
  }
}