Skip to content

⚒️ API Reference (1.0.1)

The Saturation API lets you work with your workspace data including projects, budgets, actuals, contacts, purchase orders, and attachments.

It is built for real-time collaboration and automation so you can connect it to your internal tools or third-party systems. Any changes you make through the API appear instantly in the web app.

With it, you can:

  • Create, update, and organize projects and phases
  • Build and track multi-phase budgets
  • Sync actuals and purchase orders
  • Manage contacts and crew
  • Upload, retrieve, and organize attachments

🔑 Authentication

GET /api/v1/projects
X-API-Key: YOUR_API_KEY


đź“Š Get everything in one call

GET /projects/my-film/budget?expands[]=phases&expands[]=fringes&expands[]=lines.contact&expands[]=lines.phaseData

Returns the complete budget with all related records, no extra roundtrips.

🏷️ Use your existing codes

GET /projects/my-film/budget/line/1100-LABOR    # Your account code
GET /projects/my-film/budget/phases/estimate    # Your phase name
POST /projects/my-film/actuals                  # Create with your codes
{
  "lineItemId": "2150-CAMERA",
  "amount": 5000
}

The API speaks your language. Use the same codes from your accounting system.

🔄 Common patterns

# Get recent actuals with full details
GET /projects/my-film/actuals?date=2024-03-14&expands[]=contact&expands[]=attachments

# Create a purchase order
POST /projects/my-film/purchase-orders
{
  "number": "PO-001",
  "contactId": "contact-123",
  "items": [{"lineItemId": "2150", "amount": 35000}]
}

# Export complete budget for accounting
GET /projects/my-film/budget?expands[]=phases&expands[]=fringes&expands[]=globals


đź’ˇ Pro tips

  • Create multiple budget lines in one POST to /budget
  • Use tags liberally—they're your flexible second dimension
  • Combine accountId, tags, and date filters for precise queries
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://support.saturation.io

License

Proprietary

Languages
Servers
Production server

https://api.saturation.io/api/v1/

Projects

Create and manage productions, campaigns, or jobs.
Each project has its own budget, actuals, and purchase orders.
Use idMode=user to reference projects by alias (e.g., "nike-spring-2024") instead of system IDs.

Operations

Contacts

Keep crew, contractors, and clients in one workspace-wide directory.
Link contacts to budget lines for automatic contact assignment.
Store tax info and rate cards for quick reuse across projects.

Operations

Rates

Define workspace-wide rate cards for consistent budgeting.
Set crew rates, equipment packages, and standard costs in multiple currencies.
Supports automatic fringe calculations.

Operations

Transactions

Import raw bank and card data, match to contacts, and convert to actuals.
Maintains a full audit trail from bank statement to budget line.

Operations

Budget

Build hierarchical budgets with accounts, line items, subtotals, and markups.
Use expands[]=phases&expands[]=fringes&expands[]=globals&expands[]=lines.contact&expands[]=lines.phaseData
to fetch complete budget data in one call.
Reference budget lines by account code (e.g., "1100-LABOR") with idMode=user.

Operations

Budget - Accounts

List all the budget accounts with children (i.e. Expanded Accounts)

Operations

Budget - Phases

Manage multiple budget versions (estimate, working, actual, committed).
Create rollup phases to auto-calculate variances.
Each phase supports its own currency.
Reference by name (e.g., "estimate") with idMode=user.

Operations

Budget - Fringes

Define payroll taxes and benefits (FICA, insurance, workers comp, etc.) once,
then auto-apply to all labor line items. Supports % or flat rates with salary cutoffs.

Operations

Budget - Globals

Set project-wide variables (e.g., exchange rates, shoot days, overhead %)
for use in formulas. Updating globals auto-recalculates dependent lines.

Operations

Actuals

Log real expenses from credit cards, manual entry, or converted POs.
Use expands[]=contact&expands[]=attachments to include contact details and receipts.
Split costs across multiple budget categories.

Operations

List actuals

Request

Retrieve actual spending data for a project

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
Query
accountIdstring or Array of strings
Example: accountId=2150
One of:
string
startDatestring(date-time)

Return results on or after this date (ISO 8601)

Example: startDate=2024-01-01T00:00:00Z
endDatestring(date-time)

Return results on or before this date (ISO 8601)

Example: endDate=2024-01-31T23:59:59Z
hasAttachmentsboolean

Filter by whether attachments are present

Example: hasAttachments=true
hasAssignedAccountboolean

Filter by whether an account is assigned

Example: hasAssignedAccount=true
hasLinkedTransactionboolean

Filter by presence of linked transactions

sourceIdsArray of strings

Filter by source IDs

Example: sourceIds=txn-123
expandsArray of strings

Include related data in the response

Items Enum"contact""subactual""account""subactual.account"
Example: expands=contact&expands=attachments
idModestring

ID interpretation mode. Controls how path and query parameter IDs (like lineId, accountId, phaseId) are interpreted - 'user' for human-readable IDs (account codes, phase names), 'system' for database IDs (UUIDs/nanoids). Also affects the format of IDs in responses.

Default "user"
Enum"user""system"
Example: idMode=user
curl -i -X GET \
  'https://api.saturation.io/api/v1/projects/nike-spring-2024/actuals?accountId=2150&startDate=2024-01-01T00%3A00%3A00Z&endDate=2024-01-31T23%3A59%3A59Z&hasAttachments=true&hasAssignedAccount=true&hasLinkedTransaction=true&sourceIds=txn-123&expands=contact%2Cattachments&idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of actuals

Bodyapplication/json
actualsArray of objects(Actual)
totalAmountnumber(float)
Example: 450000
Response
application/json
{
  "actuals": [
    { … }
  ],
  "totalAmount": 450000
}

Create actual

Request

Create a new actual entry for a project

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
Bodyapplication/jsonrequired
typestring
Enum"SaturationACH""SaturationPCard""SaturationWire""ACH""Cash""Check""CreditCard""Wire""ETransfer""Invoice"
Example: "Invoice"
descriptionstringrequired

Human-readable name for the actual entry

Example: "Camera rental invoice payment"
contactIdstring

Associated contact ID

Example: "contact-studio-001"
datestring(date-time)

Actual date (ISO 8601)

Example: "2024-03-25T11:00:00Z"
amountnumber(float)

Actual amount

Example: 7500
accountIdstring

Account ID or alias to assign the actual to

Example: "/production/camera"
statusstring
Enum"Unpaid""Pending""Paid""Refund""NeedsReview"
Example: "Pending"
notesstring

Additional notes

Example: "Week 1 camera rental"
numberstring

External reference number or user-supplied actual number

Example: "ACT-2024-0315"
tagsArray of strings

Associated tags

Example: ["equipment","week-1"]
payIdstring

Payment identifier

Example: "pay-abc-456"
suggestedTotalnumber(float)

Suggested total amount for validation purposes

Example: 7500
splitboolean

Whether to create the actual in split mode with sub-actuals

Example: false
subActualsArray of objects(AddSubActualInput)

Sub-actual line items to create with the parent actual

afterstring

Position the new actual after the specified actual ID

Example: "actual-002"
beforestring

Position the new actual before the specified actual ID

Example: "actual-005"
curl -i -X POST \
  https://api.saturation.io/api/v1/projects/nike-spring-2024/actuals \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "type": "Invoice",
    "description": "Camera rental invoice payment",
    "contactId": "contact-studio-001",
    "date": "2024-03-25T11:00:00Z",
    "amount": 7500,
    "accountId": "/production/camera",
    "status": "Pending",
    "notes": "Week 1 camera rental",
    "number": "ACT-2024-0315",
    "tags": [
      "equipment",
      "week-1"
    ],
    "payId": "pay-abc-456",
    "suggestedTotal": 7500,
    "split": false,
    "subActuals": [
      {
        "number": "SA-001",
        "description": "Weekly camera package rental",
        "amount": 3500,
        "accountId": "/production/camera",
        "notes": "Includes insurance add-on",
        "quantity": 5,
        "unit": "Hour",
        "rate": 700
      }
    ],
    "after": "actual-002",
    "before": "actual-005"
  }'

Responses

Actual created successfully

Bodyapplication/json
idstringrequired

Actual entry identifier

Example: "actual-001"
descriptionstring or null

Human-readable description of the actual entry

Example: "Camera rental for shoot days"
amountnumber or null(float)

Actual amount

Example: 5250
datestring or null(date-time)

Actual entry date

Example: "2024-03-15T12:00:00Z"
modestring(ActualMode)required

Mode of the actual transaction

Enum"default""split"
Example: "default"
accountId(string or null) or Array of strings
One of:

Associated account ID(s)

string or null
accountPath(string or null) or Array of strings
One of:

Account path(s) for the actual entry

string or null
typestring or null
Enum"SaturationACH""SaturationPCard""SaturationWire""ACH""Cash""Check""CreditCard""Wire""ETransfer""Invoice"
Example: "Invoice"
attachmentsArray of objects or null(File)

Attached files

refstring or null

Reference identifier

Example: "INV-2024-0315"
payIdstring or null

Payment identifier

Example: "pay-xyz-789"
statusstring or null
Enum"Unpaid""Pending""Paid""Refund""NeedsReview"
Example: "Pending"
notesstring or null

Additional notes

Example: "Q1 advertising budget"
tagsArray of strings

Associated tags

purchaseOrderIdstring or null

Associated purchase order ID

Example: "po-2024-001"
transactionIdstring or null

Associated transaction ID

Example: "txn-abc-123"
contactobject or null
subactualsArray of objects or null(SubActual)

Sub-actual line items

accountobject or null
lastModifiedstring(date-time)required

Last modification time (ISO 8601)

Example: "2024-03-15T14:30:00Z"
Response
application/json
{
  "id": "actual-001",
  "description": "Camera rental for shoot days",
  "amount": 5250,
  "date": "2024-03-15T12:00:00Z",
  "mode": "default",
  "accountId": "string",
  "accountPath": "string",
  "type": "Invoice",
  "attachments": [
    { … }
  ],
  "ref": "INV-2024-0315",
  "payId": "pay-xyz-789",
  "status": "Pending",
  "notes": "Q1 advertising budget",
  "tags": [
    "string"
  ],
  "purchaseOrderId": "po-2024-001",
  "transactionId": "txn-abc-123",
  "contact": {
    "id": "contact-studio-001",
    "contactTitle": "Sunset Studios - Production Company",
    "name": "Alex Rivera",
    "email": "alex.rivera@sunsetstudios.com",
    "company": "Sunset Studios Inc.",
    "type": "Person",
    "jobTitle": "Director of Photography",
    "rate": 150,
    "lastModified": "2024-03-15T14:30:00Z",
    "secureInfo": { … },
    "origin": { … },
    "startwork": [ … ],
    "linkedUser": { … },
    "bankInfo": [ … ],
    "taxDocuments": [ … ],
    "attachments": [ … ],
    "projects": { … }
  },
  "subactuals": [
    { … }
  ],
  "account": {
    "type": "line",
    "id": "line-001",
    "accountId": "2150",
    "description": "RED Camera Package Rental",
    "path": "/production/equipment/cameras",
    "totals": { … },
    "tags": [ … ],
    "contact": { … },
    "phaseData": { … },
    "lastModified": "2024-03-15T14:30:00Z"
  },
  "lastModified": "2024-03-15T14:30:00Z"
}

Get actual

Request

Retrieve a specific actual entry

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
actualIdstringrequired

Actual identifier (alias or ID)

Example: actual-001
Query
expandsArray of strings

Include related data in the response

Items Enum"contact""subactual""account""subactual.account"
Example: expands=contact&expands=account
idModestring

ID interpretation mode. Controls how path and query parameter IDs (like lineId, accountId, phaseId) are interpreted - 'user' for human-readable IDs (account codes, phase names), 'system' for database IDs (UUIDs/nanoids). Also affects the format of IDs in responses.

Default "user"
Enum"user""system"
Example: idMode=user
curl -i -X GET \
  'https://api.saturation.io/api/v1/projects/nike-spring-2024/actuals/actual-001?expands=contact%2Caccount&idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Actual details

Bodyapplication/json
idstringrequired

Actual entry identifier

Example: "actual-001"
descriptionstring or null

Human-readable description of the actual entry

Example: "Camera rental for shoot days"
amountnumber or null(float)

Actual amount

Example: 5250
datestring or null(date-time)

Actual entry date

Example: "2024-03-15T12:00:00Z"
modestring(ActualMode)required

Mode of the actual transaction

Enum"default""split"
Example: "default"
accountId(string or null) or Array of strings
One of:

Associated account ID(s)

string or null
accountPath(string or null) or Array of strings
One of:

Account path(s) for the actual entry

string or null
typestring or null
Enum"SaturationACH""SaturationPCard""SaturationWire""ACH""Cash""Check""CreditCard""Wire""ETransfer""Invoice"
Example: "Invoice"
attachmentsArray of objects or null(File)

Attached files

refstring or null

Reference identifier

Example: "INV-2024-0315"
payIdstring or null

Payment identifier

Example: "pay-xyz-789"
statusstring or null
Enum"Unpaid""Pending""Paid""Refund""NeedsReview"
Example: "Pending"
notesstring or null

Additional notes

Example: "Q1 advertising budget"
tagsArray of strings

Associated tags

purchaseOrderIdstring or null

Associated purchase order ID

Example: "po-2024-001"
transactionIdstring or null

Associated transaction ID

Example: "txn-abc-123"
contactobject or null
subactualsArray of objects or null(SubActual)

Sub-actual line items

accountobject or null
lastModifiedstring(date-time)required

Last modification time (ISO 8601)

Example: "2024-03-15T14:30:00Z"
Response
application/json
{
  "id": "actual-001",
  "description": "Camera rental for shoot days",
  "amount": 5250,
  "date": "2024-03-15T12:00:00Z",
  "mode": "default",
  "accountId": "string",
  "accountPath": "string",
  "type": "Invoice",
  "attachments": [
    { … }
  ],
  "ref": "INV-2024-0315",
  "payId": "pay-xyz-789",
  "status": "Pending",
  "notes": "Q1 advertising budget",
  "tags": [
    "string"
  ],
  "purchaseOrderId": "po-2024-001",
  "transactionId": "txn-abc-123",
  "contact": {
    "id": "contact-studio-001",
    "contactTitle": "Sunset Studios - Production Company",
    "name": "Alex Rivera",
    "email": "alex.rivera@sunsetstudios.com",
    "company": "Sunset Studios Inc.",
    "type": "Person",
    "jobTitle": "Director of Photography",
    "rate": 150,
    "lastModified": "2024-03-15T14:30:00Z",
    "secureInfo": { … },
    "origin": { … },
    "startwork": [ … ],
    "linkedUser": { … },
    "bankInfo": [ … ],
    "taxDocuments": [ … ],
    "attachments": [ … ],
    "projects": { … }
  },
  "subactuals": [
    { … }
  ],
  "account": {
    "type": "line",
    "id": "line-001",
    "accountId": "2150",
    "description": "RED Camera Package Rental",
    "path": "/production/equipment/cameras",
    "totals": { … },
    "tags": [ … ],
    "contact": { … },
    "phaseData": { … },
    "lastModified": "2024-03-15T14:30:00Z"
  },
  "lastModified": "2024-03-15T14:30:00Z"
}

Purchase Orders

Create commitments to contacts/vendors before they become actuals.
Track approvals, link to budget lines, and monitor committed vs actual spend.
Convert POs to actuals when invoiced.

Operations

Tags

Categorize beyond account structure—e.g., by shoot day, location, department.
Use tags to run cross-budget reports and track spend across multiple categories.

Operations

Files

Upload receipts, contracts, and documents.
Attach files to actuals, POs, and projects.
Supports batch uploads and direct URL access.

Operations

Public Rates

Browse and use verified industry rate cards from the Saturation community.
Great for starting points or pricing validation.
Read-only access to rates from production companies, unions, and contractors.

Operations

Spaces

Group projects into folders for better organization.
Supports nested hierarchies (e.g., by client, year, or production type).

Operations

Comments

Add notes and discussions directly on budget lines.
Track approvals and changes with timestamps—context stays intact across phases.

Operations