Facturas

Obtener una factura

Devuelve el detalle de una factura por su identificador.

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"
    ]
  }
}

// Sin cuerpo.

{
  "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"
}

Generado a partir del esquema

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. invoices:read

Cabeceras

If-None-Matchstring

Lectura condicional: el ETag de la copia que ya tienes. Si el recurso no ha cambiado, la respuesta es 304 sin cuerpo.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

invoiceIdstringObligatorio

Identificador de la factura.

Límites: longitud mín. 1

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: InvoiceDetailDto

Sobre: InvoiceDetailResponse. meta.warnings solo aparece cuando la operación está obsoleta.

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

dataobject

La factura completa, tal como la devuelve la API.

Mostrar atributos hijos

data.idstring

Identificador único de la factura.

data.invoiceNumberstring | null

Número de factura; null mientras es un borrador (el número se asigna al validarla).

data.statusstring

Estado del ciclo de vida del documento: draft, validated (validado y numerado) o voided.

Opciones disponibles: draft, validated, voided

data.isRectificationboolean

Si la factura rectifica una anterior. Las facturas creadas en Filmo nunca son rectificativas, y las notas de crédito se sirven en /api/v1/credit-notes; pero /api/v1/invoices aún puede devolver documentos rectificativos importados (por ejemplo, de una importación de Rentman) con este campo en true, así que deduplícalos con las notas de crédito por número.

data.invoiceDatestring<date-time> | null

Fecha de emisión en ISO 8601 con desfase; null mientras es un borrador.

data.dueDatestring<date-time> | null

Fecha de vencimiento en ISO 8601 con desplazamiento; null si no está definida.

data.currencystring

Moneda de la factura como código ISO 4217 (por ejemplo "EUR").

data.contactobject | null

Referencia compacta al contacto facturado; null si no hay.

Mostrar atributos hijos

data.contact.idstring

Identificador único del contacto.

data.contact.namestring

Nombre del contacto.

data.orderIdstring | null

Identificador del pedido de origen; null si la factura no procede de un pedido.

data.orderNumberstring | null

Número del pedido de origen; null si la factura no procede de un pedido.

data.projectIdstring | null

Identificador del proyecto vinculado; null si no está vinculado.

data.subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.discountTotalstring

Total de descuentos como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.taxesPricestring

Total de impuestos como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.netPricestring

Base imponible (neto antes de impuestos) como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.grossPricestring

Total con impuestos, como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.totalPaidstring | null

Importe cobrado hasta la fecha como cadena decimal "1234.50" (ROUND_HALF_UP); null si no consta.

Límites: patrón ^-?\d+\.\d{2}$

data.paymentStatusstring

Estado del pago: unpaid (nada cobrado todavía, también para facturas sin cobro registrado), partially_paid, paid, overpaid (cobrado por encima del total), overdue (vencido y sin pagar) o voided (el documento está anulado, sea cual sea lo cobrado antes). El filtro paymentStatus usa los mismos valores.

Opciones disponibles: unpaid, partially_paid, paid, overpaid, overdue, voided

data.paymentMethodstring | null

Método de pago de la factura; null si no se ha registrado.

data.tagsobject[]

Etiquetas adjuntas a la factura, con su identificador y nombre.

Mostrar atributos hijos

data.tags.idstring

Identificador único de la etiqueta.

data.tags.namestring

Nombre de la etiqueta.

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

data.updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

data.projectNamestring | null

Nombre del proyecto vinculado; null si no está vinculado.

data.taxBreakdownobject[] | null

Desglose de impuestos por tipo; null si no se ha calculado.

Mostrar atributos hijos

data.taxBreakdown.taxTypestring

Clave del tipo de impuesto (por ejemplo "IVA_21").

data.taxBreakdown.labelstring

Etiqueta de impuesto legible.

data.taxBreakdown.ratenumber

Tipo impositivo aplicado, como porcentaje (por ejemplo 21 para el 21%).

data.taxBreakdown.baseAmountstring

Base imponible sobre la que se aplica el impuesto, como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.taxBreakdown.amountstring

Importe del impuesto como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.productDiscountTotalstring

Total de descuentos aplicados a nivel de producto, como cadena decimal "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.

Límites: patrón ^-?\d+\.\d{2}$

data.globalDiscountTotalstring

Total de descuento global del documento, como cadena decimal "1234.50" (ROUND_HALF_UP). productDiscountTotal + globalDiscountTotal = discountTotal.

Límites: patrón ^-?\d+\.\d{2}$

data.insuranceTotalstring

Total del seguro como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.depositTotalstring

Total de fianzas como cadena decimal "1234.50" (ROUND_HALF_UP).

Límites: patrón ^-?\d+\.\d{2}$

data.exchangeRatenumber | null

Tipo de cambio aplicado cuando la moneda difiere de la moneda base; null si no aplica.

data.billingAddressobject | null

Dirección de facturación; null si no consta.

Mostrar atributos hijos

data.billingAddress.labelstring | null

Etiqueta descriptiva de la dirección; null si no consta.

data.billingAddress.addressLine1string | null

Primera línea de la dirección; null si no consta.

data.billingAddress.addressLine2string | null

Segunda línea de la dirección; null si no consta.

data.billingAddress.citystring | null

Ciudad; null si no consta.

data.billingAddress.provincestring | null

Provincia o región; null si no se ha registrado.

data.billingAddress.postcodestring | null

Código postal; null si no se ha registrado.

data.billingAddress.countrystring | null

País; null si no consta.

data.sourceQuoteIdsstring[] | null

Identificadores de los presupuestos de origen; null si la factura no procede de presupuestos.

data.sourceProformaIdsstring[] | null

Identificadores de las proformas de origen; null si la factura no procede de proformas.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos

meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos

meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

meta.warnings.linkstring

Dónde está documentada la deprecación (el changelog).

Errores

Estado	Códigos	Significado
404	`not_found`	No existe o queda fuera del alcance de la clave de API.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

Finanzas
Factura
La factura, tal como la devuelve la API.

¿Te ha resultado útil esta página?

Ejemplos de petición

Autorizaciones

Cabeceras

Parámetros de ruta

Respuesta

Errores

Obsolescencia

Relacionado

Páginas relacionadas

Factura