Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

Una plantilla de un tipo de documento. El diseño es fijo: una plantilla define con qué se llena, nunca cómo se dibuja, y nunca el banner de clasificación.

type
enum<string>
requerido

El tipo de documento para el que es la plantilla: purchase_order, quote, invoice, packing_slip, certificate_of_conformance o certificate_of_analysis. No se puede cambiar una vez que existe la plantilla.

Opciones disponibles:
purchase_order,
quote,
invoice,
packing_slip,
certificate_of_conformance,
certificate_of_analysis
name
string
requerido

Cómo se llama la plantilla, como Government, hasta 80 caracteres.

Maximum string length: 80
columns
enum<string>[]
requerido

Las columnas opcionales que se muestran. Órdenes de compra: supplier_part_number, origin_country y expected_on. Cotizaciones y facturas: discount y tax. Listas de empaque: lots y serials. Certificados: lots, serials y origin_country. Las columnas que no son opcionales siempre se imprimen.

Una de las columnas opcionales del tipo; las de cualquier tipo cuando el tipo se desconoce, como al generar la referencia de la API.

Opciones disponibles:
supplier_part_number,
origin_country,
expected_on,
discount,
tax,
lots,
serials
paper
enum<string>
requerido

El tamaño de papel en el que se imprimen los documentos: letter o a4.

Opciones disponibles:
letter,
a4
fields
object[]
requerido

Campos personalizados impresos junto a los datos propios del documento, como un código CAGE, máximo 12.

Maximum array length: 12
is_default
boolean

Si los documentos del tipo se imprimen con ella, salvo que su cliente o proveedor use otra.

title
string | null

El título impreso en la parte superior, de hasta 80 caracteres. Si está vacío, se imprime el título propio del tipo en el idioma del documento.

Maximum string length: 80
notes
string | null

Notas impresas después de las líneas, hasta 2,000 caracteres.

Maximum string length: 2000
terms
string | null

Términos y condiciones que se imprimen al final, hasta 10,000 caracteres.

Maximum string length: 10000

Respuesta

DocumentTemplateResource

data
DocumentTemplateResource · object
requerido

Una plantilla de un tipo de documento: el título, las columnas opcionales, el tamaño de papel, los campos personalizados, las notas y los términos con los que se imprimen sus documentos. El diseño en sí es fijo.