DOCS

Invoice shipping charges

/

Faktura for fragtomkostninger

Generer fragtfakturaer for Zonos kunder.

GraphQL

KOMMER SNART

Hvis en kunde har tilmeldt sig en fragtkonto, der tilbydes gennem Zonos, kan du oprette fakturaer for fragtomkostninger via API'en. Du kan aggregere omkostninger og oprette fakturaer med den frekvens, du vælger. Ved hjælp af disse oplysninger vil Zonos derefter fakturere disse kunder på dine vegne.

Forbered mutationsinput 

Når du opretter en carrierBillingInvoice, er der flere felter, der er nødvendige for, at fakturaen kan oprettes korrekt. Disse er listet nedenfor:

Nødvendige felter
  • amount: Det samlede beløb, der skal betales for fakturaen.
  • currencyCode: Den valuta, som beløbene for fakturaen er angivet i.
  • lineItems
    • amount: Det beløb, der skal betales for en fakturalinje. Beløbene for hver af lineItems skal matche amount for fakturaen.
    • chargeType: Dette er en værdi, der repræsenterer typen af omkostning for fakturalinjen. Disse vil typisk være FRAGT.
    • trackingNumber: Det sporingsnummer, der er knyttet til fakturalinjen.
  • payorAccountNumber: Kontonummeret for Zonos kunden, du opretter fakturaen for.
  • referenceNumber: Referencenummeret for fakturaen.

Administrer fakturaer via API'en 

Følgende mutationer kan bruges til at oprette nye, annullere ventende eller forespørge en liste over fakturaer.

Når du har en liste over alle omkostninger, der skal faktureres til en kunde, skal du bruge følgende mutation til at oprette den faktura.

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
    }
  }
}

Svar

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"
          }
        ]
      }
    ]
  }
}

Var denne side nyttig?