DOCS

Invoice shipping charges

/

Faktura fraktkostnader

Generera fraktfakturor för Zonos kunder.

GraphQL

KOMMER SNART

Om en kund har registrerat sig för ett fraktkonto som erbjuds genom Zonos, kan du skapa fakturor för fraktkostnader via API:et. Du kan aggregera kostnader och skapa fakturor med valfri frekvens. Med hjälp av den informationen kommer Zonos att fakturera dessa kunder å dina vägnar.

Förbered mutationsinmatningen 

När du skapar en carrierBillingInvoice finns det flera fält som krävs för att fakturan ska kunna skapas framgångsrikt. Dessa listas nedan:

Obligatoriska fält
  • amount: Det totala beloppet som ska betalas för fakturan.
  • currencyCode: Valutan som beloppen för fakturan representeras i.
  • lineItems
    • amount: Det belopp som ska betalas för en fakturalinje. Beloppen för varje av lineItems måste matcha amount för fakturan.
    • chargeType: Detta är ett värde som representerar typen av kostnad för fakturalinjen. Dessa kommer vanligtvis att vara SHIPPING.
    • trackingNumber: Det spårningsnummer som är kopplat till fakturalinjen.
  • payorAccountNumber: Kontonumret för Zonos kunden som du skapar fakturan för.
  • referenceNumber: Referensnumret för fakturan.

Hantera fakturor via API:et 

Följande mutationer kan användas för att skapa nya, ogiltiga väntande, eller fråga en lista över fakturor.

Skapa faktura
Ogiltig faktura
Fråga fakturor

När du har en lista över alla kostnader som behöver faktureras till en kund, använd följande mutation för att skapa den fakturan.

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 den här sidan hjälpsam?