DOCS

Invoice shipping charges

/

Faktura fraktkostnader

Generer fraktfakturaer for Zonos kunder.

GraphQL

KOMMER SNART

Hvis en kunde har registrert seg for en fraktkonto som tilbys gjennom Zonos, kan du opprette fakturaer for fraktkostnader via API-en. Du kan aggregere kostnader og opprette fakturaer med hvilken som helst frekvens du velger. Ved å bruke den informasjonen, vil Zonos deretter fakturere disse kundene på dine vegne.

Forbered mutasjonsinngangen 

Når du oppretter en carrierBillingInvoice, er det flere felt som er nødvendige for at fakturaen skal opprettes vellykket. Disse er listet opp nedenfor:

Nødvendige felt
  • amount: Det totale beløpet som skal betales for fakturaen.
  • currencyCode: Valutaen som beløpene for fakturaen er representert i.
  • lineItems
    • amount: Beløpet som skal betales for en fakturalinje. Beløpene for hver av lineItems må samsvare med amount for fakturaen.
    • chargeType: Dette er en verdi som representerer typen kostnad for fakturalinjen. Disse vil typisk være SHIPPING.
    • trackingNumber: Sporingsnummeret knyttet til fakturalinjen.
  • payorAccountNumber: Kontonummeret til Zonos kunden du oppretter fakturaen for.
  • referenceNumber: Referansenummeret for fakturaen.

Administrer fakturaer via API-en 

Følgende mutasjoner kan brukes til å opprette nye, annullere ventende, eller forespørre en liste over fakturaer.

Opprett faktura
Annuller faktura
Forespørsel fakturaer

Når du har en liste over alle kostnader som må faktureres til en kunde, bruk følgende mutasjon for å opprette den fakturaen.

Mutasjon

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 siden nyttig?