REST API Reference for Billing Care

All REST Endpoints

Accounts

The REST web service for all account-related operations.

Add a Bundle to an Account: Method: post
Path: /accounts/{id}/bundle
Add Accounts to a Hierarchy: Method: post
Path: /accounts/hierarchy/add/{id}
Add Services to an Account: Method: post
Path: /accounts/{id}/package
Create an Account: Method: post
Path: /accounts
Get Account Details: Method: get
Path: /accounts/{id}
Get Limits for an Account or Balance Group: Method: get
Path: /accounts/{id}/limits
Get Tax Details for an Account: Method: get
Path: /accounts/taxinfo/{id}
Get the Organization Hierarchy for an Account: Method: get
Path: /accounts/hierarchy/{id}
Move an Account Hierarchy: Method: post
Path: /accounts/hierarchy/move/{id}
Remove an Account from a Hierarchy: Method: delete
Path: /accounts/hierarchy/remove/{id}
Update an Account: Method: put
Path: /accounts/general
Update an Account's Tax Settings: Method: put
Path: /accounts/taxinfo/{id}
Validate an Account: Method: post
Path: /accounts/validate

Adjustments

The REST web service for account, bill, item, and event-level adjustments and their related operations.

Adjust a Bill's Currency Balance: Method: post
Path: /adjustments/bill/{id}
Adjust a Noncurrency Balance: Method: post
Path: /adjustments/noncurrency
Adjust an A/R Item's Currency Balance: Method: post
Path: /adjustments/item/{id}
Create an Account-Level Adjustment: Method: post
Path: /adjustments/account/{id}
Create an Event Adjustment: Method: post
Path: /adjustments/event
Get Adjustments for a Bill Unit: Method: get
Path: /adjustments/billunit/{id}
Get All Adjustments for an Account: Method: get
Path: /adjustments/account/{id}
Get Details About an Adjustment: Method: get
Path: /adjustments/{id}

Agreements

The REST web service for agreement-related operations.

Create Agreement: Method: post
Path: /agreements
Get Agreement: Method: get
Path: /agreements/{id}
Get Agreement State Map: Method: get
Path: /agreements/lifecyclestates
Get Agreements Associated with an Account: Method: get
Path: /agreements/association/account/{id}
Search Agreements: Method: get
Path: /agreements
Update Agreement: Method: patch
Path: /agreements/{agreementId}

Allocations

The REST web service for adjustment and payment allocation operations.

Allocate a Payment to Bill Items: Method: post
Path: /allocations/payment/{id}/items
Allocate a Payment to Bills: Method: post
Path: /allocations/payment/{id}/bills
Allocate an Adjustment to A/R Items: Method: post
Path: /allocations/adjustment/{id}/items
Allocate an Adjustment to Bills: Method: post
Path: /allocations/adjustment/{id}/bills

Authorization

Permitted API routes for the current user.

Get Permitted Routes: Method: get
Path: /authorization

Batch Payments

The REST web service for batch payment, refund, and reversal operations.

Check If a Batch File Was Processed: Method: get
Path: /batchpayments/filecount/{fileName}
Create a Batch Template: Method: post
Path: /batchpayments/batchtemplates
Delete a Batch Template: Method: delete
Path: /batchpayments/batchtemplates/{id}
Get a Batch Payment File by File Name: Method: get
Path: /batchpayments/viewfile/{fileName}
Get a Batch Template by Template ID: Method: get
Path: /batchpayments/batchtemplates/{id}
Get Automatic Batch Payments Status: Method: get
Path: /batchpayments/autoprocess
Get Batch Payment Files: Method: get
Path: /batchpayments/poll
Get Batch Payment Templates: Method: get
Path: /batchpayments/templates
Get Batch Templates: Method: get
Path: /batchpayments/batchtemplates
Get Unprocessed Batch Payment Files: Method: get
Path: /batchpayments/unprocessed
Process Batch Payments: Method: post
Path: /batchpayments/process
Start or Stop Automatic Batch Payments: Method: post
Path: /batchpayments/autoprocess/{autoProcess}
Submit a Payment Batch: Method: post
Path: /batchpayments/submit
Submit a Refund Batch: Method: post
Path: /batchrefund/submit
Submit a Reversal Batch: Method: post
Path: /batchreversal/submit
Update a Batch Template: Method: put
Path: /batchpayments/batchtemplates/{id}
Upload a Batch Payment File: Method: post
Path: /batchpayments/upload
Validate a Payment Batch: Method: post
Path: /batchpayments/validate
Validate a Refund Batch: Method: post
Path: /batchrefund/validate
Validate a Reversal Batch: Method: post
Path: /batchreversal/validate

Bill Units

The REST web service for bill unit operations.

Add a Bill Unit to a Hierarchy: Method: post
Path: /billunits/hierarchy/add/{id}
Change the Validity of a Noncurrency Resource: Method: post
Path: /billunits/balancegroups/validity/{id}
Create a Balance Transfer: Method: post
Path: /billunits/balancegroups/transferbalance
Create a Bill Unit: Method: post
Path: /billunits
Create Credit Limits for a Balance Group: Method: post
Path: /billunits/balancegroups/creditlimit/{id}
Generate a Bill Unit Summary: Method: post
Path: /billunits/bill-unit-summary
Get a Bill Unit Summary for an Account: Method: get
Path: /billunits/account/{id}/summary
Get Balance Groups for a Bill Unit: Method: get
Path: /billunits/balancegroups/{id}
Get Balance Transfer Details: Method: get
Path: /billunits/balancegroups/transferbalance
Get Balance Transfer Details by Transfer Event ID: Method: get
Path: /billunits/balancegroups/transferbalance/{id}
Get Bill Units for an Account: Method: get
Path: /billunits/account/{id}
Get Child Bill Units: Method: get
Path: /billunits/childs/{id}
Move a Balance Group: Method: post
Path: /billunits/balancegroups/move
Remove a Bill Unit from a Hierarchy: Method: post
Path: /billunits/hierarchy/remove/{id}
Update a Bill Unit for an Account: Method: put
Path: /billunits

Bills

The REST web service for billing operations.

Create a Bill on Demand: Method: post
Path: /bills/billnow/billunit/{id}
Create a Corrective Bill: Method: post
Path: /bills/correctivebill/{id}
Evaluate Bill Simulation Eligibility: Method: post
Path: /bills/simulation/evaluate
Get a Corrective Bill: Method: get
Path: /bills/correctivebill/{id}
Get A/R Actions for a Bill: Method: get
Path: /bills/{id}/ar-actions
Get All Bills for an Account: Method: get
Path: /bills/account/{id}
Get an Invoice PDF by Bill ID: Method: get
Path: /bills/invoice/{id}
Get Bill Details by Bill ID: Method: get
Path: /bills/{id}
Get Bills by Bill Unit: Method: get
Path: /bills/billunit/{id}
Register Bill Simulations: Method: post
Path: /bills/simulation/register
Simulate a Bill: Method: post
Path: /bills/simulation/simulate
Transfer a Negative Balance: Method: post
Path: /bills/{id}/balance/transfer

Collections

The REST web service for collections agent operations.

Add a Collections Action: Method: post
Path: /collections/task/insert/{id}
Add a Member to a Collections Group: Method: post
Path: /collections/group/member/{id}
Assign a Collections Agent to a Bill Unit: Method: post
Path: /collections/assignagent
Cancel a Promise-to-Pay Agreement: Method: put
Path: /collections/promisetopay/revoke/{id}
Create a Collections Group: Method: post
Path: /collections/group
Create a Promise-to-Pay Agreement for a Bill Unit: Method: put
Path: /collections/promisetopay/invoke/{id}
Delete a Collections Group: Method: delete
Path: /collections/group/{id}
Exempt a Bill Unit from Collections: Method: post
Path: /collections/exempt/{id}
Get a Collections Group by Parent Bill Unit: Method: get
Path: /collections/group/{id}
Get All Collections Profiles: Method: get
Path: /collections/profiles
Get Collections Actions: Method: get
Path: /collections/actions
Get Collections and Aging Buckets for an Account: Method: get
Path: /collections/account/{id}
Get Collections Details for an Account: Method: get
Path: /collections/details/{id}
Get Collections Group Details for an Account: Method: get
Path: /collections/group/account/{id}
Get Collections Scenarios: Method: get
Path: /collections/scenarios
Get Collections Users: Method: get
Path: /collections/users
Get Exempted Bill Units: Method: get
Path: /collections/exempt
Get History of a Collections Action: Method: get
Path: /collections/history/action/{id}
Modify an Account's Collections Action: Method: put
Path: /collections/task/{id}
Remove a Bill Unit from Collections: Method: put
Path: /collections/exit/{id}
Remove a Member from a Collections Group: Method: put
Path: /collections/group/member/{id}
Replace the Collections Scenario for a Bill Unit: Method: put
Path: /collections/scenario/replace/{id}
Unexempt a Bill Unit from Collections: Method: post
Path: /collections/unexempt/{id}
Update a Collections Group: Method: put
Path: /collections/group/{id}

Deferred Action

The REST web service for deferred actions for accounts and services.

Delete a Deferred Action: Method: delete
Path: /deferredactions/{id}
Get Deferred Actions for an Account: Method: get
Path: /deferredactions/account/{id}
Modify a Deferred Action: Method: put
Path: /deferredactions/{id}
Perform a Deferred Action: Method: post
Path: /deferredactions/{id}

Deposits

The REST web service for all deposit-related operations.

Cancel a Customer Deposit: Method: post
Path: /depositManagement/depositReversal
Create a Customer Deposit Payment: Method: post
Path: /depositManagement/depositPayment
Create a Customer Deposit with Payments: Method: post
Path: /depositManagement/customerDeposit/order
Create a Deposit Specification: Method: post
Path: /depositManagement/depositSpec
Create a Deposit Specification Profile: Method: post
Path: /depositManagement/depositspecprofile
Create an Advice of Charge Customer Deposit: Method: post
Path: /depositManagement/customerDeposit/chargeofadvice
Delete a Deposit Specification: Method: delete
Path: /depositManagement/depositSpec/{id}
Get a Customer Deposit by ID: Method: get
Path: /depositManagement/customerDeposit/{id}
Get a Deposit Refund by ID: Method: get
Path: /depositManagement/depositRefund/{id}
Get a Deposit Specification by ID: Method: get
Path: /depositManagement/depositSpec/{id}
Get a Deposit Specification Profile by ID: Method: get
Path: /depositManagement/depositspecprofile/{id}
Get a Deposit Transaction by ID: Method: get
Path: /depositManagement/depositTxn/{id}
Get All Packages: Method: get
Path: /depositManagement/packages
Get Charge Offers: Method: get
Path: /depositManagement/chargeOffer
Get Customer Deposits: Method: get
Path: /depositManagement/customerDeposit
Get Deposit Refunds: Method: get
Path: /depositManagement/depositRefund/search
Get Deposit Specification Profiles: Method: get
Path: /depositManagement/depositspecprofile
Get Deposit Specifications or Offers: Method: get
Path: /depositManagement/depositSpec
Get Deposit Transaction by Deposit: Method: get
Path: /depositManagement/depositTxn/{customerDepositRef}/events
Refund a Customer Deposit: Method: post
Path: /depositManagement/depositRefund
Release a Customer Deposit: Method: post
Path: /depositManagement/depositRelease
Transfer a Customer Deposit: Method: post
Path: /depositManagement/depositTransfer
Update a Customer Deposit: Method: patch
Path: /depositManagement/customerDeposit/{id}
Update a Deposit Refund Request: Method: patch
Path: /depositManagement/depositRefund/{id}
Update a Deposit Specification: Method: patch
Path: /depositManagement/depositSpec/{id}
Update a Deposit Specification Profile: Method: patch
Path: /depositManagement/depositspecprofile/{id}

Disputes

The REST web service for bill, item, and event-level dispute operations.

Create a Bill Dispute: Method: post
Path: /disputes/bill/{id}
Create a Settlement for a Bill Dispute: Method: post
Path: /disputes/settlement/bill/{id}
Create a Settlement for an Event Dispute: Method: post
Path: /disputes/settlement/event/{id}
Create a Settlement for an Item Dispute: Method: post
Path: /disputes/settlement/item/{id}
Create an Event Dispute: Method: post
Path: /disputes/event
Create an Item Dispute: Method: post
Path: /disputes/item/{id}
Get Notes for a Disputed Bill: Method: get
Path: /disputes/notes/{id}
Get Open Disputes for a Bill: Method: get
Path: /disputes/bill/{id}
Get Open Disputes for an Account: Method: get
Path: /disputes/account/{id}
Get Settlement Details for a Dispute: Method: get
Path: /disputes/settlement/{id}

Events

The REST web service for event-related operations.

Get Event Types: Method: get
Path: /events/schemas
Get Events: Method: get
Path: /events

Installments

The REST web service for installment operations.

Cancel an Installment Schedule: Method: post
Path: /installmentManagement/cancelInstallment
Create an Installment Proposal: Method: post
Path: /installmentManagement/installmentProposal
Create an Installment Schedule: Method: post
Path: /installmentManagement/installmentSchedule
Create an Installment Schedule Specification: Method: post
Path: /installmentManagement/installmentScheduleSpec
Get an Installment Schedule by ID: Method: get
Path: /installmentManagement/installmentSchedule/{id}
Get an Installment Schedule Specification by ID: Method: get
Path: /installmentManagement/installmentScheduleSpec/{id}
Get Bill Details by ID: Method: get
Path: /installmentManagement/installmentSchedule/bills
Get Data Dictionary Object Specifications: Method: get
Path: /installmentManagement/ddObjectSpec
Get G/L IDs: Method: get
Path: /installmentManagement/glid
Get Installment Bills: Method: get
Path: /installmentManagement/bills
Get Installment Schedule Bills: Method: get
Path: /installmentManagement/installmentSchedule/billDetails
Get Installment Schedule Specifications: Method: get
Path: /installmentManagement/installmentScheduleSpec
Get Installment Schedules: Method: get
Path: /installmentManagement/installmentSchedule
Update an Installment Schedule: Method: patch
Path: /installmentManagement/installmentSchedule/{id}
Update an Installment Schedule Specification: Method: put
Path: /installmentManagement/installmentScheduleSpec/{id}

Items

The REST web service for item-related operations.

Get a Bill Item: Method: get
Path: /items/billunit/{id}
Get A/R Actions for a Bill Item: Method: get
Path: /items/{id}/ar-actions
Get A/R Item Number: Method: get
Path: /items/{id}/itemid
Get Bill Items by Bill and Service ID: Method: get
Path: /items/bill/{id}/by-service
Get Bill Items for a Bill: Method: get
Path: /items/bill/{id}
Get Bill Items for an Account: Method: get
Path: /items/account/{id}
Get Item: Method: get
Path: /items/{id}

Loans

The REST web service for all the loan-related operations.

Create a Loan: Method: post
Path: /loans
Get Loan Profiles: Method: get
Path: /loans/loanProfiles
Get Loans for an Account: Method: get
Path: /loans/account/{id}

MCP

Exposes tools and resources through MCP for AI agents to discover and use.

Access MCP Tools and Resources: Method: post
Path: /mcp

Newsfeed

The REST web service for Newsfeed operations.

Get Newsfeeds for the Account: Method: get
Path: /newsfeed

Notes

The REST web service for note operations.

Create a Note: Method: post
Path: /notes
Get Notes for a Bill Item: Method: get
Path: /notes/item/{id}
Get Notes for a Bill Unit: Method: get
Path: /notes/billunit/{id}
Get Notes for a Transaction: Method: get
Path: /notes/transaction/{id}
Get Notes for an Account: Method: get
Path: /notes/account/{id}

Notifications

The REST web service for all notification-event-related operations

Create a Notification Specification: Method: post
Path: /notificationManagement/notificationSpec
Get a Notification Specification by ID: Method: get
Path: /notificationManagement/notificationSpec/{id}
Get Delivery Methods: Method: get
Path: /notificationManagement/deliveryMethod
Get Notification Events: Method: get
Path: /notificationManagement/notificationEvent
Get Notification Specifications: Method: get
Path: /notificationManagement/notificationSpec
Update a Notification Specification: Method: patch
Path: /notificationManagement/notificationSpec/{id}

Payment Methods

The REST web service for payment method operations.

Create a Payment Method: Method: post
Path: /paymentmethods
Delete a Payment Method: Method: delete
Path: /paymentmethods/{id}
Get All Creditors: Method: get
Path: /paymentmethods/sepa/creditors
Get Payment Methods for an Account: Method: get
Path: /paymentmethods/account/{id}
Update a Payment Method: Method: put
Path: /paymentmethods/{id}

Payments

The REST web service for regular and suspended payment operations.

Allocate a Suspended Payment to an Account: Method: post
Path: /payments/suspense/allocate
Assign a Handler to Suspended Payment: Method: post
Path: /payments/suspense/assignhandler
Create a Payment: Method: post
Path: /payments
Create a Suspended Payment: Method: post
Path: /payments/suspense/payment
Get Audit Trails for a Transaction: Method: get
Path: /payments/audit/{id}
Get Details for a Payment: Method: get
Path: /payments/{id}
Get Payment Records: Method: get
Path: /payments
Get Payments for a Bill: Method: get
Path: /payments/bill/{id}
Get Suspense Accounts: Method: get
Path: /payments/suspense/accounts
Get Unallocated Payments for a Bill Unit: Method: get
Path: /payments/billunit/{id}
Get Unallocated Payments for an Account: Method: get
Path: /payments/account/{id}
Get Users with Suspend Permission: Method: get
Path: /payments/suspense/users
Reverse a Payment: Method: post
Path: /payments/reverse
Withdraw a Posted Payment into Suspense: Method: post
Path: /payments/suspense/withdraw

Profiles

The REST web service for profile operations.

Create a Profile: Method: post
Path: /profiles
Delete a Profile by Account or Service: Method: delete
Path: /profiles
Delete a Profile by ID: Method: delete
Path: /profiles/{id}
Get Profile Details: Method: get
Path: /profiles/{id}
Get Profiles for an Account: Method: get
Path: /profiles/account/{id}
Get Promotion Types (ERAs): Method: get
Path: /profiles/promotiontypes
Update a Profile: Method: put
Path: /profiles

Record Requests

Create, retrieve, and delete request records in BRM.

Delete a Request: Method: delete
Path: /request/{id}
Get Recorded Requests: Method: get
Path: /request
Record a Request: Method: post
Path: /request

Refunds

The REST web service for account and bill refund operations.

Create a Full Refund for a Bill: Method: post
Path: /refunds/bill/{id}/fullRefund
Create a Refund for an Account: Method: post
Path: /refunds/account/{id}
Get Refund Details: Method: get
Path: /refunds/{id}
Get Refundable Items for an Account: Method: get
Path: /refunds/items/account/{id}
Refund Multiple Bills: Method: post
Path: /refunds/bills
Refund Part of a Bill: Method: post
Path: /refunds/bill/{id}/partialRefund

Services

The REST web service for service-related operations.

Get Count for Service Types: Method: get
Path: /services/account/{id}/count
Get Details for a Service: Method: get
Path: /services/{id}/serviceprofile
Get Friendly Service Names: Method: get
Path: /services/friendlynames
Get Lifecycle States: Method: get
Path: /services/lifecyclestates
Update Details for a Service: Method: put
Path: /services/serviceprofile
Update Service and ERAs: Method: put
Path: /services/serviceAndEras

Sharing

The REST web service for profile, charge, and discount sharing operations.

Add Members to a Group: Method: post
Path: /sharing/members/{id}
Add or Delete Services for Members: Method: put
Path: /sharing/group/{id}/members
Create a Sharing Group: Method: post
Path: /sharing
Delete a Sharing Group: Method: delete
Path: /sharing/{id}
Get a Profile Sharing Group: Method: get
Path: /sharing/profiles/{id}
Get Available Discount Shares for Account: Method: get
Path: /sharing/sponsors/discount/{id}
Get Charges Added to Sharing Groups: Method: get
Path: /sharing/sponsors/charge
Get Group Ownership Details: Method: get
Path: /sharing/group/{id}
Get Membership Details for an Account: Method: get
Path: /sharing/membership/{id}
Get Ownership Details for an Account: Method: get
Path: /sharing/{id}
Get Sharing Group Member Details: Method: get
Path: /sharing/{id}/members
Get Sharing Group Member Types: Method: get
Path: /sharing/{id}/members/types
Get Sharing Group Members: Method: get
Path: /sharing/members/{id}
Remove Members from a Group: Method: put
Path: /sharing/members/account/{id}
Search Accounts and Services for Sharing: Method: get
Path: /sharing/accounts
Update a Sharing Group: Method: put
Path: /sharing/{id}
Update Member Shared Services in a Group: Method: put
Path: /sharing/members/{id}
Update Membership in Sharing Group: Method: put
Path: /sharing/members/priority

Status Update

The REST web service for status-related operations on accounts, services, and offers.

Update a Service's Status: Method: put
Path: /statusupdate/service/{id}
Update an Account's Status: Method: put
Path: /statusupdate/account/{id}
Update an Offer's Status: Method: put
Path: /statusupdate/offers

Subscriptions

The REST web service for subscription-related operations.

Cancel a Bundle: Method: post
Path: /subscriptions/cancel/bundle
Cancel a Subscriber's Contract: Method: post
Path: /subscriptions/cancel/contract
Create Dynamic Charges for a Purchased Product: Method: post
Path: /subscriptions/offer/{id}/overridecharges
Delete Dynamic Charges for a Purchased Product: Method: delete
Path: /subscriptions/offer/{id}/overridecharges
Get Agreement Offer Details: Method: get
Path: /subscriptions/agreement/offer/{id}
Get Bundles and Offers for Services: Method: post
Path: /subscriptions/service/bundleoffers
Get Bundles for a Service: Method: get
Path: /subscriptions/service/{id}/bundleoffers
Get Bundles for an Account: Method: get
Path: /subscriptions/purchasedbundles/{id}
Get Bundles for Purchase: Method: get
Path: /subscriptions/bundles/{id}
Get Bundles for Transition: Method: get
Path: /subscriptions/bundles/{id}/transition
Get Contracts for an Account: Method: get
Path: /subscriptions/account/{id}/packages
Get Customized Account Offers: Method: get
Path: /subscriptions/account/{id}/customizedoffers
Get Customized Charge Offers for a Service: Method: get
Path: /subscriptions/service/{id}/customizedoffers
Get Offer Details: Method: get
Path: /subscriptions/offers/{offerId}
Get Offers for Purchase: Method: get
Path: /subscriptions/offers
Get Packages for an Account: Method: get
Path: /subscriptions/purchasedpackages/{id}
Get Packages for Purchase: Method: get
Path: /subscriptions/packages
Get Packages for Transition: Method: get
Path: /subscriptions/packages/{id}/transition
Get Purchased Account-Level Bundles: Method: get
Path: /subscriptions/account/{id}/bundledetails
Get Purchased Bundles for a Service: Method: get
Path: /subscriptions/service/{id}/bundledetails
Get Purchased Contracts for an Account: Method: get
Path: /subscriptions/account/{id}/purchasedcontracts
Get Service Details: Method: get
Path: /subscriptions/service/{id}
Get Services for a Contract: Method: get
Path: /subscriptions/contracts/{id}/services
Get Services for an Account: Method: get
Path: /subscriptions/account/{id}
Get Subscription Terms for Bundles: Method: post
Path: /subscriptions/deals/terms
Get Subscription Transition Paths: Method: get
Path: /subscriptions/transitionPaths
Get Transition Types: Method: get
Path: /subscriptions/transitiontypes
Get Unpurchased Bundles for a Package: Method: post
Path: /subscriptions/unpurchased/bundles/{packageId}
Modify a Contract's Auto-Renewal Preferences: Method: put
Path: /subscriptions/contract
Preview Cancellation Charges: Method: post
Path: /subscriptions/preview/cancellation/charges
Transition Account to New Bundle: Method: put
Path: /subscriptions/account/{id}/bundle/transition
Transition Account to New Package: Method: put
Path: /subscriptions/account/{id}/package/transition
Update Dynamic Charges for a Purchased Product: Method: patch
Path: /subscriptions/offer/{id}/overridecharges
Update Offer Details for a Purchased Product or Discount: Method: put
Path: /subscriptions/offerdetails/{id}

Write Offs

The REST web service for account, bill, and item write-off operations.

Create a Write-Off Reversal for an Account: Method: post
Path: /writeoffs/reverse/account/{id}
Get Write-Off Details: Method: get
Path: /writeoffs/{id}
Get Write-Offs for an Account: Method: get
Path: /writeoffs/account/{id}
Write Off a Bill: Method: post
Path: /writeoffs/bill/{id}
Write Off an Account: Method: post
Path: /writeoffs/account/{id}
Write Off an Item: Method: post
Path: /writeoffs/item/{id}