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 organización nueva y sus datos de facturación, de alguien que ya tiene una cuenta. Registrar una organización nueva pide los mismos campos.

La solicitud acepta los términos de la organización: envía el slug y la version de los Términos del servicio y de la Política de privacidad vigentes en accepted_documents. language_choice registra a un cliente en Quebec que pidió inglés después de que se le mostró la versión en francés.

organization_name
string
requerido

El nombre de la organización, tal como aparece en la app y en los documentos.

Maximum string length: 255
organization_industry
string
requerido

El sector de la organización, como texto libre.

Maximum string length: 255
street_line_1
string
requerido

La primera línea de la dirección de facturación.

Maximum string length: 255
city
string
requerido

La ciudad de la dirección de facturación.

Maximum string length: 255
region
string
requerido

El estado o la provincia de la dirección de facturación, como código ISO 3166-2 en minúsculas, por ejemplo us-ca o ca-qc.

postal_code
string
requerido

El código postal de la dirección de facturación.

Maximum string length: 255
country
string
requerido

El país de la dirección de facturación, como código ISO 3166-1 alpha-2 en minúsculas, por ejemplo us o ca. También define la moneda y el sistema de unidades cuando se omiten.

plan
string
requerido

La clave del plan con el que empieza la prueba. Debe ser un plan al que puedan registrarse las organizaciones nuevas.

accepted_documents
object[]
requerido

Los documentos legales aceptados por la organización: un par slug y version para cada uno de los Términos del servicio (terms) y la Política de privacidad (privacy) vigentes.

organization_url
string<uri> | null

El sitio web de la organización, como URL completa.

Maximum string length: 255
organization_phone
string | null

El número de teléfono de la organización, como texto libre.

Maximum string length: 255
billing_email
string<email> | null

La dirección a la que van las facturas y el correo de facturación. Omítela para usar el correo electrónico del propietario.

Maximum string length: 255
street_line_2
string | null

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

Maximum string length: 255
annual
boolean

Si se factura el plan por año. Si se omite, se factura por mes.

accept_terms
any

La casilla de términos del formulario web. Debe estar marcada. Los clientes de la API aceptan los términos enviando accepted_documents.

Opciones disponibles:
yes,
on,
1,
1,
true,
true
language_choice
enum<string> | null

Envía en_requested_after_french_shown cuando a un cliente de Quebec se le mostraron los términos en francés y pidió verlos en inglés. Omítelo en cualquier otro caso.

Opciones disponibles:
en_requested_after_french_shown
currency
enum<string> | null

La moneda en la que la organización lleva su contabilidad, como código ISO 4217 en mayúsculas, como USD. Si se omite, es la moneda del país, o USD cuando esa no es compatible.

Opciones disponibles:
AED,
AFN,
ALL,
AMD,
ARS,
AUD,
AZN,
BAM,
BDT,
BGN,
BHD,
BIF,
BND,
BOB,
BRL,
BWP,
BYN,
BZD,
CAD,
CDF,
CHF,
CLP,
CNY,
COP,
CRC,
CVE,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ERN,
ETB,
EUR,
GBP,
GEL,
GHS,
GNF,
GTQ,
HKD,
HNL,
HRK,
HUF,
IDR,
ILS,
INR,
IQD,
IRR,
ISK,
JMD,
JOD,
JPY,
KES,
KHR,
KMF,
KRW,
KWD,
KZT,
LBP,
LKR,
LVL,
LYD,
MAD,
MDL,
MGA,
MKD,
MMK,
MOP,
MUR,
MXN,
MYR,
MZN,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PAB,
PEN,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RSD,
RUB,
RWF,
SAR,
SDG,
SEK,
SGD,
SOS,
SYP,
THB,
TND,
TOP,
TRY,
TTD,
TWD,
TZS,
UAH,
UGX,
USD,
UYU,
UZS,
VND,
XAF,
XCD,
XOF,
YER,
ZAR,
null
time_zone
string | null

La zona horaria de la organización, como nombre IANA, por ejemplo America/Toronto. Si no se envía, es la zona horaria del país cuando el país tiene una sola.

unit_system
enum<string> | null

El sistema de medidas en que trabaja la organización. Si se omite, es imperial para Estados Unidos, Liberia y Myanmar y metric en todos los demás.

Opciones disponibles:
metric,
imperial
operations
enum<string> | null

A qué se dedica principalmente la organización. Los primeros pasos en la app se adaptan a ello.

Opciones disponibles:
make,
store_and_ship,
both
team_size
enum<string> | null

Cuántas personas trabajan en la organización.

Opciones disponibles:
1_10,
11_50,
51_200,
201_plus

Respuesta

OrganizationResource

data
OrganizationResource · object
requerido

Una organización a la que pertenece el miembro, y si la app web se abre en ella.