---
title: "List project prepayments"
method: GET
path: "/project-prepayments"
tags: ["Project Prepayments"]
---

# List project prepayments

`GET /project-prepayments`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/project-prepayments`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `projectId` string

## Response `200`

200

- object
  - `results` ProjectPrepayment[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `type` 'services' | 'expenses' | 'products' | 'other_items': The category of fees this prepayment is applied against.
    - `date` string, date: The date of the prepayment. Will be in the form YYYY-MM-DD.
    - `details` string: A description of the prepayment.
    - `quantity` number, nullable: The quantity used to calculate the `fee`. `null` when the `fee` was entered directly.
    - `rate` number, nullable: The rate used to calculate the `fee`. `null` when the `fee` was entered directly.
    - `fee` number: The total prepaid amount available to offset future fees.
    - `createdAt` string, date-time: The timestamp when the object was created.
    - `project` object: The project this prepayment belongs to.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the project.
      - `client` object: The client associated with the project.
        - `id` string: The unique identifier for the object.
        - `name` string: The name of the client.
    - `invoiceItem` object: The invoice item the prepayment is billed and offset against.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the invoice item.
    - `amountUsed` number: The portion of the `fee` already consumed to offset fees on issued invoices. This is a calculated value.
    - `invoiced` boolean: Whether the prepayment has been added to an invoice.
    - `locked` boolean: Whether the prepayment can no longer be modified because it is on an invoice or has been used to offset fees.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400

---

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