Get tax predictions (Internal API)

This is a variant of GET /partner/api/statistic/tax-predictions — Get tax predictions; the request and responses below are the ones documented for Internal API.

Credentials

No credentials are documented for this endpoint.

Retrieve tax predictions for a seller including predicted tax amounts, profit, and rates.

Parameters

Name In Type Required Description
socialId query string yes Seller Israeli ID number
reportingYear query string yes Reporting year (4 digits)
reportingMonths query string yes Array of reporting months

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/partner/api/statistic/tax-predictions?socialId=<socialId>&reportingYear=<reportingYear>&reportingMonths=<reportingMonths>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/statistic/tax-predictions?socialId=<socialId>&reportingYear=<reportingYear>&reportingMonths=<reportingMonths>", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/partner/api/statistic/tax-predictions?socialId=<socialId>&reportingYear=<reportingYear>&reportingMonths=<reportingMonths>",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/partner/api/statistic/tax-predictions?socialId=<socialId>&reportingYear=<reportingYear>&reportingMonths=<reportingMonths>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Tax predictions retrieved successfully (success)

Field Type Description
reportingYear string
reportingMonths array
seller object
predictions array
predictions[].reportingYear string
predictions[].reportingMonth string
predictions[].totalIncomesWithoutVat number
predictions[].totalIncomesOriginTaxDeduction number
predictions[].totalDeductibleExpenses number
predictions[].yearlyPredictedProfit number
predictions[].predictedTaxAmount number
predictions[].paychecksPredictedSalary number
predictions[].paychecksPredictedTax number
predictions[].refundPointsValue number
predictions[].predictedTaxRateADV number

400 — Bad Request - Validation failed (error)

Field Type Description
statusCode integer
message string
error string 
{
  "statusCode": 400,
  "message": [
    "Validation failed"
  ],
  "error": "Bad Request"
}

401 — Unauthorized - Invalid or missing authentication (error)

Field Type Description
statusCode integer
message string
error string 
{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}