Passer au contenu principal
PUT
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

L'adresse de facturation à enregistrer. Elle remplace l'adresse entière, de sorte qu'un champ facultatif omis est effacé.

first_name
string
requis

Le prénom de la personne à qui les factures sont adressées. 255 caractères au plus.

Maximum string length: 255
last_name
string
requis

Le nom de famille de la personne à qui les factures sont adressées. 255 caractères au plus.

Maximum string length: 255
email
string<email>
requis

L'adresse courriel où sont envoyés les factures et les avis de facturation. 255 caractères au plus.

Maximum string length: 255
street_line_1
string
requis

La première ligne de l'adresse civique. 255 caractères au plus.

Maximum string length: 255
city
string
requis

La ville ou le village de l'adresse. Au plus 255 caractères.

Maximum string length: 255
region
string
requis

La région sous forme de code ISO 3166-2 en minuscules, comme ca-on pour l'Ontario. Ce doit être une région de country.

postal_code
string
requis

Le code postal, d'au plus 12 caractères.

Maximum string length: 12
country
string
requis

Le pays sous forme de code ISO 3166-1 alpha-2 en minuscules, comme ca. Il doit s'agir d'un pays connu.

company_name
string | null

Le nom de l'entreprise à imprimer sur les factures. Omettez-le ou envoyez null pour aucun.

Maximum string length: 255
phone
string | null

Le numéro de téléphone du contact de facturation, en texte libre. Omettez-le ou envoyez null pour aucun.

Maximum string length: 255
street_line_2
string | null

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

Maximum string length: 255

Réponse

BillingAddressResource

data
BillingAddressResource · object
requis

L'adresse de facturation de l'organisation : à qui ses factures StockShift sont adressées. Un champ obligatoire lors d'une mise à jour peut être une chaîne vide dans une adresse enregistrée avant que ce champ ne devienne obligatoire.