Skip to content

⚒️ API Reference (1.0.0)

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

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

List purchase orders

Request

Retrieve purchase orders for a project

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
Query
accountIdstring or Array of strings

Filter by account ID(s) or codes

Example: accountId=2150
One of:
string
startDatestring(date-time)

Return results on or after this date (ISO 8601)

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

Return results on or before this date (ISO 8601)

Example: endDate=2024-01-31
hasAttachmentsboolean

Filter by whether attachments are present

Example: hasAttachments=true
statusstring or Array of strings

Filter by purchase order status

Example: status=approved&status=pending
One of:
string
Enum"draft""approved""rejected""pending""paid"
expandsArray of strings

Include related data in the response

Items Enum"contact""actuals""items""items.account"
Example: expands=contact&expands=purchaseOrderItems
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/purchaseOrders?accountId=2150&startDate=2024-01-01&endDate=2024-01-31&hasAttachments=true&status=approved%2Cpending&expands=contact%2CpurchaseOrderItems&idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of purchase orders

Bodyapplication/json
purchaseOrdersArray of objects(PurchaseOrder)required
purchaseOrders[].​idstringrequired

Purchase order identifier

Example: "po-2024-001"
purchaseOrders[].​purchaseOrderIdstring or null

Purchase order number

Example: "PO-NIKE-2024-001"
purchaseOrders[].​titlestring or null

Purchase order title

Example: "Camera Equipment Rental"
purchaseOrders[].​datestring or null(date-time)

Purchase order date

Example: "2024-03-15T12:00:00Z"
purchaseOrders[].​amountnumber(float)required

Total amount

Example: 25000
purchaseOrders[].​paidAmountnumber(float)required

Amount paid

Example: 12500
purchaseOrders[].​statusstringrequired

Purchase order status

Enum"draft""approved""rejected""pending""paid"
Example: "approved"
purchaseOrders[].​attachmentsArray of objects(File)

Attached files

purchaseOrders[].​notesstring or null

Additional notes

Example: "Equipment rental for 3-day shoot at downtown location"
purchaseOrders[].​itemsArray of objects(PurchaseOrderItem)

Line items

purchaseOrders[].​contactobject(Contact)
purchaseOrders[].​actualsArray of objects(Actual)

Associated actual entries

Response
application/json
{
  "purchaseOrders": [
    { … }
  ]
}

Get purchase order

Request

Retrieve a specific purchase order

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
purchaseOrderIdstringrequired

Purchase order identifier (alias or ID)

Example: po-2024-001
Query
expandsArray of strings

Include related data in the response

Items Enum"contact""actuals""items""items.account"
Example: expands=contact&expands=purchaseOrderItems.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/purchaseOrders/po-2024-001?expands=contact%2CpurchaseOrderItems.account&idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Purchase order details

Bodyapplication/json
idstringrequired

Purchase order identifier

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

Purchase order number

Example: "PO-NIKE-2024-001"
titlestring or null

Purchase order title

Example: "Camera Equipment Rental"
datestring or null(date-time)

Purchase order date

Example: "2024-03-15T12:00:00Z"
amountnumber(float)required

Total amount

Example: 25000
paidAmountnumber(float)required

Amount paid

Example: 12500
statusstringrequired

Purchase order status

Enum"draft""approved""rejected""pending""paid"
Example: "approved"
attachmentsArray of objects(File)

Attached files

notesstring or null

Additional notes

Example: "Equipment rental for 3-day shoot at downtown location"
itemsArray of objects(PurchaseOrderItem)

Line items

contactobject(Contact)
actualsArray of objects(Actual)

Associated actual entries

Response
application/json
{
  "id": "po-2024-001",
  "purchaseOrderId": "PO-NIKE-2024-001",
  "title": "Camera Equipment Rental",
  "date": "2024-03-15T12:00:00Z",
  "amount": 25000,
  "paidAmount": 12500,
  "status": "approved",
  "attachments": [
    { … }
  ],
  "notes": "Equipment rental for 3-day shoot at downtown location",
  "items": [
    { … }
  ],
  "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,
    "secureInfo": { … },
    "origin": { … },
    "startwork": [ … ],
    "linkedUser": { … },
    "bankInfo": [ … ],
    "taxDocuments": [ … ],
    "attachments": [ … ],
    "projects": { … }
  },
  "actuals": [
    { … }
  ]
}

Create purchase order

Request

Create a new purchase order for a project

Security
ApiKeyAuth
Path
projectIdstringrequired

Project identifier (alias or ID)

Example: nike-spring-2024
purchaseOrderIdstringrequired

Purchase order identifier (alias or ID)

Example: po-2024-001
Bodyapplication/jsonrequired
purchaseOrderIdstring

Purchase order number

Example: "PO-NIKE-2024-002"
titlestring

Purchase order title

Example: "Lighting Equipment Rental"
datestring(date-time)

Purchase order date

Example: "2024-03-20T14:30:00Z"
amountnumber(float)required

Total amount

Example: 35000
statusstring

Purchase order status

Enum"draft""approved""rejected""pending""paid"
Example: "draft"
notesstring

Additional notes

Example: "LED panel rental for night shoots"
contactIdstring

Associated contact ID

Example: "contact-studio-001"
itemsArray of objects(CreatePurchaseOrderItemInput)

Line items

curl -i -X POST \
  https://api.saturation.io/api/v1/projects/nike-spring-2024/purchaseOrders/po-2024-001 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "purchaseOrderId": "PO-NIKE-2024-002",
    "title": "Lighting Equipment Rental",
    "date": "2024-03-20T14:30:00Z",
    "amount": 35000,
    "status": "draft",
    "notes": "LED panel rental for night shoots",
    "contactId": "contact-studio-001",
    "items": [
      {
        "description": "ARRI SkyPanel S60-C LED Light",
        "quantity": 4,
        "unitPrice": 500,
        "totalPrice": 2000,
        "accountId": "/production/lighting"
      }
    ]
  }'

Responses

Purchase order created successfully

Bodyapplication/json
idstringrequired

Purchase order identifier

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

Purchase order number

Example: "PO-NIKE-2024-001"
titlestring or null

Purchase order title

Example: "Camera Equipment Rental"
datestring or null(date-time)

Purchase order date

Example: "2024-03-15T12:00:00Z"
amountnumber(float)required

Total amount

Example: 25000
paidAmountnumber(float)required

Amount paid

Example: 12500
statusstringrequired

Purchase order status

Enum"draft""approved""rejected""pending""paid"
Example: "approved"
attachmentsArray of objects(File)

Attached files

notesstring or null

Additional notes

Example: "Equipment rental for 3-day shoot at downtown location"
itemsArray of objects(PurchaseOrderItem)

Line items

contactobject(Contact)
actualsArray of objects(Actual)

Associated actual entries

Response
application/json
{
  "id": "po-2024-001",
  "purchaseOrderId": "PO-NIKE-2024-001",
  "title": "Camera Equipment Rental",
  "date": "2024-03-15T12:00:00Z",
  "amount": 25000,
  "paidAmount": 12500,
  "status": "approved",
  "attachments": [
    { … }
  ],
  "notes": "Equipment rental for 3-day shoot at downtown location",
  "items": [
    { … }
  ],
  "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,
    "secureInfo": { … },
    "origin": { … },
    "startwork": [ … ],
    "linkedUser": { … },
    "bankInfo": [ … ],
    "taxDocuments": [ … ],
    "attachments": [ … ],
    "projects": { … }
  },
  "actuals": [
    { … }
  ]
}

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