All REST Endpoints
Account Management/Billing Cycle Specifications
Use for managing billing cycle specifications.
- Get a Billing Cycle Specification by ID
- Method: getPath:
/billingCycleSpecification/{id}
- Get Billing Cycle Specifications
- Method: getPath:
/billingCycleSpecification
Account Management/Notification Listeners
Use for managing notification events sent by external applications.
- Create an Account from a PartyAccountCreateEvent Notification
- Method: postPath:
/listener/partyAccountCreateEvent
- Update an Account from a PartyAccountAttributeValueChangeEvent Notification
- Method: postPath:
/listener/partyAccountAttributeValueChangeEvent
Customer Bill Management/Applied Customer Billing Rate
Use for managing applied customer billing rates.
- Get an Applied Customer Billing Rate by ID
- Method: getPath:
/appliedCustomerBillingRate/{id}
- Get Applied Customer Billing Rates
- Method: getPath:
/appliedCustomerBillingRate
Customer Bill Management/Customer Bill
Use for managing customer bills.
- Get a Customer Bill by ID
- Method: getPath:
/customerBill/{id}
- Get Customer Bills
- Method: getPath:
/customerBill
- Update a Customer Bill
- Method: patchPath:
/customerBill/{id}
Customer Bill Management/Customer Bill Invoice
The operations from the Customer Bill Management/Customer Bill Invoice category.
- Get an Invoice PDF by Bill ID
- Method: getPath:
/invoice/{id}
Customer Bill Management/Customer Bill On Demand
Use for managing on-demand customer bills.
- Create a Customer Bill On Demand
- Method: postPath:
/customerBillOnDemand
- Get an On-Demand Customer Bill by ID
- Method: getPath:
/customerBillOnDemand/{id}
- Get On-Demand Customer Bills
- Method: getPath:
/customerBillOnDemand
Payment Management/Payment
Use to manage payments.
- Create a Payment
- Method: postPath:
/payment
- Create a Payment Allocation for a Bill
- Method: postPath:
/paymentAllocation
- Get a Payment by ID
- Method: getPath:
/payment/{id}
- Get Payments
- Method: getPath:
/payment
Payment Management/Refund
Use to manage refunds.
- Create a Refund
- Method: postPath:
/refund
- Get a Refund by ID
- Method: getPath:
/refund/{id}
- Get Refunds
- Method: getPath:
/refund
Payment Method Management
Use for managing payment methods.
- Create a Payment Method
- Method: postPath:
/paymentMethod
- Delete a Payment Method
- Method: deletePath:
/paymentMethod/{paymentMethodId}
- Get a Payment Method by ID
- Method: getPath:
/paymentMethod/{paymentMethodId}
- Get Payment Methods
- Method: getPath:
/paymentMethod
- Get Payment Methods for an Account
- Method: getPath:
/accounts/{accountId}/paymentMethods
Prepay Balance Management/Accumulated Balances
Use for managing accumulated balances.
- Get Accumulated Balances
- Method: getPath:
/accumulatedBalance
- Get an Accumulated Balance by ID
- Method: getPath:
/accumulatedBalance/{id}
Prepay Balance Management/Adjusted Balances
Use for managing adjusted balances.
- Create an Adjusted Balance
- Method: postPath:
/adjustBalance
- Get Adjusted Balances
- Method: getPath:
/adjustBalance
- Get an Adjusted Balance by ID
- Method: getPath:
/adjustBalance/{id}
Prepay Balance Management/Balance Actions
Use for managing balance actions.
- Get a Balance Action by ID
- Method: getPath:
/balanceAction/{id}
- Get Balance Actions
- Method: getPath:
/balanceAction
Prepay Balance Management/Bucket Balances
Use for managing bucket balances.
- Create a Bucket
- Method: postPath:
/bucket
- Get Bucket Balances
- Method: getPath:
/bucket
- Get Bucket Balances by ID
- Method: getPath:
/bucket/{id}
- Update a Bucket Threshold for an Account
- Method: putPath:
/adjustThreshold/{accountId}
Prepay Balance Management/Disputed Balances
Use for managing disputed balances.
- Create a Disputed Balance
- Method: postPath:
/disputeBalance
- Get a Disputed Balance by ID
- Method: getPath:
/disputeBalance/{id}
- Get Disputed Balances
- Method: getPath:
/disputeBalance
Prepay Balance Management/Top-up Balances
Use for managing top-up balances.
- Create a Top-up Balance
- Method: postPath:
/topupBalance
- Get a Top-up Balance by ID
- Method: getPath:
/topupBalance/{id}
- Get Top-up Balances
- Method: getPath:
/topupBalance
Prepay Balance Management/Transfer Balances
Use for managing transfer balances.
- Create a Transfer Balance
- Method: postPath:
/transferBalance
- Get a Transfer Balance by ID
- Method: getPath:
/transferBalance/{id}
- Get Transfer Balances
- Method: getPath:
/transferBalance
Usage Management
Use for managing usage.
- Get Usage
- Method: getPath:
/usage
- Get Usage by ID
- Method: getPath:
/usage/{id}