Orders API returns different repsonse for installment payments

Questions
1

I’m using the Orders API to get information about recent, existing orders.

When I call the Retrieve Order API for a standard, lump sum payment to an invoice, I get a breakdown of sales tax in a section of the JSON response, as expected per the reference docs.

However, I have a series of installment payments and I want to see a breakdown of the sales tax & processing fees in each individual payment, and the JSON response for one of these transactions doesn’t include a taxes section, or any tax or fee information at all.

Here’s the standard, lump sum results, as expected from the documentation:

{
  "order": {
    "id": "4s0FCnjt0qdufQy**********",
    "location_id": "LFKQGBX**********",
    "line_items": [
      {
        "uid": "b95d81ca-d8a7-47c3-94af**********",
        "catalog_object_id": "FLAILSSGMUK4IK7VM**********",
        "catalog_version": 17080110**********,
        "quantity": "1",
        "name": "Wedding Artwork Collection",
        "variation_name": "Regular",
        "base_price_money": {
          "amount": 100,
          "currency": "USD"
        },
        "gross_sales_money": {
          "amount": 100,
          "currency": "USD"
        },
        "total_tax_money": {
          "amount": 6,
          "currency": "USD"
        },
        "total_discount_money": {
          "amount": 0,
          "currency": "USD"
        },
        "total_money": {
          "amount": 106,
          "currency": "USD"
        },
        "variation_total_price_money": {
          "amount": 100,
          "currency": "USD"
        },
        "applied_taxes": [
          {
            "uid": "a96ef7e6-f7b7-4c23-b1e2-93**********",
            "tax_uid": "4280da8c-7b6e-4e5b-bb1d-**********",
            "applied_money": {
              "amount": 6,
              "currency": "USD"
            }
          }
        ],
        "item_type": "ITEM",
        "total_service_charge_money": {
          "amount": 0,
          "currency": "USD"
        }
      }
    ],
    "taxes": [
      {
        "uid": "4280da8c-7b6e-4e5b-bb1d-b**********",
        "catalog_object_id": "LRTSBYGYKL2Q**********",
        "catalog_version": 1709227**********,
        "name": "Sales tax",
        "percentage": "6.5",
        "type": "ADDITIVE",
        "applied_money": {
          "amount": 6,
          "currency": "USD"
        },
        "scope": "LINE_ITEM"
      }
    ],
    "created_at": "2024-03-06T15:08:17Z",
    "updated_at": "2024-03-06T15:08:19.000Z",
    "state": "COMPLETED",
    "total_tax_money": {
      "amount": 6,
      "currency": "USD"
    },
    "total_discount_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_tip_money": {
      "amount": 0,
      "currency": "USD"
    },
    "total_money": {
      "amount": 106,
      "currency": "USD"
    },
    "closed_at": "2024-03-06T15:08:19.000Z",
    "tenders": [
      {
        "id": "9g7JE9NBW7yZ89**********",
        "location_id": "LFKQGBX7**********",
        "transaction_id": "4s0FCnjt0qduf**********",
        "created_at": "2024-03-06T15:08:17Z",
        "amount_money": {
          "amount": 106,
          "currency": "USD"
        },
        "processing_fee_money": {
          "amount": 33,
          "currency": "USD"
        },
        "customer_id": "4KNM5V3JQGVXG**********",
        "type": "CARD",
        "card_details": {
          "status": "CAPTURED",
          "card": {
            "card_brand": "VISA",
            "last_4": "7601"
          },
          "entry_method": "KEYED"
        },
        "tip_money": {
          "amount": 0,
          "currency": "USD"
        }
      }
    ],
    "total_service_charge_money": {
      "amount": 0,
      "currency": "USD"
    },
    "return_amounts": {
      "total_money": {
        "amount": 0,
        "currency": "USD"
      },
      "tax_money": {
        "amount": 0,
        "currency": "USD"
      },
      "discount_money": {
        "amount": 0,
        "currency": "USD"
      },
      "tip_money": {
        "amount": 0,
        "currency": "USD"
      },
      "service_charge_money": {
        "amount": 0,
        "currency": "USD"
      }
    },
    "net_amounts": {
      "total_money": {
        "amount": 106,
        "currency": "USD"
      },
      "tax_money": {
        "amount": 6,
        "currency": "USD"
      },
      "discount_money": {
        "amount": 0,
        "currency": "USD"
      },
      "tip_money": {
        "amount": 0,
        "currency": "USD"
      },
      "service_charge_money": {
        "amount": 0,
        "currency": "USD"
      }
    },
    "source": {},
    "customer_id": "4KNM5V3JQGVXGG**********",
    "net_amount_due_money": {
      "amount": 0,
      "currency": "USD"
    }
  }
}

And here’s the same call for an installment payment - it’s much shorter:

{
  "order": {
    "id": "CJYFmSCAMHT7**********",
    "location_id": "LFKQGB**********",
    "created_at": "2024-02-28T19:41:54.000Z",
    "updated_at": "2024-04-23T14:57:41.000Z",
    "state": "OPEN",
    "tenders": [
      {
        "id": "tqeyyNBmcan611m7VMYoOTpquaB",
        "location_id": "LFKQGB**********",
        "transaction_id": "CJYFmSCAMHT74**********",
        "created_at": "2024-04-23T14:57:38Z",
        "amount_money": {
          "amount": 134,
          "currency": "USD"
        },
        "type": "CARD",
        "card_details": {
          "status": "CAPTURED",
          "card": {
            "card_brand": "VISA",
            "last_4": "7601"
          },
          "entry_method": "ON_FILE"
        },
        "tip_money": {
          "amount": 0,
          "currency": "USD"
        }
      },
      {
        "id": "rb9VAKd0tzlwUa**********",
        "location_id": "LFKQGBX7BS51K",
        "transaction_id": "CJYFmSCAMHT74**********",
        "created_at": "2024-02-28T19:41:54Z",
        "amount_money": {
          "amount": 1000,
          "currency": "USD"
        },
        "type": "CARD",
        "card_details": {
          "status": "CAPTURED",
          "card": {
            "card_brand": "VISA",
            "last_4": "7601"
          },
          "entry_method": "KEYED"
        },
        "tip_money": {
          "amount": 0,
          "currency": "USD"
        }
      }
    ],
    "source": {},
    "net_amount_due_money": {
      "amount": -1134,
      "currency": "UNKNOWN_CURRENCY"
    }
  }
}

Is there a way to get full (tax, transaction fee, etc.) information about an installation payment?

2

:wave: I’m Square Dev AI, here to help answer your question!
Based on the information you’ve provided, the following documentation will help answer your question:

Additional Documentation

Invoices API Overview
Retrieve Payments
Take Payments

If this documentation helped you find a solution, please check the box indicating that this reply solves the problem.
Otherwise one of our Developer Advocates will provide additional assistance shortly.

3

The Orders API does not provide a breakdown of taxes, service charges, or discounts for each individual installment payment. The tax, service charge, and discount information is associated with the entire order, not individual payments.

When you create an order with the Orders API, you can specify taxes, service charges, and discounts that apply to the order as a whole or to individual line items. However, these price adjustments are not distributed across installment payments. Instead, they are calculated and applied when the order is created.

If you need to track how taxes, service charges, and discounts apply to each installment payment, you would need to implement this logic in your own application. You could do this by dividing the total tax, service charge, or discount amount by the number of installment payments to get the amount per installment. However, this would be an approximation and might not accurately reflect how Square calculates these amounts.

This answer was reviewed by @Bryan-Square.