---
title: "Who hasn't paid"
method: GET
path: "/v1/business/unpaid"
tags: ["Run"]
---

# Who hasn't paid

`GET /v1/business/unpaid`

## Request

- Base URL: `https://api.nogpets.com`
- URL: `https://api.nogpets.com/v1/business/unpaid`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.nogpets.com/oauth/authorize`, token URL `https://api.nogpets.com/oauth/token`, scopes: `business:manage`)
  - HTTP bearer

Bookings in a period (default this week) not paid yet: card bookings not paid or failed, and cash not marked received; and invoice links still open (openInvoices). Needs business:manage; the signed-in person must be an owner, manager or staff member of an approved NogPets business (bizId only if they run more than one).

## Query parameters

- `bizId` string
- `period` 'today' | 'this_week' | 'last_week' | 'next_7_days' | 'this_month' | 'last_month': A period in the business's own time zone; weeks run Monday to Sunday.
- `from` string: A local date, YYYY-MM-DD.
- `to` string: A local date, YYYY-MM-DD.

## Response `200`

OK

- BizUnpaid
  - `business` BizRef
    - `bizId` string
    - `name` string
    - `role` string: owner, manager or crew (staff).
    - `country` string
    - `countryName` string
    - `currency` string
    - `timezone` string
    - `canTakeBookings` boolean: False outside South Africa for now: bookings there aren't taken through NogPets.
  - `from` string
  - `to` string
  - `count` integer
  - `total` string
  - `bookings` object[], required
    - `id` string
    - `when` string: Local day and time.
    - `start` string, date-time
    - `end` string, date-time
    - `status` 'PENDING' | 'ACCEPTED' | 'REJECTED' | 'CANCELLED' | 'COMPLETED'
    - `category` string
    - `resourceId` string
    - `resource` string
    - `client` object
      - `id` string: clientId for get_client.
      - `name` string
      - `phone` string
    - `what` string: Pets and services.
    - `address` string
    - `mapUrl` string, nullable: The address on Google Maps.
    - `notes` string
    - `paymentMethod` string
    - `paymentStatus` 'PENDING' | 'PAID' | 'CASH_DUE' | 'CASH_RECEIVED' | 'REFUND_REQUESTED' | 'REFUNDED' | 'FAILED'
    - `total` string
    - `totalCents` integer
    - `unpaid` boolean
    - `source` string
    - `overdue` boolean
    - `owes` string
  - `openInvoices` object[]: Invoice links (create_invoice_link) not paid yet and not expired.
    - `invoiceId` string
    - `description` string
    - `clientName` string, nullable
    - `total` string
    - `paymentStatus` string
    - `expiresAt` string
  - `next` string

## Other responses

- `400`: The input is wrong (`INVALID_ARGUMENT`, or a pricing code such as `ONE_PRIMARY`, `PET_TYPE`, `UNKNOWN_SERVICE`).
- `401`: No token, or it's expired or revoked. The `WWW-Authenticate` header points at the resource metadata.
- `403`: The token lacks a scope (`INSUFFICIENT_SCOPE`, with `details.scope`).
- `404`: Not found, or not the person's.
- `409`: A rule said no: `NO_COVERAGE`, `NO_AVAILABILITY`, `SLOT_TAKEN`, `TOO_LATE`, `CONFIRM_REQUIRED` (with `details.summary`), `NOTHING_TO_PAY`, `SHOP_OFF`, `STOCK`, `SHIPPING`, `DISCOUNT`, `CASH`, `FAILED_PRECONDITION`; business sign-up: `UNDER_REVIEW`, `APPROVED`, `NOT_READY`, `TOO_MANY`, `LISTING_TAKEN`, `PAYFAST_ZA_ONLY`. `NO_COVERAGE` carries `details.leadId`, `details.message` (tell the person) and `details.next`.

---

[API](https://skmtc.dev/nogpets/apis/nogpets-api.md) · [All operations](https://skmtc.dev/nogpets/apis/nogpets-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nogpets/apis/nogpets-api/revisions/a202c1012173?raw)