Documentación

Primeros pasos

Rellenar los campos

Lee primero la plantilla: los campos y grupos del endpoint de plantilla son todo el contrato de values. Luego envía values como un objeto indexado por la clave del campo.

  • Las claves son las claves de los campos exactamente como se devuelven, nunca el texto de sus etiquetas ni el texto ya rellenado (una etiqueta sigue aceptándose, para clientes escritos antes de que existieran las claves). Un campo usado en varios lugares del documento se rellena en todos a la vez.
  • Las claves que omitas conservan los valores predeterminados de la plantilla. Una cadena vacía vacía un campo.
  • Un campo select acepta exactamente una de sus opciones, o una cadena vacía.
  • Un campo numérico acepta una cadena numérica como 1234.56 en cualquiera de las dos convenciones decimales; el servidor la reescribe en el formato declarado por la plantilla, así que 1234.56 queda como 1,234.56 donde el formato lo indique.
  • Un campo de fecha no se reescribe: envía la fecha ya escrita como muestra su formato. El formato es la fecha de referencia 27 de agosto de 2026 escrita de la forma esperada, así que un formato 08/27/2026 pide 10/15/2026.
  • Los campos marcados como auto los rellena PaperClerk al generar (la fecha de hoy o el siguiente número automático), y cualquier valor que envíes para ellos se ignora.
  • Un grupo repetible recibe un array de objetos de instancia indexados por las claves de campo del grupo; la fila de la plantilla se clona una vez por entrada. Un grupo omitido conserva la única fila escrita; un array vacío elimina la sección. Los valores de los campos se validan exactamente como los campos de nivel superior.
  • Cuando un campo lleva una description, es un texto de ayuda del autor de la plantilla sobre el valor esperado, como el formato o el contenido que se busca. No se imprime en el documento.

Un objeto values para una plantilla de factura

JSON
{
  "client_name": "Maple & Fern Ltd.",
  "payment_terms": "Net 15",
  "due_date": "10/15/2026",
  "line_items": [
    { "item": "Brand identity system", "quantity": "1", "amount": "4800" },
    { "item": "Brand guidelines document", "quantity": "1", "amount": "1200" }
  ]
}