ミューテーション入力の準備
carrierBillingInvoiceを作成する際には、請求書が正常に作成されるために必要なフィールドがいくつかあります。これらは以下に示されています。
必要なフィールド
amount: 請求書の合計金額。currencyCode: 請求書の金額が表される通貨。lineItemsamount: 請求書の行に対する金額。各lineItemsの金額は請求書のamountと一致する必要があります。chargeType: 請求書の行に対する料金の種類を表す値。通常はSHIPPINGです。trackingNumber: 請求書の行に関連付けられた追跡番号。
payorAccountNumber: 請求書を作成するZonosの顧客のアカウント番号。referenceNumber: 請求書の参照番号。
APIを介して請求書を管理する
以下のミューテーションを使用して、新しい請求書を作成したり、保留中の請求書を無効にしたり、請求書のリストを照会したりできます。
請求書を作成
請求書の無効化
請求書の照会
顧客に請求する必要があるすべての料金のリストがある場合は、次のミューテーションを使用してその請求書を作成します。
ミューテーション
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
}
}
}
応答
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"
}
]
}
]
}
}
請求書の送料
Zonos の顧客向けに送料の請求書を生成します。GraphQL
近日公開
顧客がZonosを通じて提供される配送アカウントにサインアップしている場合、APIを介して送料の請求書を作成できます。料金を集計し、任意の頻度で請求書を作成することができます。その情報を使用して、Zonosがあなたの代わりにその顧客に請求書を送信します。