Franchise Endpoints

This document covers the franchise endpoints available to franchise accounts: reading your franchise locations, reading the agreement in force for each location, and reading the fee and royalty statements the Company issues. The Franchise Disclosure Document controls the offer and sale of franchises; franchise terms are governed by the Franchise Agreement Policy and the Franchise Fees & Royalties Policy. This document states the endpoint mechanics. A franchise location in this reference is a business party: a franchised business operating under an agreement with the Company: and each location has its own franchise account.

Access through the developer API is issued by the Company and is limited by seller type: manufacturer and supplier accounts receive API access for importing data, under the Developer Agreement and the API Access Tiers. Franchise endpoints are available to an approved franchise account for its own locations only, authenticated as described in Authentication Endpoints. Nothing in this document grants broader access.

Endpoints

Method	Path	Purpose
GET	/franchise/locations	List the franchise locations on your franchise account
GET	/franchise/locations/{id}	Read one location: business details, status, agreement summary
GET	/franchise/locations/{id}/agreement	Read the agreement in force for a location
GET	/franchise/locations/{id}/statements	List fee and royalty statements for a location
GET	/franchise/statements/{id}	Read one statement in full, with its calculation lines

All paths are relative to the base URL https://www.aapawz.com/api. Collections paginate as specified in Pagination and Filtering (Pagination & Filtering). These endpoints are read-only: locations are opened, and agreements are executed, through the Company's franchise onboarding process, not through the API.

The location object

{
  "id": "frloc_28qp51",
  "business_name": "Riverside Grooming and Boarding",
  "trading_name": "All About Pawz: Riverside",
  "status": "active",
  "address": {
    "line1": "1200 Riverwalk Drive",
    "line2": null,
    "city": "Memphis",
    "region": "TN",
    "postal_code": "38103",
    "country": "US"
  },
  "phone": "+1 901 555 0142",
  "opened_at": "2026-05-04",
  "agreement": {
    "id": "frag_71md08",
    "status": "in_force",
    "starts_at": "2026-05-01",
    "expires_at": "2031-04-30"
  }
}

status is one of pending_opening, active, suspended, closed. A location is fully open for business under the Platform when its record is active and its agreement is in_force; an agreement recorded as pending_signature does not yet confer operating rights. Keep your location's business details current through your franchise contact at the Company; the API reflects changes once they are recorded.

The agreement object

{
  "id": "frag_71md08",
  "location_id": "frloc_28qp51",
  "type": "franchise",
  "status": "in_force",
  "signed_at": "2026-04-22T15:40:00Z",
  "starts_at": "2026-05-01",
  "expires_at": "2031-04-30",
  "royalty_rate": "0.06",
  "document_url": "https://www.aapawz.com/franchise/agreements/frag_71md08/executed.pdf"
}

• royalty_rate is the rate stated in the executed agreement for this location, expressed as a decimal fraction. Royalty and fee amounts are always computed from the agreement in force for the location and its fee schedule: never assume a network-wide rate, and never hard-code a rate in your systems.
• document_url points at the executed agreement once signed. Before signature the agreement is pending_signature and signed_at and document_url are null.
• The agreement, not this API summary, is the controlling document. If a value here and the executed agreement differ, tell the Company at once through your franchise contact.

Fee and royalty statements

A statement covers one location and one period. It lists the sales base for the period, each fee line with its basis, and the amount due.

{
  "id": "frst_90xa37",
  "location_id": "frloc_28qp51",
  "period_start": "2026-09-01",
  "period_end": "2026-09-30",
  "currency": "USD",
  "sales_base": "48210.00",
  "lines": [
    { "type": "royalty", "basis": "sales_base", "rate": "0.06", "amount": "2892.60" },
    { "type": "brand_fund", "basis": "sales_base", "rate": "0.01", "amount": "482.10" }
  ],
  "total_due": "3374.70",
  "status": "issued",
  "issued_at": "2026-10-05T09:00:00Z",
  "due_at": "2026-10-20"
}

Statement status is issued, paid, overdue, or corrected. A corrected statement supersedes the one it names and states the difference; the original is kept for audit. Amounts collected or paid settle through the payment arrangements described in Payments Endpoints. Dispute a statement within the period the Franchise Fees & Royalties Policy allows, citing the statement id and the line in question.

Errors

Status	Code	Cause
403	location_forbidden	The location belongs to a different franchise account
404	not_found	No location, agreement, or statement with that identifier exists on your account
422	invalid_period	A statement filter's date range is malformed or reversed

Error bodies follow Error Codes. Questions about a franchise account: support@aapawz.com.