Proformas

Get a proforma

Returns a proforma by its identifier, the same card as GET /api/v1/proformas: number, lifecycle and commercial status, customer, source order, project, currency and amounts.

GET

/api/v1/proformas/{proformaId}

curl https://app.filmo.io/api/v1/proformas/prof_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/proformas/prof_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/proformas/prof_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "proforma_9f3a2b",
    "proformaNumber": "2026-0001",
    "status": "Example status",
    "operativeStatus": "Example operative status",
    "issueDate": "2026-09-01T08:00:00.000Z",
    "currency": "EUR",
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "orderId": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "projectId": "project_9f3a2b",
    "subTotal": "120.00",
    "discountTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "totalPaid": "120.00",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "invoices:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

It shares scope with invoices because a proforma is the invoice that is not one yet.

Authorizations

Bearer API key with the scope below. invoices:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

proformaIdstringRequired

Proforma identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: ProformaDto

Envelope: ProformaResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

Proforma: the advance invoice that is not yet an invoice.

Show child attributes

data.idstring

Proforma identifier.

data.proformaNumberstring | null

Proforma number; null while it is a draft.

data.statusstring

Document lifecycle status.

data.operativeStatusstring | null

Commercial status: pending (awaiting an answer), confirmed (accepted by the customer) or cancelled; null if not recorded.

data.issueDatestring<date-time> | null

Issue date in ISO 8601 UTC; null while it has none.

data.currencystring

Currency of the amounts, as an ISO 4217 code.

data.contactobject | null

Contact the proforma is issued to; null if not recorded.

Show child attributes

data.contact.idstring

Contact identifier.

data.contact.namestring

Contact name.

data.orderIdstring | null

Source order of the proforma; null if it does not come from one.

data.orderNumberstring | null

Number of that order; null if it does not come from one.

data.projectIdstring | null

Project linked to the proforma; null if none.

data.subTotalstring

Subtotal before discounts and taxes, as a decimal string.