Retrieve all invoice groups

Learn how to retrieve all invoice group configurations by using the Settings API.

Use this operation to view all invoice group configurations that are defined for Configurable Invoice Grouping. The response includes each invoice group and its grouping rules for subscription charges and order line items (OLIs).

See the following sample of a 200 response.

HTTP request:

GET {api_url}/settings/invoice-groups

Response body:

A successful call returns an array of invoice group configurations similar to the following example:

[
  {
    "id": "8ad088009d88d5c3019d8afb71542966",
    "number": "IG-00000001",
    "name": "__DEFAULT__",
    "meta": {
      "subscriptionGroup": [
        {
          "objectType": "Subscription",
          "field": "CostCenter__c"
        },
        {
          "objectType": "Subscription",
          "field": "ProjectID__c"
        }
      ],
      "orderLineItemGroup": [
        {
          "objectType": "OrderLineItem",
          "field": "CC_Code__c"
        },
        {
          "objectType": "OrderLineItem",
          "field": "Proj_Code__c"
        }
      ]
    }
  }
]