Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

application/json

Une nouvelle organisation et ses renseignements de facturation, de la part d'une personne qui a déjà un compte. L'inscription d'une nouvelle organisation demande les mêmes champs.

La requête accepte les conditions pour l'organisation : envoyez le slug et la version des conditions d'utilisation et de la politique de confidentialité en vigueur dans accepted_documents. language_choice consigne qu'un client au Québec a demandé l'anglais après l'affichage de la version française.

organization_name
string
requis

Le nom de l'organisation, tel qu'il apparaît dans l'application et sur les documents.

Maximum string length: 255
organization_industry
string
requis

Le secteur d'activité de l'organisation, en texte libre.

Maximum string length: 255
street_line_1
string
requis

La première ligne de l'adresse de facturation.

Maximum string length: 255
city
string
requis

La ville de l'adresse de facturation.

Maximum string length: 255
region
string
requis

L'État ou la province de l'adresse de facturation, sous forme de code ISO 3166-2 en minuscules, par exemple us-ca ou ca-qc.

postal_code
string
requis

Le code postal de l'adresse de facturation.

Maximum string length: 255
country
string
requis

Le pays de l'adresse de facturation, sous forme de code ISO 3166-1 alpha-2 en minuscules, par exemple us ou ca. Il définit aussi la devise et le système d'unités lorsque ceux-ci sont omis.

plan
string
requis

La clé du forfait sur lequel l'essai commence. Il doit s'agir d'un forfait auquel les nouvelles organisations peuvent s'inscrire.

accepted_documents
object[]
requis

Les documents juridiques acceptés pour l'organisation : une paire slug et version pour chacune des conditions d'utilisation (terms) et de la politique de confidentialité (privacy) en vigueur.

organization_url
string<uri> | null

Le site Web de l'organisation, sous forme d'URL complète.

Maximum string length: 255
organization_phone
string | null

Le numéro de téléphone de l'organisation, en texte libre.

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

L'adresse où vont les factures et le courrier de facturation. Omettez-la pour utiliser l'adresse courriel du propriétaire.

Maximum string length: 255
street_line_2
string | null

La deuxième ligne de l'adresse de facturation, comme un bureau ou une unité.

Maximum string length: 255
annual
boolean

Indique s'il faut facturer le forfait à l'année. Si omis, il est facturé au mois.

accept_terms
any

La case des conditions du formulaire Web. Elle doit être cochée. Les clients d'API acceptent les conditions en envoyant accepted_documents.

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

Envoyez en_requested_after_french_shown lorsqu'un client du Québec a vu les conditions en français et a demandé l'anglais. Omettez-le autrement.

Options disponibles:
en_requested_after_french_shown
currency
enum<string> | null

La devise dans laquelle l'organisation tient ses livres, sous forme de code ISO 4217 en majuscules comme USD. Si elle est omise, c'est la devise du pays, ou USD lorsque celle-ci n'est pas prise en charge.

Options 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

Le fuseau horaire de l'organisation, sous forme de nom IANA tel que America/Toronto. S'il est omis, c'est le fuseau horaire du pays lorsque celui-ci n'en a qu'un.

unit_system
enum<string> | null

Le système de mesure dans lequel l'organisation travaille. S'il est omis, c'est imperial pour les États-Unis, le Libéria et le Myanmar et metric partout ailleurs.

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

Ce que fait principalement l'organisation. Les premières étapes dans l'application s'y adaptent.

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

Combien de personnes travaillent dans l'organisation.

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

Réponse

OrganizationResource

data
OrganizationResource · object
requis

Une organisation à laquelle le membre appartient, et si l'application Web s'ouvre dedans.