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

List transactions

Request

Retrieve financial transactions with comprehensive filtering

Security
ApiKeyAuth
Query
typeArray of strings

Filter by transaction type

Items Enum"bank.deposit""bank.withdrawal""bank.ach""bank.wire""card.spend""card.payment""card.dispute""card.refund""card.cashback"
Example: type=card.spend
statusArray of strings

Filter by transaction status

Items Enum"posted""pending""void"
Example: status=posted
subStatusArray of strings

Filter by transaction sub-status

Items Enum"settled""refund""reverse""rejected"
Example: subStatus=settled
projectIdstring or Array of strings

Filter by project ID(s)

Example: projectId=nike-swoosh-commercial
One of:
string
sourceTypestring or Array of strings

Filter by source type

Example: sourceType=card
One of:
string
sourceNamestring or Array of strings

Filter by source name

Example: sourceName=Amex 001
One of:
string
sourceLast4string or Array of strings

Filter by source last 4 digits

Example: sourceLast4=4242
One of:
string
descriptionstring

Filter by transaction description

Example: description=Camera rental
merchantstring

Filter by merchant name

Example: merchant=B&H Photo
contactTitlestring

Filter by contact title

Example: contactTitle=Producer
hasAccountboolean

Filter by account assignment

Example: hasAccount=true
isActualizedboolean

Filter by actualization status

hasAttachmentsboolean

Filter by whether attachments are present

Example: hasAttachments=true
hasContactboolean

Filter by contact presence

Example: hasContact=true
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
expandsArray of strings

Include related data in the response

Items Enum"project""contact""account""actual""attachments"
Example: expands=project&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/transactions?type=card.spend&status=posted&subStatus=settled&projectId=nike-swoosh-commercial&sourceType=card&sourceName=Amex+001&sourceLast4=4242&description=Camera+rental&merchant=B%26H+Photo&contactTitle=Producer&hasAccount=true&isActualized=true&hasAttachments=true&hasContact=true&startDate=2024-01-01&endDate=2024-01-31&expands=project%2Cattachments&idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

List of transactions

Bodyapplication/json
transactionsArray of objects(Transaction)
Response
application/json
{
  "transactions": [
    { … }
  ]
}

Get transaction

Request

Retrieve a specific transaction by ID

Security
ApiKeyAuth
Path
transactionIdstringrequired

Transaction identifier

Example: txn-abc-123
Query
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/transactions/txn-abc-123?idMode=user' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Transaction details

Bodyapplication/json
idstringrequired

Transaction identifier

Example: "txn-abc-123"
typestringrequired

Transaction type

Enum"bank.deposit""bank.withdrawal""bank.ach""bank.wire""card.spend""card.payment""card.dispute""card.refund""card.cashback"
Example: "card.spend"
statusstringrequired

Transaction status

Enum"posted""pending""void"
Example: "posted"
subStatusstring or null

Transaction sub-status

Enum"settled""refund""reverse""rejected"
Example: "settled"
descriptionstringrequired

Transaction description

Example: "ARRI RENTAL HOUSE"
amountnumber(float)required

Transaction amount

Example: 599.88
datestring(date-time)required

Transaction date

Example: "2024-03-18T16:00:00Z"
projectIdstring or null

Associated project ID

Example: "nike-swoosh-commercial"
hasAccountbooleanrequired

Whether transaction has account assignment

Example: true
isActualizedbooleanrequired

Whether transaction has been converted to actual

Example: false
sourceobject(TransactionSource)
attachmentsArray of objects(File)

Attached files

contactobject(Contact)
projectobject(Project)
accountobject(BudgetLine)
actualobject(Actual)
Response
application/json
{
  "id": "txn-abc-123",
  "type": "card.spend",
  "status": "posted",
  "subStatus": "settled",
  "description": "ARRI RENTAL HOUSE",
  "amount": 599.88,
  "date": "2024-03-18T16:00:00Z",
  "projectId": "nike-swoosh-commercial",
  "hasAccount": true,
  "isActualized": false,
  "source": {
    "id": "src-card-001",
    "type": "card",
    "name": "Production Company Card",
    "last4": "4242"
  },
  "attachments": [
    { … }
  ],
  "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": { … }
  },
  "project": {
    "id": "nike-swoosh-commercial",
    "name": "Nike Swoosh Commercial",
    "icon": "☀️",
    "imageUrl": "https://example.com/project-banner.jpg",
    "spaceId": "commercial-productions",
    "space": { … },
    "templateId": "commercial-template",
    "template": { … },
    "status": "active",
    "labels": [ … ],
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-03-20T14:30:00Z"
  },
  "account": {
    "type": "line",
    "id": "line-001",
    "accountId": "2150",
    "description": "RED Camera Package Rental",
    "path": "/production/equipment/cameras",
    "totals": { … },
    "tags": [ … ],
    "contact": { … },
    "phaseData": { … }
  },
  "actual": {
    "id": "actual-001",
    "description": "Camera rental for shoot days",
    "amount": 5250,
    "date": "2024-03-15T12:00:00Z",
    "accountId": "string",
    "expanded": false,
    "type": "invoice",
    "attachments": [ … ],
    "ref": "INV-2024-0315",
    "payId": "pay-xyz-789",
    "status": "completed",
    "notes": "Q1 advertising budget",
    "tags": [ … ],
    "purchaseOrderId": "po-2024-001",
    "transactionId": "txn-abc-123",
    "contact": { … },
    "subactuals": [ … ],
    "account": { … }
  }
}

Update transaction

Request

Update an existing transaction

Security
ApiKeyAuth
Path
transactionIdstringrequired

Transaction identifier

Example: txn-abc-123
Bodyapplication/jsonrequired
projectIdstring

Associated project ID

Example: "nike-swoosh-commercial"
accountIdstring

Associated account ID

Example: "/production/equipment"
contactIdstring

Associated contact ID

Example: "contact-studio-001"
descriptionstring

Transaction description

Example: "ARRI RENTAL - Equipment"
notesstring

Additional notes

Example: "Camera and lighting equipment for week 2"
curl -i -X PUT \
  https://api.saturation.io/api/v1/transactions/txn-abc-123 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "projectId": "nike-swoosh-commercial",
    "accountId": "/production/equipment",
    "contactId": "contact-studio-001",
    "description": "ARRI RENTAL - Equipment",
    "notes": "Camera and lighting equipment for week 2"
  }'

Responses

Transaction updated successfully

Bodyapplication/json
idstringrequired

Transaction identifier

Example: "txn-abc-123"
typestringrequired

Transaction type

Enum"bank.deposit""bank.withdrawal""bank.ach""bank.wire""card.spend""card.payment""card.dispute""card.refund""card.cashback"
Example: "card.spend"
statusstringrequired

Transaction status

Enum"posted""pending""void"
Example: "posted"
subStatusstring or null

Transaction sub-status

Enum"settled""refund""reverse""rejected"
Example: "settled"
descriptionstringrequired

Transaction description

Example: "ARRI RENTAL HOUSE"
amountnumber(float)required

Transaction amount

Example: 599.88
datestring(date-time)required

Transaction date

Example: "2024-03-18T16:00:00Z"
projectIdstring or null

Associated project ID

Example: "nike-swoosh-commercial"
hasAccountbooleanrequired

Whether transaction has account assignment

Example: true
isActualizedbooleanrequired

Whether transaction has been converted to actual

Example: false
sourceobject(TransactionSource)
attachmentsArray of objects(File)

Attached files

contactobject(Contact)
projectobject(Project)
accountobject(BudgetLine)
actualobject(Actual)
Response
application/json
{
  "id": "txn-abc-123",
  "type": "card.spend",
  "status": "posted",
  "subStatus": "settled",
  "description": "ARRI RENTAL HOUSE",
  "amount": 599.88,
  "date": "2024-03-18T16:00:00Z",
  "projectId": "nike-swoosh-commercial",
  "hasAccount": true,
  "isActualized": false,
  "source": {
    "id": "src-card-001",
    "type": "card",
    "name": "Production Company Card",
    "last4": "4242"
  },
  "attachments": [
    { … }
  ],
  "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": { … }
  },
  "project": {
    "id": "nike-swoosh-commercial",
    "name": "Nike Swoosh Commercial",
    "icon": "☀️",
    "imageUrl": "https://example.com/project-banner.jpg",
    "spaceId": "commercial-productions",
    "space": { … },
    "templateId": "commercial-template",
    "template": { … },
    "status": "active",
    "labels": [ … ],
    "createdAt": "2024-01-15T10:00:00Z",
    "updatedAt": "2024-03-20T14:30:00Z"
  },
  "account": {
    "type": "line",
    "id": "line-001",
    "accountId": "2150",
    "description": "RED Camera Package Rental",
    "path": "/production/equipment/cameras",
    "totals": { … },
    "tags": [ … ],
    "contact": { … },
    "phaseData": { … }
  },
  "actual": {
    "id": "actual-001",
    "description": "Camera rental for shoot days",
    "amount": 5250,
    "date": "2024-03-15T12:00:00Z",
    "accountId": "string",
    "expanded": false,
    "type": "invoice",
    "attachments": [ … ],
    "ref": "INV-2024-0315",
    "payId": "pay-xyz-789",
    "status": "completed",
    "notes": "Q1 advertising budget",
    "tags": [ … ],
    "purchaseOrderId": "po-2024-001",
    "transactionId": "txn-abc-123",
    "contact": { … },
    "subactuals": [ … ],
    "account": { … }
  }
}

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

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