رفتن به محتوا
مستندات API سلر ۳۶۰

گزارش مالیات بر ارزش افزوده‌ی یک فصل

GET
/v1/reports/vat
curl --request GET \
  --url 'https://api.seller360.ir/v1/reports/vat?year=1405&season=1' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
year
integer
>= 1390

Example 

1405

سال شمسی؛ بدون آن، سال جاری.

season
required
integer
Allowed values: 1 2 3 4

Example 

3

فصل شمسی؛ 1 بهار، 2 تابستان، 3 پاییز، 4 زمستان.

Responses

Section titled “Responses”

200

Section titled “200”

سه ماه فصل و جمع آن.

Media typeapplication/json
object
status
required
Allowed value: ok
data
required
data
required
object
year
required
integer
season
required
integer
Allowed values: 1 2 3 4
label
required
string
range
required
object
from
required
string format: date
to
required
string format: date
days
required
integer
cutover

اولین روز تراکنش‌های این پنل؛ ارقام پیش از آن از صورت‌حساب‌های پایان‌یافته‌ی قدیم است و قطعی‌اند.

string | null format: date
months
required
Array
>= 3 items <= 3 items
object
jy
required
integer
jm
required
integer
label
required
string
from
required
string format: date
to
required
string format: date
deductions_by
required

کسورات به تفکیک سرفصل، بدون مالیات و با علامت (منفی یعنی کم شده)، و مالیات در tax؛ ریال.

object
commission
required
integer
platform
required
integer
fulfilment
required
integer
storage
required
integer
freight
required
integer
penalty
required
integer
other
required
integer
tax
required
integer
sales
required

فروش ناخالص بدون مالیات، ریال.

integer
units
required
integer
returns_net
required
integer
net_sales
required

فروش منهای برگشت از فروش.

integer
deductions_ex_vat
required

کسورات بدون مالیات (منفی).

integer
vat
required

مالیات بر ارزش افزوده با علامت، ریال.

integer
net_payout
required
integer
totals
required
object
sales
required

فروش ناخالص بدون مالیات، ریال.

integer
units
required
integer
returns_net
required
integer
net_sales
required

فروش منهای برگشت از فروش.

integer
deductions_ex_vat
required

کسورات بدون مالیات (منفی).

integer
vat
required

مالیات بر ارزش افزوده با علامت، ریال.

integer
net_payout
required
integer
finance

تازگی داده‌های مالی این پنل.

object
synced_at
required

زمان آخرین همگام‌سازی تراکنش‌ها و واریزها با دیجی‌کالا.

string | null format: date-time
history_complete
required

آیا تاریخچه‌ی یک‌ساله‌ی تراکنش‌ها کامل خوانده شده است. دریافت اولیه ممکن است چند شب طول بکشد.

boolean
oldest_date

قدیمی‌ترین روزی که تراکنش‌های آن خوانده شده است.

string | null format: date
stale
required

آیا آخرین همگام‌سازی موفق بیش از ۳۶ ساعت پیش بوده است.

boolean

Example 

{
  "status": "ok",
  "data": {
    "year": 1405,
    "season": 1,
    "label": "پاییز 1405",
    "range": {
      "from": "2026-10-23",
      "to": "2026-11-11",
      "days": 20
    },
    "months": [
      {
        "jy": 1405,
        "jm": 7,
        "label": "مهر 1405",
        "deductions_by": {
          "commission": -458400000,
          "platform": -21000000,
          "fulfilment": -190000000,
          "storage": -4200000,
          "freight": -1382883,
          "penalty": -3000000,
          "other": 0,
          "tax": -62300000
        },
        "sales": 11420000000,
        "units": 318,
        "returns_net": -254000000,
        "net_sales": 11132000000,
        "deductions_ex_vat": -2030000000,
        "vat": -186000000,
        "net_payout": 8950000000
      }
    ],
    "totals": {
      "sales": 11420000000,
      "units": 318,
      "returns_net": -254000000,
      "net_sales": 11132000000,
      "deductions_ex_vat": -2030000000,
      "vat": -186000000,
      "net_payout": 8950000000
    }
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

کد پیگیری این درخواست.

X-RateLimit-Limit
integer

سقف درخواست این نوع (خواندن یا نوشتن) در هر دقیقه برای این کلید.

X-RateLimit-Remaining
integer

درخواست‌های باقی‌مانده تا پایان دقیقه‌ی جاری.

X-RateLimit-Reset
integer

زمان شروع دقیقه‌ی بعد، به ثانیه از ۱۹۷۰ (Unix).

400

Section titled “400”

پارامتر یا بدنه‌ی نامعتبر.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

کد پیگیری این درخواست.

X-RateLimit-Limit
integer

سقف درخواست این نوع (خواندن یا نوشتن) در هر دقیقه برای این کلید.

X-RateLimit-Remaining
integer

درخواست‌های باقی‌مانده تا پایان دقیقه‌ی جاری.

X-RateLimit-Reset
integer

زمان شروع دقیقه‌ی بعد، به ثانیه از ۱۹۷۰ (Unix).

401

Section titled “401”

کلید ارسال نشده یا نامعتبر است.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

403

Section titled “403”

کلید دسترسی لازم را ندارد، یا ماژول یا پنل فعال نیست.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

429

Section titled “429”

سقف درخواست گذشته است.

Media typeapplication/json
object
status
required
Allowed value: error
error
required
object
code
required
string
Allowed values: missing_api_key invalid_api_key https_required scope_missing module_inactive panel_unavailable subscription_inactive not_found variant_not_found method_not_allowed invalid_parameter idempotency_key_required idempotency_mismatch idempotency_in_progress insufficient_stock version_conflict stock_write_locked sku_taken price_out_of_band price_managed_by_bot webhook_url_invalid webhook_limit_reached rate_limited digikala_rate_limited digikala_refused module_required digikala_outcome_unknown digikala_unavailable internal_error stock_split_in_progress kardex_disabled movement_type_not_allowed stock_count_finalized purchase_order_status_invalid product_key_unknown purchase_price_range_invalid product_locked_for_moderation catalog_row_invalid demo_panel_unsupported build_in_progress package_not_built_here shipping_write_unavailable pickup_unavailable feature_unavailable commitment_exceeded warehouse_not_listed slot_watch_exists draft_limit_reached draft_not_buildable draft_overdue draft_not_waiting consignment_not_allowed slot_unavailable no_open_slot replenish_rule_limit replenish_inactive price_managed_by_fx bot_strategy_required bot_quota_full strategy_not_found strategy_locked strategy_hidden strategy_title_reserved competitor_not_found change_not_undoable undo_window_expired already_undone undo_in_progress promotion_not_eligible promotion_managed_by_bot promotion_no_floor promotion_below_floor promotion_invalid promotion_not_active campaign_not_found campaign_closed fx_strategy_not_found fx_no_pending_price
message
required

پیام فارسی برای برنامه‌نویس.

string
detail

آنچه دقیقا نادرست بود، مثلا نام پارامتر.

string
doc_url
required
string format: uri
request_id
required
string

Example 

{
  "status": "error",
  "error": {
    "code": "missing_api_key"
  }
}

Headers

Section titled “Headers”
Retry-After
integer

چند ثانیه صبر کنید و دوباره تلاش کنید.

X-RateLimit-Limit
integer

سقف درخواست این نوع (خواندن یا نوشتن) در هر دقیقه برای این کلید.

X-RateLimit-Remaining
integer

درخواست‌های باقی‌مانده تا پایان دقیقه‌ی جاری.

X-RateLimit-Reset
integer

زمان شروع دقیقه‌ی بعد، به ثانیه از ۱۹۷۰ (Unix).