---
search:
  tags:
    - Returns
    - GET
seo:
  description: >-
    Any signed in user. Returns a number's invoice with per line… Reference for
    the GET /api/v1/returns/lookup/{invoiceNumber} endpoint in the PharmaFlow
    API.
sidebar:
  label: Look up a returnable invoice
  badge: GET
title: Look up a returnable invoice
type: openapi-operation
---
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}`

**Responses**

- `200` — The invoice and its returnable lines
- `401` — Not authenticated
- `404` — Invoice not found in this branch

Response example, 200:

```json
{
  "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
    }
  ]
}
```
