Delivery Notes

List all delivery notes

List your delivery notes with cursor-based pagination.

get/companies/{company}/delivery-notes

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/delivery-notes
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

ending_beforestring uuid

Cursor for backward pagination: pass the id of the first object on the current page.

statusstring

Status: draft, sent, signed, invoiced or cancelled; sent and signed both match delivered notes (use the signed filter to split them). Exact match on status.

status[in]string

Comma-separated list of values (CSV).

Status: draft, sent, signed, invoiced or cancelled; sent and signed both match delivered notes (use the signed filter to split them). Comma-separated list. Any of the values matches.

client_idstring uuid

Client ID (UUID v7). Exact match on client_id.

client_id[in]string

Comma-separated list of values (CSV).

Client ID (UUID v7). Comma-separated list. Any of the values matches.

series_idstring uuid

Series ID (UUID v7). Exact match on series_id.

series_id[in]string

Comma-separated list of values (CSV).

Series ID (UUID v7). Comma-separated list. Any of the values matches.

created[gte]string date-time

Creation date (ISO 8601). Greater than or equal to the given value.

created[lte]string date-time

Creation date (ISO 8601). Less than or equal to the given value.

created[gt]string date-time

Creation date (ISO 8601). Strictly greater than the given value.

created[lt]string date-time

Creation date (ISO 8601). Strictly less than the given value.

delivery_date[gte]string date

Delivery date. Greater than or equal to the given value.

delivery_date[lte]string date

Delivery date. Less than or equal to the given value.

delivery_date[gt]string date

Delivery date. Strictly greater than the given value.

delivery_date[lt]string date

Delivery date. Strictly less than the given value.

signedboolean

Filter by signed delivery notes (true) or with no recorded signature (false). Exact match on signed.

numberstring

Delivery note number. Exact match on number.

number[contains]string

Delivery note number. Partial case-insensitive match (LIKE %term%) on number.

vehicle_platestring

License plate of the delivery vehicle. Exact match on vehicle_plate.

vehicle_plate[contains]string

License plate of the delivery vehicle. Partial case-insensitive match (LIKE %term%) on vehicle_plate.

carrier_companystring

Transport / courier company. Exact match on carrier_company.

carrier_company[contains]string

Transport / courier company. Partial case-insensitive match (LIKE %term%) on carrier_company.

delivery_citystring

Town or city of the delivery address (not the client address). Exact match on delivery_city.

delivery_city[in]string

Comma-separated list of values (CSV).

Town or city of the delivery address (not the client address). Comma-separated list. Any of the values matches.

delivery_city[contains]string

Town or city of the delivery address (not the client address). Partial case-insensitive match (LIKE %term%) on delivery_city.

delivery_provincestring

Province of the delivery address (not the client address). Exact match on delivery_province.

delivery_province[in]string

Comma-separated list of values (CSV).

Province of the delivery address (not the client address). Comma-separated list. Any of the values matches.

delivery_province[contains]string

Province of the delivery address (not the client address). Partial case-insensitive match (LIKE %term%) on delivery_province.

delivery_postal_codestring

Postal code of the delivery address (not the client address); its first two digits identify the province. Exact match on delivery_postal_code.

delivery_postal_code[in]string

Comma-separated list of values (CSV).

Postal code of the delivery address (not the client address); its first two digits identify the province. Comma-separated list. Any of the values matches.

delivery_postal_code[contains]string

Postal code of the delivery address (not the client address); its first two digits identify the province. Partial case-insensitive match (LIKE %term%) on delivery_postal_code.

tagsstring

Classification tag (lowercase slug); tags[in]=a,b matches delivery notes carrying ANY of the tags. Exact match on tags.

tags[in]string

Comma-separated list of values (CSV).

Classification tag (lowercase slug); tags[in]=a,b matches delivery notes carrying ANY of the tags. Comma-separated list. Any of the values matches.

sort'created' | '-created' | 'number' | '-number' | 'delivery_date' | '-delivery_date'

Sort order: created, number, delivery_date ascending, or with a - prefix for descending (default -created).

searchstring

Free-text search. Escaped LIKE %term% (case-insensitive, max 80 chars) across the resource's key text columns, combined with the other filters (AND) and compatible with the cursor.

metadataobject

Metadata filter as metadata[key]=value (deepObject): pairs combine with AND, up to 50, keys matching [A-Za-z0-9_.-]{1,64}.

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

has_moreboolean required

Whether more pages are available after this one.

next_cursorstring nullable required

Opaque cursor for the next page, or null when has_more is false. The example below shows the shape used by most listings; others return a different one, so pass the value back verbatim instead of validating it.

Example response

{
  "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",
      "delivery_address": "Calle Mayor 12",
      "delivery_city": "Alcoy",
      "delivery_postal_code": "03801",
      "delivery_province": "Alicante",
      "delivery_country": "España",
      "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",
      "transport_details": "Entrega en muelle 3, de 8:00 a 14:00.",
      "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.00",
      "taxes_total": "168.00",
      "total_vat": "168.00",
      "total_retention": "0.00",
      "total_surcharge": "0.00",
      "total": "968.00",
      "total_gross_weight_kg": "25.7500",
      "lines_without_weight_count": 1,
      "currency": "EUR",
      "notes": "Entregado en almacén central.",
      "external_id": "ERP-ALB-2026-0031",
      "reference_number": "PO-2026-4471",
      "lines": [
        {
          "description": "Cajas de material A4 (500u)",
          "additional_description": "Auditoría inicial e informe de mejoras",
          "product": {
            "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
            "name": "Consultoría hora estándar"
          },
          "quantity": 2,
          "unit_price": "400.0000",
          "tax_rate": 21,
          "subtotal": "800.00",
          "taxes": "168.00",
          "total": "968.00",
          "counted_quantity": "4.0000",
          "configuration": {
            "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c04",
            "name": "Caja A4 · Cartón reforzado",
            "signature": "35c8be09d174a2f6031e7bc4980d5a2e6f31097bd4a85c26e10f739b48d20ac5"
          },
          "options": [
            {
              "group": {
                "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c14",
                "name": "Acabado"
              },
              "value": {
                "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c24",
                "name": "Cartón reforzado"
              },
              "price_adjustment": "40.0000",
              "applied": true
            }
          ],
          "price_semantics": "per_commercial_unit",
          "price_adjustment_total": "40.0000",
          "gross_weight_kg": "25.0000"
        }
      ],
      "metadata": {
        "erp_code": "IVA-GEN",
        "ledger_account": "477000"
      },
      "tags": [
        "logistica",
        "almacen-central"
      ],
      "custom_fields": [
        {
          "field": "muelle_carga",
          "value": "Muelle 3"
        }
      ],
      "created_at": "2026-01-19T08:00:00Z",
      "updated_at": "2026-01-21T14:50:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.