Billing Arrangement

Output representation that contains the details of a billing arrangement, including its status, configuration settings, and associated lines.

JSON Example 

1{
2  "billingArrangementId": "1bdxx000000004rAAA",
3  "name": "Acme Shared Billing Definition",
4  "isAdjustmentToOwnAccount": true,
5  "remainderPercentage": 15,
6  "versionNumber": 1,
7  "numOfAssociatedBSGs": 5,
8  "status": "Active",
9  "billingArrangementLines": [
10    {
11      "billingArrangementLineId": "1blxx000000006TAAQ",
12      "accountId": "accId1",
13      "billingAccountId": "bAccId1",
14      "isRemainderAdjustmentAccount": false,
15      "percentage": 60
16    },
17    {
18      "billingArrangementLineId": "1blxx000000001dAAA",
19      "accountId": "accId2",
20      "billingAccountId": "bAccId2",
21      "isRemainderAdjustmentAccount": false,
22      "percentage": 25
23    }
24  ],
25  "isSuccess": true,
26  "error": null
27}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
billing​ArrangementIdStringUnique ID of the billing arrangement.Big, 66.066.0
billing​ArrangementLinesBilling Arrangement Line[]List of billing arrangement lines associated with the latest version of the billing arrangement.Big, 66.066.0
errorError Response OutputError details if the request was unsuccessful.Big, 66.066.0
isAdjustment​ToOwnAccountBooleanIndicates whether the remainder of the bill is adjusted to the owning account (true) or not (false).Big, 66.066.0
isSuccessBooleanIndicates whether the request was successfully processed (true) or not (false).Big, 66.066.0
nameStringName of the billing arrangement.Big, 66.066.0
numOf​AssociatedBSGsIntegerTotal number of billing schedule groups associated with the billing arrangement.Big, 66.066.0
remainderPercentageDoubleRemaining percentage of the bill after all line allocations are calculated.Big, 66.066.0
statusStringStatus of the billing arrangement. Valid values are Draft, Active, or Inactive.Big, 66.066.0
versionNumberIntegerCurrent version number of the billing arrangement.Big, 66.066.0