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

Los campos de un cliente, para agregarlo o cambiarlo. Un cambio reemplaza todos los campos, así que un campo omitido se borra o vuelve a su valor predeterminado.

code
string
requerido

El código del cliente, de hasta 32 caracteres: letras, dígitos y ., _, - o /, y debe empezar con una letra o un dígito. Es único en la organización, sin distinguir mayúsculas.

Maximum string length: 32
Pattern: ^[A-Za-z0-9][A-Za-z0-9._\/-]*$
name
string
requerido

El nombre del cliente tal como se imprime en las cotizaciones y las facturas, de hasta 255 caracteres.

Maximum string length: 255
billing_address
string | null

La dirección a la que se dirigen las cotizaciones y facturas, de hasta 1,000 caracteres.

Maximum string length: 1000
shipping_address
string | null

La dirección a la que se envía un pedido de venta cuando se guarda sin una, de hasta 1,000 caracteres.

Maximum string length: 1000
payment_terms_days
integer | null

Cuántos días después de su fecha de emisión vence una factura, de 0 a 365. Si se omite, la factura vence en su fecha de emisión.

Rango requerido: 0 <= x <= 365
notes
string | null

Notas de texto libre sobre el cliente, de hasta 2,000 caracteres.

Maximum string length: 2000
tax_treatment
enum<string> | null

Cómo se gravan los impuestos al cliente: taxable o exempt. taxable si se omite.

Opciones disponibles:
taxable,
exempt
tax_exemption_reference
string | null

La referencia de exención, como un número de certificado de reventa, de hasta 100 caracteres. Es obligatoria cuando tax_treatment es exempt.

Maximum string length: 100
tax_rate_id
string<uuid> | null

Una tasa de impuesto activa de la organización, para un cliente sujeto a impuestos; la tasa predeterminada cuando se omite.

price_list_id
string<uuid> | null

Una lista de precios activa de la organización; la lista predeterminada fija el precio de lo que omite la propia del cliente.

shelf_life_minimum
integer | null

La vida útil restante mínima propia del cliente: días, hasta 3650, o un porcentaje de la vida de un lote, hasta 100. Si se omite, se aplica el mínimo del artículo o de la organización.

Rango requerido: 0 <= x <= 3650
shelf_life_unit
enum<string> | null

La unidad de shelf_life_minimum: days o percent. Si no se envía, es days.

Opciones disponibles:
days,
percent

Respuesta

SalesCustomerResource

data
SalesCustomerResource · object
requerido

Una empresa a la que vende la organización, con sus contactos cuando se muestra por separado.