Saltar al contenido principal
PUT
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

La dirección de facturación que se guarda. Reemplaza la dirección completa, así que un campo opcional que se omite se borra.

first_name
string
requerido

El nombre de la persona a la que se dirigen las facturas. Hasta 255 caracteres.

Maximum string length: 255
last_name
string
requerido

El apellido de la persona a la que se dirigen las facturas. Hasta 255 caracteres.

Maximum string length: 255
email
string<email>
requerido

La dirección de correo electrónico a la que se envían las facturas y los avisos de facturación. Hasta 255 caracteres.

Maximum string length: 255
street_line_1
string
requerido

La primera línea de la dirección postal. Hasta 255 caracteres.

Maximum string length: 255
city
string
requerido

La ciudad o población de la dirección. Máximo 255 caracteres.

Maximum string length: 255
region
string
requerido

La región como código ISO 3166-2 en minúsculas, como ca-on para Ontario. Debe ser una región de country.

postal_code
string
requerido

El código postal o ZIP, de máximo 12 caracteres.

Maximum string length: 12
country
string
requerido

El país como código ISO 3166-1 alfa-2 en minúsculas, como ca. Debe ser un país conocido.

company_name
string | null

El nombre de la empresa que se imprime en las facturas. Omítelo o envía null si no hay.

Maximum string length: 255
phone
string | null

El número de teléfono del contacto de facturación, como texto libre. Omítelo o envía null si no hay.

Maximum string length: 255
street_line_2
string | null

La segunda línea de la dirección, como un local o una unidad. Es opcional.

Maximum string length: 255

Respuesta

BillingAddressResource

data
BillingAddressResource · object
requerido

La dirección de facturación de la organización: a quién se dirigen sus facturas de StockShift. Un campo que es obligatorio en una actualización puede ser una cadena vacía en una dirección guardada antes de que ese campo fuera obligatorio.