Inicio rápido

Cinco pasos desde cero hasta tu primera factura como JSON. Necesitas una cuenta de Ocost como propietario o contable.

1. Regístrate

Regístrate en https://app.ocost.io/auth/sign-up, o inicia sesión. Los archivos que envías por la API aparecen en Archivos, como cualquier subida.

2. Crea una clave

  1. Abre Ajustes › Desarrolladores y elige Nueva clave.
  2. Nombra la clave según quién la usa, por ejemplo "Odoo producción".
  3. Deja marcados los permisos que vienen marcados y elige Crear clave.
  4. Elige Copiar clave. La clave empieza por ocost_sk_, y Ocost la muestra una sola vez.

Guárdala en tu shell para los siguientes pasos:

Shell
export OCOST_KEY="ocost_sk_…"

3. Envía un PDF

Envía el archivo como multipart/form-data en el campo file. external_ref es tu propio id, y Ocost te lo devuelve.

curl -sS https://api.ocost.io/public/v1/files \
  -H "Authorization: Bearer $OCOST_KEY" \
  -F "file=@invoice.pdf" \
  -F "external_ref=account.move,42"

Ocost responde 202 Accepted y empieza a leer:

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "name": "invoice.pdf",
  "status": "received",
  "reason": null,
  "external_ref": "account.move,42",
  "documents": [],
  "sha256": "0edd5593…"
}

4. Espera hasta que esté leído

Pide el archivo cada pocos segundos mientras su status sea received o reading. La mayoría de los PDF tardan menos de un minuto.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID \
  -H "Authorization: Bearer $OCOST_KEY"

Un archivo leído lista sus documentos:

JSON
{
  "id": "01a1b08c-6e3a-7562-8f4a-7924722667b1",
  "status": "read",
  "documents": [
    {
      "id": "01a1b08c-7aa1-7b52-9d4e-2f1f1c0c4f11",
      "kind": "invoice",
      "number": "RE-2026-1187",
      "pages": [1]
    }
  ]
}

Un archivo que termina en not_read o failed dice por qué en reason. Estados y motivos los enumera.

5. Lee el documento

Pide el primer documento del archivo.

curl -sS https://api.ocost.io/public/v1/files/$FILE_ID/document \
  -H "Authorization: Bearer $OCOST_KEY"

La respuesta es la factura como ocost.document.v1, aquí abreviada:

JSON
{
  "schema": "ocost.document.v1",
  "kind": "invoice",
  "number": "RE-2026-1187",
  "issue_date": "2026-11-03",
  "due_date": "2026-12-03",
  "currency": "EUR",
  "seller": { "name": "Musterbüro Lieferant GmbH", "vat_id": "DE123456789" },
  "totals": { "net": 1068, "tax": 202.92, "gross": 1270.92 }
}

Siguiente

Véase también