*REST API › Endpoint reference › Finance › Invoices*

# Get an invoice

> Returns the detail of an invoice by its identifier.

`GET /api/v1/invoices/{invoiceId}` — scope `invoices:read`

Scope: `invoices:read` · 120/min · Strict tenancy · If-None-Match · MCP: `filmo_invoices_get`

## Authorizations

Bearer API key with the scope below. `invoices:read`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `If-None-Match` | string | No | Conditional read: the `ETag` of the copy you already have. If the resource has not changed, the response is `304` with no body. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `invoiceId` | string | Yes | Invoice identifier. |

## Request examples

*Get an invoice*

**cURL**

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

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/invoices/invo_8f2a1c', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

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

## Response

Response schema: `InvoiceDetailDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 304 | Not modified: the `If-None-Match` sent matches the current `ETag`. No body; the copy you have is current. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | The invoice in full, as returned by the API. |
| `data.id` | string | Unique invoice identifier. |
| `data.invoiceNumber` | string | Invoice number; null while it is a draft (the number is assigned on validation). |
| `data.status` | string | Document lifecycle status: draft, validated (validated and numbered) or voided. `draft`, `validated`, `voided` |
| `data.isRectification` | boolean | 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.invoiceDate` | string<date-time> | Issue date in ISO 8601 with offset; null while it is a draft. |
| `data.dueDate` | string<date-time> | Due date in ISO 8601 with offset; null if not set. |
| `data.currency` | string | Invoice currency as an ISO 4217 code (for example "EUR"). |
| `data.contact` | object | Compact reference to the invoiced contact; null if none. |
| `data.contact.id` | string | Unique contact identifier. |
| `data.contact.name` | string | Contact name. |
| `data.orderId` | string | Identifier of the source order; null if the invoice does not come from an order. |
| `data.orderNumber` | string | Number of the source order; null if the invoice does not come from an order. |
| `data.projectId` | string | Identifier of the linked project; null if not linked. |
| `data.subTotal` | string | Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.discountTotal` | string | Total discounts as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.taxesPrice` | string | Tax total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.netPrice` | string | Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.grossPrice` | string | Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.totalPaid` | string | Amount collected to date as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded. |
| `data.paymentStatus` | string | 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. `unpaid`, `partially_paid`, `paid`, `overpaid`, `overdue`, `voided` |
| `data.paymentMethod` | string | Payment method of the invoice; null if not recorded. |
| `data.tags` | object[] | Tags attached to the invoice, with their identifier and name. |
| `data.tags.id` | string | Unique identifier of the tag. |
| `data.tags.name` | string | Tag name. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `data.updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `data.projectName` | string | Name of the linked project; null if not linked. |
| `data.taxBreakdown` | object[] | Tax breakdown by type; null if not calculated. |
| `data.taxBreakdown.taxType` | string | Tax type key (for example "IVA_21"). |
| `data.taxBreakdown.label` | string | Human-readable tax label. |
| `data.taxBreakdown.rate` | number | Tax rate applied, as a percentage (for example 21 for 21%). |
| `data.taxBreakdown.baseAmount` | string | Taxable base the tax is applied to, as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.taxBreakdown.amount` | string | Tax amount as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.productDiscountTotal` | string | Total discounts applied at product level, as a decimal string "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal. |
| `data.globalDiscountTotal` | string | Global discount total of the document, as a decimal string "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal. |
| `data.insuranceTotal` | string | Insurance total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.depositTotal` | string | Deposit total as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.exchangeRate` | number | Exchange rate applied when the currency differs from the base currency; null if not applicable. |
| `data.billingAddress` | object | Billing address; null if not recorded. |
| `data.billingAddress.label` | string | Descriptive label of the address; null if not recorded. |
| `data.billingAddress.addressLine1` | string | First address line; null if not recorded. |
| `data.billingAddress.addressLine2` | string | Second address line; null if not recorded. |
| `data.billingAddress.city` | string | City; null if not recorded. |
| `data.billingAddress.province` | string | Province or region; null if not recorded. |
| `data.billingAddress.postcode` | string | Postal code; null if not recorded. |
| `data.billingAddress.country` | string | Country; null if not recorded. |
| `data.sourceQuoteIds` | string[] | Identifiers of the source quotes; null if the invoice does not come from quotes. |
| `data.sourceProformaIds` | string[] | Identifiers of the source proformas; null if the invoice does not come from proformas. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "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"
    ]
  }
}
```

304: No body.

## Errors

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

## Deprecation

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

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/invoices/get-an-invoice  
Last updated: 2026-10-25