Look up a returnable invoice

Any signed in user. Returns a number’s invoice with per line returned and returnable counts. It is scoped to the caller’s branch and case insensitive, so an outside invoice gets 404.

GET/api/v1/returns/lookup/{invoiceNumber}

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

invoiceNumberstringrequired

The invoice number, matched case insensitively, for example BR001-2026-000123.

Responses

200

The invoice and its returnable lines

idstringrequired

branch_idstringrequired

user_idstringrequired

invoice_numberstringrequired

uuidstringrequired

icvintegerrequired

min -9007199254740991 · max 9007199254740991

client_mutation_idstringrequired

payload_hashstringrequired

device_idstring | nullrequired

sync_statusstringrequired

subtotal_amountstringrequired

vat_amountstringrequired

total_amountstringrequired

vat_breakdownobject[]required

Show properties

Array of object

ratenumberrequired

taxable_amountnumberrequired

vat_amountnumberrequired

payment_methodstringrequired

payment_linesstring | nullrequired

notesstringrequired

session_idstring | nullrequired

customer_idstring | nullrequired

customer_namestringrequired

coupon_idstring | nullrequired

global_discountnumberrequired

coupon_discountnumberrequired

zatca_statusstringrequired

zatca_xmlstring | nullrequired

zatca_hashstringrequired

is_deletedbooleanrequired

sold_atstringrequired

pharmacist_namestring | nullrequired

itemsobject[]required

Show properties

Array of object

idstringrequired

sale_idstringrequired

medicine_idstringrequired

batch_idstringrequired

quantityintegerrequired

min -9007199254740991 · max 9007199254740991

unit_pricestringrequired

vat_ratestringrequired

vat_amountstringrequired

cost_at_salestringrequired

medicine_namestring | nullrequired

already_returnednumberrequired

returnable_qtynumberrequired

401

Not authenticated

detailstringrequired

404

Invoice not found in this branch

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

invoiceNumberpath*The invoice number, matched case insensitively, for example BR001-2026-000123.

Request

curl -X GET 'http://localhost:8000/api/v1/returns/lookup/string' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/returns/lookup/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/returns/lookup/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "branch_id": "string",
  "user_id": "string",
  "invoice_number": "string",
  "uuid": "string",
  "icv": -9007199254740991,
  "client_mutation_id": "string",
  "payload_hash": "string",
  "device_id": "string",
  "sync_status": "string",
  "subtotal_amount": "string",
  "vat_amount": "string",
  "total_amount": "string",
  "vat_breakdown": [
    {
      "rate": 0,
      "taxable_amount": 0,
      "vat_amount": 0
    }
  ],
  "payment_method": "string",
  "payment_lines": "string",
  "notes": "string",
  "session_id": "string",
  "customer_id": "string",
  "customer_name": "string",
  "coupon_id": "string",
  "global_discount": 0,
  "coupon_discount": 0,
  "zatca_status": "string",
  "zatca_xml": "string",
  "zatca_hash": "string",
  "is_deleted": true,
  "sold_at": "string",
  "pharmacist_name": "string",
  "items": [
    {
      "id": "string",
      "sale_id": "string",
      "medicine_id": "string",
      "batch_id": "string",
      "quantity": -9007199254740991,
      "unit_price": "string",
      "vat_rate": "string",
      "vat_amount": "string",
      "cost_at_sale": "string",
      "medicine_name": "string",
      "already_returned": 0,
      "returnable_qty": 0
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}