Create a project prepayment

curl --request POST \
  --url https://www.ruddr.io/api/workspace/project-prepayments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2023-12-25",
  "details": "<string>",
  "projectId": "<string>",
  "invoiceItemId": "<string>",
  "quantity": 123,
  "rate": 123,
  "fee": 123
}
'

import requests

url = "https://www.ruddr.io/api/workspace/project-prepayments"

payload = {
    "date": "2023-12-25",
    "details": "<string>",
    "projectId": "<string>",
    "invoiceItemId": "<string>",
    "quantity": 123,
    "rate": 123,
    "fee": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2023-12-25',
    details: '<string>',
    projectId: '<string>',
    invoiceItemId: '<string>',
    quantity: 123,
    rate: 123,
    fee: 123
  })
};

fetch('https://www.ruddr.io/api/workspace/project-prepayments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ruddr.io/api/workspace/project-prepayments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'date' => '2023-12-25',
    'details' => '<string>',
    'projectId' => '<string>',
    'invoiceItemId' => '<string>',
    'quantity' => 123,
    'rate' => 123,
    'fee' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ruddr.io/api/workspace/project-prepayments"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"details\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"invoiceItemId\": \"<string>\",\n  \"quantity\": 123,\n  \"rate\": 123,\n  \"fee\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.ruddr.io/api/workspace/project-prepayments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"details\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"invoiceItemId\": \"<string>\",\n  \"quantity\": 123,\n  \"rate\": 123,\n  \"fee\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ruddr.io/api/workspace/project-prepayments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2023-12-25\",\n  \"details\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"invoiceItemId\": \"<string>\",\n  \"quantity\": 123,\n  \"rate\": 123,\n  \"fee\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": "7f3e1a2d-94b8-4c6e-b3f1-d52a8e0c7b94",
  "type": "services",
  "date": "2026-05-01",
  "details": "Retainer for Q2 advisory services",
  "quantity": 40,
  "rate": 250,
  "fee": 10000,
  "createdAt": "2026-04-15T14:08:33.512Z",
  "project": {
    "id": "d077258e-2158-4f34-aabd-97e971d0c18d",
    "name": "Cloud Infrastructure Services",
    "client": {
      "id": "aa39afdb-e168-4956-b061-41c7c62e8c2e",
      "name": "Paul's Boutique"
    }
  },
  "invoiceItem": {
    "id": "aba04832-216c-463e-8998-c520948f707c",
    "name": "Consulting Services"
  },
  "amountUsed": 0,
  "invoiced": false,
  "locked": false
}

POST

project-prepayments

Create a project prepayment

curl --request POST \
  --url https://www.ruddr.io/api/workspace/project-prepayments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2023-12-25",
  "details": "<string>",
  "projectId": "<string>",
  "invoiceItemId": "<string>",
  "quantity": 123,
  "rate": 123,
  "fee": 123
}
'

import requests

url = "https://www.ruddr.io/api/workspace/project-prepayments"

payload = {
    "date": "2023-12-25",
    "details": "<string>",
    "projectId": "<string>",
    "invoiceItemId": "<string>",
    "quantity": 123,
    "rate": 123,
    "fee": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    date: '2023-12-25',
    details: '<string>',
    projectId: '<string>',
    invoiceItemId: '<string>',
    quantity: 123,
    rate: 123,
    fee: 123
  })
};

fetch('https://www.ruddr.io/api/workspace/project-prepayments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.ruddr.io/api/workspace/project-prepayments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'date' => '2023-12-25',
    'details' => '<string>',
    'projectId' => '<string>',
    'invoiceItemId' => '<string>',
    'quantity' => 123,
    'rate' => 123,
    'fee' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.ruddr.io/api/workspace/project-prepayments"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"details\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"invoiceItemId\": \"<string>\",\n  \"quantity\": 123,\n  \"rate\": 123,\n  \"fee\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://www.ruddr.io/api/workspace/project-prepayments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"details\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"invoiceItemId\": \"<string>\",\n  \"quantity\": 123,\n  \"rate\": 123,\n  \"fee\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.ruddr.io/api/workspace/project-prepayments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"date\": \"2023-12-25\",\n  \"details\": \"<string>\",\n  \"projectId\": \"<string>\",\n  \"invoiceItemId\": \"<string>\",\n  \"quantity\": 123,\n  \"rate\": 123,\n  \"fee\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "id": "7f3e1a2d-94b8-4c6e-b3f1-d52a8e0c7b94",
  "type": "services",
  "date": "2026-05-01",
  "details": "Retainer for Q2 advisory services",
  "quantity": 40,
  "rate": 250,
  "fee": 10000,
  "createdAt": "2026-04-15T14:08:33.512Z",
  "project": {
    "id": "d077258e-2158-4f34-aabd-97e971d0c18d",
    "name": "Cloud Infrastructure Services",
    "client": {
      "id": "aa39afdb-e168-4956-b061-41c7c62e8c2e",
      "name": "Paul's Boutique"
    }
  },
  "invoiceItem": {
    "id": "aba04832-216c-463e-8998-c520948f707c",
    "name": "Consulting Services"
  },
  "amountUsed": 0,
  "invoiced": false,
  "locked": false
}

A prepayment invoiced up front to offset future fees on a project. All prepayments of a given type on a project bill against the same invoice item.

Authorizations

Authorization

string

header

required

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

Body

application/json

type

enum<string>

required

The category of fees this prepayment is applied against.

Available options:

services,

expenses,

products,

other_items

date

string<date>

required

The date of the prepayment. Must be in the form YYYY-MM-DD.

details

string

required

A description of the prepayment (max 255 chars).

projectId

string

required

The project ID (uuid) for this prepayment.

invoiceItemId

string

required

The invoice item ID (uuid) for this prepayment. All prepayments of the same type on a project must use the same invoice item.

quantity

number | null

The quantity for calculating the fee. Required when rate is provided.

rate

number | null

The rate for calculating the fee. Required when quantity is provided.

fee

number

The total prepaid amount. Required when quantity and rate are not provided.

Response

200

string

The unique identifier for the object.

type

enum<string>

The category of fees this prepayment is applied against.

Available options:

services,

expenses,

products,

other_items

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 | null

The quantity used to calculate the fee. null when the fee was entered directly.

rate

number | null

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.

Show child attributes

invoiceItem

object

The invoice item the prepayment is billed and offset against.

Show child attributes

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.

⌘I

Projects

Time

Pipeline

Expenses

Resourcing

Billing

Workspace

Members

Custom Data

Create a project prepayment

Authorizations

Body

Response