Prepare a entrada da mutação
Ao criar um carrierBillingInvoice, há vários campos que são obrigatórios para que a fatura seja criada com sucesso. Estes estão listados abaixo:
Campos obrigatórios
amount: O valor total devido pela fatura.currencyCode: A moeda em que os valores da fatura estão representados.lineItemsamount: O valor devido por uma linha da fatura. Os valores para cada um doslineItemsdevem corresponder aoamountda fatura.chargeType: Este é um valor que representa o tipo de cobrança para a linha da fatura. Normalmente, seráSHIPPING.trackingNumber: O número de rastreamento associado à linha da fatura.
payorAccountNumber: O número da conta do cliente do Zonos para o qual você está criando a fatura.referenceNumber: O número de referência da fatura.
Gerenciar faturas via API
As seguintes mutações podem ser usadas para criar novas faturas, anular pendentes ou consultar uma lista de faturas.
Criar fatura
Cancelar fatura
Consultar faturas
Uma vez que você tenha uma lista de todas as taxas que precisam ser faturadas a um cliente, use a seguinte mutação para criar essa fatura.
Mutação
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
}
}
}
Resposta
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"
}
]
}
]
}
}
Taxas de envio da fatura
Gere faturas de envio para clientes do Zonos.GraphQL
EM BREVE
Se um cliente se inscreveu para uma conta de envio oferecida através do Zonos, você pode criar faturas para taxas de envio via API. Você pode agregar as taxas e criar faturas em qualquer cadência que escolher. Usando essas informações, o Zonos então faturará esses clientes em seu nome.