Factuarea APIDevelopers

Listar todos los albaranes

Lista tus albaranes con paginación por cursor.

GET
/delivery_notes
AuthorizationBearer <token>

En: header

Parámetros de consulta

limit?integer

Número de objetos a devolver. Entero entre 1 y 100. Por defecto 25.

Predeterminado25
Rango1 <= value <= 100
starting_after?string

Cursor para paginación hacia delante. Usa el uuid del último objeto de la página anterior.

Formatouuid
ending_before?string

Cursor para paginación hacia atrás. Usa el uuid del primer objeto de la página actual.

Formatouuid
status?string

Estado público del albarán: draft, sent, signed, invoiced, cancelled (los mismos valores que devuelve el campo status del recurso). sent y signed filtran por el estado interno entregado (con/sin firma); usa también el filtro signed para distinguirlos con precisión. Coincidencia exacta en status.

status[in]?string

Estado público del albarán: draft, sent, signed, invoiced, cancelled (los mismos valores que devuelve el campo status del recurso). sent y signed filtran por el estado interno entregado (con/sin firma); usa también el filtro signed para distinguirlos con precisión. Lista separada por comas. Coincide cualquiera de los valores.

client_id?string

Client ID (UUID v7). Coincidencia exacta con client_id.

Formatouuid
client_id[in]?string

Client ID (UUID v7). Lista separada por comas. Coincide cualquiera de los valores.

series_id?string

Series ID (UUID v7). Coincidencia exacta con series_id.

Formatouuid
series_id[in]?string

Series ID (UUID v7). Lista separada por comas. Coincide cualquiera de los valores.

created[gte]?string

Fecha de creación (ISO 8601). Mayor o igual que el valor dado.

Formatodate-time
created[lte]?string

Fecha de creación (ISO 8601). Menor o igual que el valor dado.

Formatodate-time
created[gt]?string

Fecha de creación (ISO 8601). Estrictamente mayor que el valor dado.

Formatodate-time
created[lt]?string

Fecha de creación (ISO 8601). Estrictamente menor que el valor dado.

Formatodate-time
delivery_date[gte]?string

Fecha de entrega. Mayor o igual que el valor dado.

Formatodate
delivery_date[lte]?string

Fecha de entrega. Menor o igual que el valor dado.

Formatodate
delivery_date[gt]?string

Fecha de entrega. Estrictamente mayor que el valor dado.

Formatodate
delivery_date[lt]?string

Fecha de entrega. Estrictamente menor que el valor dado.

Formatodate
signed?boolean

Filtra por albaranes firmados (true) o sin firma registrada (false). Coincidencia exacta en signed.

number?string

Número de albarán. Coincidencia exacta sobre number.

number[contains]?string

Número de albarán. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre number.

vehicle_plate?string

Matrícula del vehículo de reparto. Coincidencia exacta sobre vehicle_plate.

vehicle_plate[contains]?string

Matrícula del vehículo de reparto. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre vehicle_plate.

carrier_company?string

Empresa de transporte / mensajería. Coincidencia exacta sobre carrier_company.

carrier_company[contains]?string

Empresa de transporte / mensajería. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre carrier_company.

delivery_city?string

Población de la dirección de entrega registrada en el albarán (p. ej. delivery_city=Alcoy), nunca la del cliente — para filtrar por cliente usa client_id. Coincidencia exacta sobre delivery_city.

delivery_city[in]?string

Población de la dirección de entrega registrada en el albarán (p. ej. delivery_city=Alcoy), nunca la del cliente — para filtrar por cliente usa client_id. Lista separada por comas. Coincide cualquiera de los valores.

delivery_city[contains]?string

Población de la dirección de entrega registrada en el albarán (p. ej. delivery_city=Alcoy), nunca la del cliente — para filtrar por cliente usa client_id. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre delivery_city.

delivery_province?string

Provincia de la dirección de entrega registrada en el albarán (p. ej. delivery_province[in]=Alicante,Valencia), nunca la del cliente — para filtrar por cliente usa client_id. Coincidencia exacta sobre delivery_province.

delivery_province[in]?string

Provincia de la dirección de entrega registrada en el albarán (p. ej. delivery_province[in]=Alicante,Valencia), nunca la del cliente — para filtrar por cliente usa client_id. Lista separada por comas. Coincide cualquiera de los valores.

delivery_province[contains]?string

Provincia de la dirección de entrega registrada en el albarán (p. ej. delivery_province[in]=Alicante,Valencia), nunca la del cliente — para filtrar por cliente usa client_id. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre delivery_province.

delivery_postal_code?string

Código postal de la dirección de entrega registrada en el albarán, nunca el del cliente. Las dos primeras cifras identifican la provincia, así que delivery_postal_code[contains]=03 acota el listado a una sola provincia. Coincidencia exacta sobre delivery_postal_code.

delivery_postal_code[in]?string

Código postal de la dirección de entrega registrada en el albarán, nunca el del cliente. Las dos primeras cifras identifican la provincia, así que delivery_postal_code[contains]=03 acota el listado a una sola provincia. Lista separada por comas. Coincide cualquiera de los valores.

delivery_postal_code[contains]?string

Código postal de la dirección de entrega registrada en el albarán, nunca el del cliente. Las dos primeras cifras identifican la provincia, así que delivery_postal_code[contains]=03 acota el listado a una sola provincia. Coincidencia parcial sin distinguir mayúsculas (LIKE %term%) sobre delivery_postal_code.

tags?string

Filtrar por tag de clasificación (slug en minúscula). Admite múltiples valores con tags[in]=a,b (JSON_CONTAINS, semántica OR — coincide con los albaranes que llevan CUALQUIERA de los tags). Coincidencia exacta sobre tags.

tags[in]?string

Filtrar por tag de clasificación (slug en minúscula). Admite múltiples valores con tags[in]=a,b (JSON_CONTAINS, semántica OR — coincide con los albaranes que llevan CUALQUIERA de los tags). Lista separada por comas. Coincide cualquiera de los valores.

sort?string

Orden de los resultados. Usa un campo para ascendente o un prefijo - para descendente (p. ej. -created). Campos permitidos: created, number, delivery_date. Combinado con el cursor, el orden se mantiene determinista (un orden secundario estable por el id del cursor, al estilo Stripe). Si se omite, los resultados siguen el orden de cursor por defecto (created descendente).

Valor en"created" | "-created" | "number" | "-number" | "delivery_date" | "-delivery_date"
search?string

Búsqueda de texto libre. LIKE %term% escapado (sin distinguir mayúsculas, máx. 80 caracteres) sobre las columnas de texto clave del recurso, combinado con los demás filtros (AND) y compatible con el cursor.

Longitudlength <= 80
metadata?

Filtra por pares clave/valor de metadata usando la sintaxis deepObject metadata[key]=value. Varios pares se combinan con AND. Cada clave debe cumplir [A-Za-z0-9_.-]{1,64}; se permiten un máximo de 50 pares (más → 422).

Headers

Factuarea-Version?string

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate
X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json