Invoices

Get an invoice

Returns the detail of an invoice by its identifier.

GET

/api/v1/invoices/{invoiceId}

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

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

{
  "data": {
    "id": "invoice_9f3a2b",
    "invoiceNumber": "2026-0001",
    "status": "draft",
    "isRectification": true,
    "invoiceDate": "2026-09-01T08:00:00.000Z",
    "dueDate": "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",
    "paymentStatus": "unpaid",
    "paymentMethod": "Example payment method",
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z",
    "projectName": "Example project name",
    "taxBreakdown": [
      {
        "taxType": "120.00",
        "label": "Main",
        "rate": 1,
        "baseAmount": "120.00",
        "amount": "120.00"
      }
    ],
    "productDiscountTotal": "120.00",
    "globalDiscountTotal": "120.00",
    "insuranceTotal": "120.00",
    "depositTotal": "120.00",
    "exchangeRate": 1,
    "billingAddress": {
      "label": "Main",
      "addressLine1": "Calle de Ejemplo 12",
      "addressLine2": "Calle de Ejemplo 12",
      "city": "Madrid",
      "province": "Madrid",
      "postcode": "28001",
      "country": "ES"
    },
    "sourceQuoteIds": [
      "source_quote_9f3a2b"
    ],
    "sourceProformaIds": [
      "source_proforma_9f3a2b"
    ]
  }
}

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

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

invoiceIdstringRequired

Invoice identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: InvoiceDetailDto

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

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

dataobject

The invoice in full, as returned by the API.

Show child attributes

data.idstring

Unique invoice identifier.

data.invoiceNumberstring | null

Invoice number; null while it is a draft (the number is assigned on validation).

data.statusstring

Document lifecycle status: draft, validated (validated and numbered) or voided.

Available options: draft, validated, voided

data.isRectificationboolean

Whether the invoice rectifies a previous one. Invoices created in Filmo are never rectifications, and credit notes are served by /api/v1/credit-notes; but /api/v1/invoices can still return imported rectifying documents (for example from a Rentman import) with this set to true, so deduplicate them against the credit notes by number.

data.invoiceDatestring<date-time> | null

Issue date in ISO 8601 with offset; null while it is a draft.

data.dueDatestring<date-time> | null

Due date in ISO 8601 with offset; null if not set.

data.currencystring

Invoice currency as an ISO 4217 code (for example "EUR").

data.contactobject | null

Compact reference to the invoiced contact; null if none.

Show child attributes

data.contact.idstring

Unique contact identifier.

data.contact.namestring

Contact name.

data.orderIdstring | null

Identifier of the source order; null if the invoice does not come from an order.

data.orderNumberstring | null

Number of the source order; null if the invoice does not come from an order.

data.projectIdstring | null

Identifier of the linked project; null if not linked.

data.subTotalstring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.discountTotalstring

Total discounts as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.taxesPricestring

Tax total as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.netPricestring

Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.grossPricestring

Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.totalPaidstring | null

Amount collected to date as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.

Limits: pattern ^-?\d+\.\d{2}$

data.paymentStatusstring

Payment status: unpaid (nothing collected yet, also for invoices without a recorded collection), partially_paid, paid, overpaid (collected above the total), overdue (past due and unpaid) or voided (the document is voided, whatever was collected before). The paymentStatus filter uses the same values.

Available options: unpaid, partially_paid, paid, overpaid, overdue, voided

data.paymentMethodstring | null

Payment method of the invoice; null if not recorded.

data.tagsobject[]

Tags attached to the invoice, with their identifier and name.

Show child attributes

data.tags.idstring

Unique identifier of the tag.

data.tags.namestring

Tag name.

data.createdAtstring<date-time>

Creation date in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

data.projectNamestring | null

Name of the linked project; null if not linked.

data.taxBreakdownobject[] | null

Tax breakdown by type; null if not calculated.

Show child attributes

data.taxBreakdown.taxTypestring

Tax type key (for example "IVA_21").

data.taxBreakdown.labelstring

Human-readable tax label.

data.taxBreakdown.ratenumber

Tax rate applied, as a percentage (for example 21 for 21%).

data.taxBreakdown.baseAmountstring

Taxable base the tax is applied to, as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.taxBreakdown.amountstring

Tax amount as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.productDiscountTotalstring

Total discounts applied at product level, as a decimal string "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.

Limits: pattern ^-?\d+\.\d{2}$

data.globalDiscountTotalstring

Global discount total of the document, as a decimal string "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.

Limits: pattern ^-?\d+\.\d{2}$

data.insuranceTotalstring

Insurance total as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.depositTotalstring

Deposit total as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

data.exchangeRatenumber | null

Exchange rate applied when the currency differs from the base currency; null if not applicable.

data.billingAddressobject | null

Billing address; null if not recorded.

Show child attributes

data.billingAddress.labelstring | null

Descriptive label of the address; null if not recorded.

data.billingAddress.addressLine1string | null

First address line; null if not recorded.

data.billingAddress.addressLine2string | null

Second address line; null if not recorded.

data.billingAddress.citystring | null

City; null if not recorded.

data.billingAddress.provincestring | null

Province or region; null if not recorded.

data.billingAddress.postcodestring | null

Postal code; null if not recorded.

data.billingAddress.countrystring | null

Country; null if not recorded.

data.sourceQuoteIdsstring[] | null

Identifiers of the source quotes; null if the invoice does not come from quotes.

data.sourceProformaIdsstring[] | null

Identifiers of the source proformas; null if the invoice does not come from proformas.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Finance
Invoice
The invoice, as returned by the API.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Response

Errors

Deprecation

Related

Related pages

Invoice