v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Billing Terms

List billing terms

get/v3/billing-terms

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: contractId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull startDate (datetime): eq, neq, gt, gte, lt, lte endDate (datetime): eq, neq, gt, gte, lt, lte billingTermGroupId (uuid): eq, neq, in, nin, isnull, isnotnull productId (uuid): eq, neq, in, nin, isnull, isnotnull

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001

Response

Get all Billing Terms by filter

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "quantity": 1,
        "duration": 12,
        "interval": "MONTH",
        "invoiceDateStrategy": "FIRST_OF_PERIOD",
        "netPaymentTerms": 30,
        "billingType": "FLAT",
        "pricingType": "SIMPLE",
        "pricing": [
          {
            "tier": 1,
            "amount": 120000,
            "amountType": "TOTAL_INVOICE",
            "tierMinimum": 0
          }
        ],
        "discounts": [
          {
            "type": "PERCENTAGE",
            "amount": "0.10",
            "note": "Partner discount"
          },
          {
            "type": "FIXED",
            "amount": "100",
            "note": "Early payment discount"
          }
        ]
      }
    ]
  }
}