Get a specific setting - Billing Rules

Knowledge Center > API > Settings API > Settings API tutorials > Get a specific setting - Billing Rules

Get a specific setting - Billing Rules

Table of contents
No headers

Settings API is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.

To retrieve the values of the Billing Rules settings:

  1. Use the List all settings operation to retrieve all the available settings and supported operations of them.
  2. Search for "Billing Rules" and find the following information from the response body of the "List all settings" call.
    {
      "settings": [
        {
          "key": "AccountingRules",
          "description": "Accounting Rules settings",
          "context": "Entity",
          "pathPattern": "/accounting-rules",
          "httpOperations": [
            {
              "method": "GET",
              "url": "/settings/accounting-rules",
              "parameters": [],
              "responseType": {
                "$ref": "#/definitions/AccountingRules",
                "definitions": {
                  "AccountingRules": {
                    "additionalProperties": false,
                    "type": "object",
                    "properties": {
                      "allowRevenueScheduleNegativeAmounts": {
                        "type": "boolean"
                      },
                      "allowBlankAccountingCodes": {
                        "type": "boolean"
                      },
                      "allowCreationInClosedPeriod": {
                        "type": "boolean"
                      },
                      "allowUsageInClosedPeriod": {
                        "type": "boolean"
                      },
                      "differentCurrencies": {
                        "type": "boolean"
                      }
                    }
                  }
                }
              }
            },
            ...
          ]
        }
      ]
    }

    You can find the following information about the Billing Rules setting:

    • GET operation endpoint of for Billing Rules setting:

      "url": "/settings/accounting-rules"

    • The response schema:
      "AccountingRules": {
        "additionalProperties": false,
        "type": "object",
        "properties": {
          "allowRevenueScheduleNegativeAmounts": {
            "type": "boolean"
          },
          "allowBlankAccountingCodes": {
            "type": "boolean"
          },
          "allowCreationInClosedPeriod": {
            "type": "boolean"
          },
          "allowUsageInClosedPeriod": {
            "type": "boolean"
          },
          "differentCurrencies": {
            "type": "boolean"
          }
        }
      }
      
  3. Make GET call at the endpoint /settings/billing-rules.

    HTTP request:

    GET https://rest.zuora.com/settings/billing-rules

    Response body:

     See the following example for the 200 response body.

    {
     "oneTimeCreditBack": false,
     "prorateRecurringWeeklyCharges": true,
     "prorateRecurringMonthlyCharges": true,
     "prorateUsageMonthlyCharges": true,
     "prorateUsageWeeklyCharges": true,
     "daysInMonth": "UseActualDays",
     "prorationUnit": "ProrateByDay",
     "allowAutoPostBillRun": false,
     "autoPostBillRunDefaultValue": false,
     "includeNegativeInvoice": false,
     "transactionOnSubscription": false,
     "takeContactSnapshot": false,
     "recurringChargeStyle": "Advanced",
     "preGenerateInvoicePdf": true,
     "timeOfDailyInvoice": 0,
     "invoicePastEndOfTerm": false,
     "billToTermEndWhenAutoRenew": false,
     "zuoraTaxRoundingDiffDispersion": false
    }
    
Last modified

Tags

This page has no custom tags.

Classifications

(not set)