DOCS

Invoice shipping charges

/

Сборы за доставку счета

Создавайте счета за доставку для клиентов Zonos.

GraphQL

СКОРО

Если клиент зарегистрировался для получения учетной записи доставки, предлагающейся через Zonos, вы можете создавать счета за сборы за доставку через API. Вы можете агрегировать сборы и создавать счета с любой периодичностью, которую вы выберете. Используя эту информацию, Zonos затем выставит счета этим клиентам от вашего имени.

Подготовьте входные данные для мутации 

При создании carrierBillingInvoice есть несколько полей, которые необходимы для успешного создания счета. Они перечислены ниже:

Обязательные поля
  • amount: Общая сумма, подлежащая оплате по счету.
  • currencyCode: Валюта, в которой представлены суммы по счету.
  • lineItems
    • amount: Сумма, подлежащая оплате по строке счета. Суммы для каждой из lineItems должны соответствовать amount для счета.
    • chargeType: Это значение, представляющее тип сбора для строки счета. Обычно это будет SHIPPING.
    • trackingNumber: Номер отслеживания, связанный со строкой счета.
  • payorAccountNumber: Номер счета клиента Zonos, для которого вы создаете счет.
  • referenceNumber: Номер ссылки для счета.

Управление счетами через API 

Следующие мутации могут быть использованы для создания новых, аннулирования ожидающих или запроса списка счетов.

Создать счет
Аннулировать счет
Запрос счетов

Как только у вас будет список всех сборов, которые необходимо выставить клиенту, используйте следующую мутацию для создания этого счета.

Мутация

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

Ответ

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

Была ли эта страница полезной?