Skip to main content
GET
/
api
/
v1
/
fintech
/
invoices
Get Fintech Invoices
curl --request GET \
  --url https://api.retailreadyai.com/api/v1/fintech/invoices \
  --header 'Authorization: Bearer <token>'
{
  "message": "Invoices retrieved successfully",
  "data": {
    "brands": [
      {
        "brand_id": "brand-123",
        "brand_name": "Acme",
        "line_items": [
          {
            "metric": "Orders",
            "count": 42,
            "price_dollars": 84
          },
          {
            "metric": "Pallets",
            "count": 10,
            "price_dollars": 25
          },
          {
            "metric": "Cartons",
            "count": 120,
            "price_dollars": 60
          }
        ],
        "action_items": [
          {
            "type": "Carton Workflow",
            "metric": "Pack",
            "count": 120,
            "price_dollars": 30
          }
        ],
        "total_price_dollars": 249
      }
    ],
    "total_price_dollars": 249
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
brand_id
string

Filter to a single brand.

​
retailer_id
string

Filter to a single retailer.

​
transportation_method
enum<string>

Filter by transportation method.

Available options:
FREIGHT,
PARCEL
​
order_completed_at_start
string<date>

Lower bound (inclusive) on order completion (ASN sent). Every date bound is optional and independent.

​
order_completed_at_end
string<date>

Upper bound (inclusive) on order completion (ASN sent).

​
order_packed_at_start
string<date>

Lower bound (inclusive) on packed date.

​
order_packed_at_end
string<date>

Upper bound (inclusive) on packed date.

Response

Invoices retrieved successfully.

​
message
string
Example:

"Invoices retrieved successfully"

​
data
object