Préparer l'entrée de mutation
Lors de la création d'un carrierBillingInvoice, plusieurs champs sont requis pour que la facture soit créée avec succès. Ceux-ci sont listés ci-dessous :
Champs requis
amount: Le montant total dû pour la facture.currencyCode: La devise dans laquelle les montants de la facture sont représentés.lineItemsamount: Le montant dû pour une ligne de facture. Les montants de chaquelineItemsdoivent correspondre auamountde la facture.chargeType: Il s'agit d'une valeur qui représente le type de frais pour la ligne de facture. Ceux-ci seront généralementSHIPPING.trackingNumber: Le numéro de suivi associé à la ligne de facture.
payorAccountNumber: Le numéro de compte du client Zonos pour lequel vous créez la facture.referenceNumber: Le numéro de référence de la facture.
Gérer les factures via l'API
Les mutations suivantes peuvent être utilisées pour créer de nouvelles factures, annuler des factures en attente ou interroger une liste de factures.
Créer une facture
Annuler la facture
Interroger les factures
Une fois que vous avez une liste de tous les frais qui doivent être facturés à un client, utilisez la mutation suivante pour créer cette facture.
Mutation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
mutation {
carrierBillingInvoiceCreate(
input: [
{
amount: 60
currencyCode: USD
payorAccountNumber: "123456"
referenceNumber: "13"
status: PENDING
metadata: [{ key: "testkey", value: "testvalue" }]
lineItems: [
{
amount: 30
chargeType: SHIPPING
currencyCode: USD
trackingNumber: "12345"
}
{
amount: 30
chargeType: SHIPPING
currencyCode: USD
trackingNumber: "6789"
}
]
}
]
) {
id
organizationId
amount
status
metadata {
key
value
}
lineItems {
id
description
amount
currencyCode
trackingNumber
}
}
}
Réponse
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
"data": {
"carrierBillingInvoiceCreate": [
{
"id": "cbi_bc4c59c1-6fed-4408-8dad-5df2fd3ad813",
"organizationId": "organization_e54e9553-4e1f-4bad-ab55-6ab53b8ba2cc",
"amount": 60,
"status": "PENDING",
"metadata": [
{
"key": "testkey",
"value": "testvalue"
}
],
"lineItems": [
{
"id": "cbi_line_item_fd0abe87-28d5-4075-b7a8-68125141ade0",
"description": "SHIPPING Charge",
"amount": 30,
"currencyCode": "USD",
"trackingNumber": "12345"
},
{
"id": "cbi_line_item_156db74c-48c6-4251-beb9-6fe10a2bd6d0",
"description": "SHIPPING Charge",
"amount": 30,
"currencyCode": "USD",
"trackingNumber": "6789"
}
]
}
]
}
}
Frais d'expédition de facture
Générez des factures d'expédition pour les clients de Zonos.
GraphQL
BIENTÔT DISPONIBLE
Si un client a souscrit à un compte d'expédition proposé par Zonos, vous pouvez créer des factures pour les frais d'expédition via l'API. Vous pouvez agréger les frais et créer des factures à la cadence de votre choix. En utilisant ces informations, Zonos facturera ensuite ces clients en votre nom.