Factuarea API
Albarans

Llistar tots els albarans

Llista els teus albarans amb paginació per cursor.

GET
/delivery_notes
AuthorizationBearer <token>

A: header

Paràmetres de consulta

limit?integer

Nombre d'objectes a retornar. Enter entre 1 i 100. Per defecte 25.

Predeterminat25
Rang1 <= value <= 100
starting_after?string

Cursor per a paginació cap endavant. Fes servir l'uuid de l'últim objecte de la pàgina anterior.

Formatuuid
ending_before?string

Cursor per a paginació cap enrere. Fes servir l'uuid del primer objecte de la pàgina actual.

Formatuuid
status?string

Estat públic de l'albarà: draft, sent, signed, invoiced, cancelled (els mateixos valors que retorna el camp status del recurs). sent i signed filtren per l'estat intern lliurat (amb/sense signatura); fes servir també el filtre signed per distingir-los amb precisió. Coincidència exacta en status.

status[in]?string

Estat públic de l'albarà: draft, sent, signed, invoiced, cancelled (els mateixos valors que retorna el camp status del recurs). sent i signed filtren per l'estat intern lliurat (amb/sense signatura); fes servir també el filtre signed per distingir-los amb precisió. Llista separada per comes. Coincideix qualsevol dels valors.

client_id?string

Client ID (UUID v7). Coincidència exacta amb client_id.

Formatuuid
client_id[in]?string

Client ID (UUID v7). Llista separada per comes. Coincideix qualsevol dels valors.

series_id?string

Series ID (UUID v7). Coincidència exacta amb series_id.

Formatuuid
series_id[in]?string

Series ID (UUID v7). Llista separada per comes. Coincideix qualsevol dels valors.

created[gte]?string

Data de creació (ISO 8601). Major o igual que el valor donat.

Formatdate-time
created[lte]?string

Data de creació (ISO 8601). Menor o igual que el valor donat.

Formatdate-time
created[gt]?string

Data de creació (ISO 8601). Estrictament major que el valor donat.

Formatdate-time
created[lt]?string

Data de creació (ISO 8601). Estrictament menor que el valor donat.

Formatdate-time
delivery_date[gte]?string

Data de lliurament. Major o igual que el valor donat.

Formatdate
delivery_date[lte]?string

Data de lliurament. Menor o igual que el valor donat.

Formatdate
delivery_date[gt]?string

Data de lliurament. Estrictament major que el valor donat.

Formatdate
delivery_date[lt]?string

Data de lliurament. Estrictament menor que el valor donat.

Formatdate
signed?boolean

Filtra per albarans signats (true) o sense signatura registrada (false). Coincidència exacta en signed.

vehicle_plate?string

Matrícula del vehicle de repartiment (coincidència exacta). Coincidència exacta amb vehicle_plate.

carrier_company?string

Empresa de transport / missatgeria (coincidència exacta). Coincidència exacta a carrier_company.

tags?string

Filtrar per tag de classificació (slug en minúscula). Admet múltiples valors amb tags[in]=a,b (JSON_CONTAINS, semàntica OR — coincideix amb els albarans que porten QUALSEVOL dels tags). Coincidència exacta sobre tags.

tags[in]?string

Filtrar per tag de classificació (slug en minúscula). Admet múltiples valors amb tags[in]=a,b (JSON_CONTAINS, semàntica OR — coincideix amb els albarans que porten QUALSEVOL dels tags). Llista separada per comes. Coincideix qualsevol dels valors.

sort?string

Ordre dels resultats. Fes servir un camp per a ascendent o un prefix - per a descendent (p. ex. -created). Camps permesos: created, number, delivery_date. Combinat amb el cursor, l'ordre es manté determinista (un ordre secundari estable per l'id del cursor, a l'estil Stripe). Si s'omet, els resultats segueixen l'ordre de cursor per defecte (created descendent).

Valor a"created" | "-created" | "number" | "-number" | "delivery_date" | "-delivery_date"

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{
  "data": [
    {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a06",
      "object": "delivery_note",
      "number": "A-2026-00031",
      "series": {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
        "code": "F-2026"
      },
      "client": {
        "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
        "name": "Acme Corporation"
      },
      "status": "signed",
      "issued_on": "2026-01-19",
      "delivery_date": "2026-01-21",
      "signed_at": "2026-01-21T14:50:00Z",
      "signed_by": "María García López",
      "signature_image_url": "https://files.factuarea.com/signatures/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a06.png",
      "vehicle_plate": "5678JKL",
      "driver": {
        "name": "Pedro Sánchez Ruiz",
        "tax_id": "12345678Z"
      },
      "tracking": {
        "number": "TRK-2026-0099",
        "carrier": "SEUR"
      },
      "received_by": {
        "name": "María García López",
        "tax_id": "87654321X"
      },
      "billing_emails": [
        "administracion@cliente.com"
      ],
      "subtotal": 800,
      "taxes_total": 168,
      "total": 968,
      "currency": "EUR",
      "notes": "Entregado en almacén central.",
      "external_id": "ERP-ALB-2026-0031",
      "lines": [
        {
          "object": "delivery_note_line",
          "description": "Caixes de material A4 (500u)",
          "product": {
            "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
            "name": "Consultoría hora estándar"
          },
          "quantity": 2,
          "unit_price": 400,
          "tax_rate": 21,
          "retention_rate": 0,
          "surcharge_rate": 0,
          "discount_percent": 0,
          "subtotal": 800,
          "taxes": 168,
          "total": 968
        }
      ],
      "metadata": {
        "erp_code": "IVA-GEN",
        "ledger_account": "477000"
      },
      "tags": [
        "logistica",
        "almacen-central"
      ],
      "custom_fields": [
        {
          "field": "muelle_carga",
          "value": "Muelle 3"
        }
      ],
      "converted_to_id": null,
      "created_at": "2026-01-19T08:00:00Z",
      "updated_at": "2026-01-21T14:50:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "message": "El parámetro 'per_page' no está reconocido por este endpoint.",
    "param": "per_page",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01HKQS5N7UR6PWJ8K2T5BWPMZ9"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}