Skip to content
BILLZ for developers

Transactions

GET
/v1/transaction-report-table
curl --request GET \
  --url 'https://api-admin.billz.ai/v1/transaction-report-table?start_date=2026-08-01&end_date=2026-08-31&shop_ids=09737a5c-19ee-4eb2-af02-4bdabf8a15e5%2Cb03661ba-731a-4e50-8f37-d220b89d718e&page=1&limit=10&price_type=0' \
  --header 'Authorization: Bearer <token>' \
  --header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01'

Error codes: 400 — input validation error; 404 — object not found; 401, 403, 429, 500 — shared by all methods. Body formats and semantics: Response codes and errors.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start_date
string format: date
Example
2026-08-01

Empty → today; format YYYY-MM-DD, without time

end_date
string format: date
Example
2026-08-31

Empty → start_date; always +24h; format YYYY-MM-DD, without time

shop_ids
Array<string>

Each element must be a UUID, otherwise 400

Example
[
  "09737a5c-19ee-4eb2-af02-4bdabf8a15e5",
  "b03661ba-731a-4e50-8f37-d220b89d718e"
]
seller_ids
Array<string>
cashier_ids
Array<string>
payment_type_ids
Array<string>
order_types
Array<string>

Only SALE, RETURN, EXCHANGE are allowed; otherwise → 400

page
integer format: int32
default: 1

A non-numeric value silently yields 1

Example
1
limit
integer format: int32
default: 10

A non-numeric value silently yields 10

Example
10
price_type
integer format: int32
0

Header Parameters

Section titled “Header Parameters”
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Platform identifier. A static value is used for integrations.

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
rows
Array<object>
object
row_id
string
date
string
external_id
string
order_id
string
shop_id
string
shop_name
string
customer_name
string
customer_id
string
seller_ids
Array<string>
seller_names
Array<string>
cashier_id
string
cashier_name
string
order_type
string
sold_measurement_value
number
returned_measurement_value
number
total_price
number
discount_percent
integer
gross_sales
number
average_product_price
number
comment
string
is_modified
boolean
payments
Array<object>
object
payment_type_id
string
payment_type_name
string
sum
number
count
integer format: int32
Examplegenerated
{
  "rows": [
    {
      "row_id": "example",
      "date": "example",
      "external_id": "example",
      "order_id": "example",
      "shop_id": "example",
      "shop_name": "example",
      "customer_name": "example",
      "customer_id": "example",
      "seller_ids": [
        "example"
      ],
      "seller_names": [
        "example"
      ],
      "cashier_id": "example",
      "cashier_name": "example",
      "order_type": "example",
      "sold_measurement_value": 1,
      "returned_measurement_value": 1,
      "total_price": 1,
      "discount_percent": 1,
      "gross_sales": 1,
      "average_product_price": 1,
      "comment": "example",
      "is_modified": true,
      "payments": [
        {
          "payment_type_id": "example",
          "payment_type_name": "example",
          "sum": 1
        }
      ]
    }
  ],
  "count": 1
}