Preparar la entrada de la mutación
Al crear un carrierBillingInvoice, hay varios campos que son necesarios para que la factura se cree con éxito. Estos se enumeran a continuación:
Campos requeridos
amount: El monto total adeudado por la factura.currencyCode: La moneda en la que se representan los montos de la factura.lineItemsamount: El monto adeudado por una línea de factura. Los montos de cada uno de loslineItemsdeben coincidir con elamountde la factura.chargeType: Este es un valor que representa el tipo de cargo para la línea de la factura. Estos serán típicamenteSHIPPING.trackingNumber: El número de seguimiento asociado con la línea de la factura.
payorAccountNumber: El número de cuenta del cliente de Zonos para el que está creando la factura.referenceNumber: El número de referencia de la factura.
Gestionar facturas a través de la API
Las siguientes mutaciones se pueden utilizar para crear nuevas, anular pendientes o consultar una lista de facturas.
Una vez que tenga una lista de todos los cargos que deben ser facturados a un cliente, use la siguiente mutación para crear esa factura.
Mutación
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
}
}
}
Respuesta
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"
}
]
}
]
}
}
Cargos de envío de facturas
Generar facturas de envío para clientes de Zonos.GraphQL
PRÓXIMAMENTE
Si un cliente se ha registrado para una cuenta de envío que se ofrece a través de Zonos, puede crear facturas para los cargos de envío a través de la API. Puede agregar los cargos y crear facturas en cualquier frecuencia que elija. Usando esa información, Zonos facturará a esos clientes en su nombre.