Primeros pasos

Errores

Todo error, sea cual sea el estado HTTP, tiene una misma forma. code es estable y sirve para ramificar; message dice qué salió mal y, cuando ayuda, qué enviar en su lugar; detail nombra el parámetro, la cabecera o el valor al que se refiere el error, cuando lo hay.

JSON

{
  "error": {
    "code": "unknown_placeholder",
    "message": "No placeholder is keyed \"client\". Keys of `values` must be placeholder KEYS (the template’s placeholders[].key, e.g. \"client_name\"), not the values currently filled in and not names read out of the text. Retry with keys taken from exactly this list: \"client_name\", \"payment_terms\", \"due_date\", \"invoice_number\", \"issue_date\", \"line_items\"."
  }
}

Código	Estado	Significado
`unauthorized`	401	No hay token bearer, o no es válido.
`validation`	400	Un parámetro de consulta, un parámetro de ruta o el cuerpo está mal formado. detail lo nombra.
`not_found`	404	No existe esa plantilla o documento, o la cuenta no puede verlo. Los dos casos son indistinguibles a propósito.
`template_not_saved`	409	La plantilla aún no tiene una versión guardada; solo las plantillas guardadas pueden generar.
`subscription_required`	402	El espacio de trabajo no tiene un plan activo. Un propietario o administrador puede elegir uno en la página de facturación; no se pierde nada.
`unknown_placeholder`	422	Una clave de values no es una clave de campo de esta plantilla. El mensaje enumera las claves válidas.
`unknown_group_field`	422	Una clave dentro de un objeto de instancia no es una clave de campo de ese grupo. El mensaje enumera los campos.
`invalid_option`	422	A un campo de tipo select se le envió un valor que no está entre sus opciones.
`invalid_number`	422	A un campo numérico se le envió algo que no es un número.
`invalid_values`	422	A un campo se le envió un array, o a un grupo se le envió una cadena.
`idempotency_in_flight`	409	La misma petición todavía se está procesando. Reintenta en un momento.
`payload_too_large`	413	El cuerpo de la petición supera 1 MB.
`method_not_allowed`	405	El método no está permitido en esta ruta. La cabecera Allow lista los que sí.
`pdf_render_failed`	500	No se pudo generar el PDF del documento. Volver a pedirlo lo reintenta.
`internal`	500	Algo falló de nuestro lado. Reintenta; si persiste, escríbenos.