v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Card Purchase Supplements

get/card_purchase_supplements

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

card_payment_idstring

Filter Card Purchase Supplements to ones belonging to the specified Card Payment.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Card Purchase Supplement List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
      "id": "card_purchase_supplement_ijuc45iym4jchnh2sfk3",
      "invoice": {
        "discount_amount": 100,
        "discount_currency": "USD",
        "discount_treatment_code": null,
        "duty_tax_amount": 200,
        "duty_tax_currency": "USD",
        "order_date": "2023-07-20",
        "shipping_amount": 300,
        "shipping_currency": "USD",
        "shipping_destination_country_code": "US",
        "shipping_destination_postal_code": "10045",
        "shipping_source_postal_code": "10045",
        "shipping_tax_amount": 400,
        "shipping_tax_currency": "USD",
        "shipping_tax_rate": "0.2",
        "tax_treatments": null,
        "unique_value_added_tax_invoice_reference": "12302"
      },
      "line_items": [
        {
          "detail_indicator": "normal",
          "discount_amount": null,
          "discount_currency": null,
          "discount_treatment_code": null,
          "id": "card_purchase_supplement_invoice_line_item_nf9760lz0apqy5retmqh",
          "item_commodity_code": "001",
          "item_descriptor": "Coffee",
          "item_quantity": "1.0",
          "product_code": "101",
          "sales_tax_amount": null,
          "sales_tax_currency": null,
          "sales_tax_rate": null,
          "total_amount": 500,
          "total_amount_currency": "USD",
          "unit_cost": "5.0",
          "unit_cost_currency": "USD",
          "unit_of_measure_code": "NMB"
        }
      ],
      "shipping": {
        "customer_reference_number": null,
        "destination_address": null,
        "destination_country_code": "US",
        "destination_postal_code": "10045",
        "destination_receiver_name": null,
        "discount_amount": null,
        "net_amount": 500,
        "number_of_packages": 1,
        "origin_address": null,
        "origin_country_code": "US",
        "origin_postal_code": "10045",
        "origin_sender_name": null,
        "pick_up_date": "2023-07-20",
        "service_description": null,
        "service_level_code": null,
        "shipping_courier_name": "UPS",
        "tax_amount": null,
        "tracking_number": "1Z9999999999999999",
        "unit_of_measure": null,
        "weight": null
      },
      "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
      "type": "card_purchase_supplement"
    }
  ],
  "next_cursor": "v57w5d"
}