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.

Paramètres de chemin

customer
string
requis

L'ID du client, un UUID.

Corps

application/json

Les champs d'un client, pour l'ajouter ou le modifier. Une modification remplace tous les champs : un champ omis est vidé ou rétabli à sa valeur par défaut.

code
string
requis

Le code du client, jusqu'à 32 caractères : lettres, chiffres et ., _, - ou /, commençant par une lettre ou un chiffre. Unique dans l'organisation, sans égard à la casse.

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

Le nom du client tel qu'il s'imprime sur les soumissions et les factures, jusqu'à 255 caractères.

Maximum string length: 255
billing_address
string | null

L'adresse à laquelle les soumissions et les factures sont adressées, jusqu'à 1,000 caractères.

Maximum string length: 1000
shipping_address
string | null

L'adresse où une commande client est expédiée lorsqu'elle est enregistrée sans adresse, jusqu'à 1,000 caractères.

Maximum string length: 1000
payment_terms_days
integer | null

Combien de jours après sa date d'émission une facture est exigible, de 0 à 365. Si omis, une facture est exigible à sa date d'émission.

Plage requise: 0 <= x <= 365
notes
string | null

Des notes en texte libre sur le client, d'au plus 2,000 caractères.

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

Comment le client est taxé : taxable ou exempt. taxable si omis.

Options disponibles:
taxable,
exempt
tax_exemption_reference
string | null

La référence d'exonération, comme un numéro de certificat de revente, jusqu'à 100 caractères. Obligatoire lorsque tax_treatment est exempt.

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

Un taux de taxe actif de l'organisation, pour un client imposable; le taux par défaut s'il est omis.

price_list_id
string<uuid> | null

Une liste de prix active de l'organisation; la liste par défaut établit les prix que la liste propre au client omet.

shelf_life_minimum
integer | null

La durée de conservation restante minimale propre au client : des jours, jusqu'à 3650, ou un pourcentage de la durée de vie d'un lot, jusqu'à 100. Si elle est omise, le minimum de l'article ou de l'organisation s'applique.

Plage requise: 0 <= x <= 3650
shelf_life_unit
enum<string> | null

L'unité de shelf_life_minimum : days ou percent. days lorsqu'elle est omise.

Options disponibles:
days,
percent

Réponse

SalesCustomerResource

data
SalesCustomerResource · object
requis

Une entreprise à laquelle l'organisation vend, avec ses contacts lorsqu'elle est affichée seule.