Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Calculate Reverse Totals

Developing

POST

https://api.zid.sa/v1/managers/reverse-credit-note/totals

Calculates the refund totals for a reverse order before creating the actual reverse order.

This endpoint is typically used to:

Preview refund amounts for full or partial returns

Show customers or operators a breakdown of refund totals (subtotal, discounts, VAT, total)

Validate selected return products and quantities prior to reverse order creation

⚠️ Important

This endpoint does not create a reverse order.

No stock changes, refunds, or order status updates occur.

It is a read-only calculation based on provided inputs.

Request

Header Params

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/managers/reverse-credit-note/totals' \
--header 'Authorization: {{Autherization}}' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Accept: application/json' \
--form 'order_id="64085792"' \
--form 'is_partial="1"' \
--form 'products[0][order_product_id]="110166397"' \
--form 'products[0][quantity]="1"'

Responses

🟢200OK

application/json

Body

Example

{
    "invoice": [
        {
            "code": "sub_totals",
            "value": 173.5304338832,
            "value_string": "173.53 SAR",
            "title": "Sub Total"
        },
        {
            "code": "discounts",
            "value": 0,
            "value_string": "0.00 SAR",
            "title": "Discount"
        },
        {
            "code": "sub_total_after_discounts",
            "value": 173.5304338832,
            "value_string": "173.53 SAR",
            "title": "Subtotal After Discounts"
        },
        {
            "code": "vat",
            "value": 26.02956508248,
            "value_string": "26.03 SAR",
            "title": "VAT (%15)"
        },
        {
            "code": "total",
            "value": 199.55999896568,
            "value_string": "199.56 SAR",
            "title": "Total"
        }
    ]
}

🟠401Unauthorized

🟠404Not found

🟠422Validation errors

🟠422Execution Exception

🔴500Internal Server error

🔴500Server Error

Modified at 2026-02-02 13:25:08

List Reverse Reasons

Create refund for reverse order

Calculate Reverse Totals

⚠️ Important#

Request

Request Code Samples

Responses

⚠️ Important