All REST Endpoints
Accounts
The REST web service for all account-related operations.
- Add a Bundle to an Account
- Method: postPath:
/bcws/webresources/v1.0/accounts/{id}/bundle
- Add Accounts to a Hierarchy
- Method: postPath:
/bcws/webresources/v1.0/accounts/hierarchy/add/{id}
- Add Services to an Account
- Method: postPath:
/bcws/webresources/v1.0/accounts/{id}/package
- Create an Account
- Method: postPath:
/bcws/webresources/v1.0/accounts
- Get Account Details
- Method: getPath:
/bcws/webresources/v1.0/accounts/{id}
- Get Limits for an Account or Balance Group
- Method: getPath:
/bcws/webresources/v1.0/accounts/{id}/limits
- Get Tax Details for an Account
- Method: getPath:
/bcws/webresources/v1.0/accounts/taxinfo/{id}
- Get the Organization Hierarchy for an Account
- Method: getPath:
/bcws/webresources/v1.0/accounts/hierarchy/{id}
- Move an Account Hierarchy
- Method: postPath:
/bcws/webresources/v1.0/accounts/hierarchy/move/{id}
- Remove an Account from a Hierarchy
- Method: deletePath:
/bcws/webresources/v1.0/accounts/hierarchy/remove/{id}
- Update an Account
- Method: putPath:
/bcws/webresources/v1.0/accounts/general
- Update an Account's Tax Settings
- Method: putPath:
/bcws/webresources/v1.0/accounts/taxinfo/{id}
- Validate an Account
- Method: postPath:
/bcws/webresources/v1.0/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: postPath:
/bcws/webresources/v1.0/adjustments/bill/{id}
- Adjust a Noncurrency Balance
- Method: postPath:
/bcws/webresources/v1.0/adjustments/noncurrency
- Adjust an A/R Item's Currency Balance
- Method: postPath:
/bcws/webresources/v1.0/adjustments/item/{id}
- Create an Account-Level Adjustment
- Method: postPath:
/bcws/webresources/v1.0/adjustments/account/{id}
- Create an Event Adjustment
- Method: postPath:
/bcws/webresources/v1.0/adjustments/event
- Get Adjustments for a Bill Unit
- Method: getPath:
/bcws/webresources/v1.0/adjustments/billunit/{id}
- Get All Adjustments for an Account
- Method: getPath:
/bcws/webresources/v1.0/adjustments/account/{id}
- Get Details about an Adjustment
- Method: getPath:
/bcws/webresources/v1.0/adjustments/{id}
Allocations
The REST web service for adjustment and payment allocation operations.
- Allocate a Payment to Bill Items
- Method: postPath:
/bcws/webresources/v1.0/allocations/payment/{id}/items
- Allocate a Payment to Bills
- Method: postPath:
/bcws/webresources/v1.0/allocations/payment/{id}/bills
- Allocate an Adjustment to A/R Items
- Method: postPath:
/bcws/webresources/v1.0/allocations/adjustment/{id}/items
- Allocate an Adjustment to Bills
- Method: postPath:
/bcws/webresources/v1.0/allocations/adjustment/{id}/bills
Authentication
The REST web service for authentication operations.
- Get an OAuth Access Token
- Method: getPath:
/bcws/webresources/v1.0/authentication/queryAccessToken
Batch Payments
The REST web service for batch payment operations.
- Check If a Batch File Was Processed
- Method: getPath:
/bcws/webresources/v1.0/batchpayments/filecount/{fileName}
- Get a Batch Payment File by File Name
- Method: getPath:
/bcws/webresources/v1.0/batchpayments/viewfile/{fileName}
- Get Batch Payment Files
- Method: getPath:
/bcws/webresources/v1.0/batchpayments/poll
- Get Batch Payment Templates
- Method: getPath:
/bcws/webresources/v1.0/batchpayments/templates
- Get Unprocessed Batch Payment Files
- Method: getPath:
/bcws/webresources/v1.0/batchpayments/unprocessed
- Process Batch Payments
- Method: postPath:
/bcws/webresources/v1.0/batchpayments/process
- Start or Stop Automatic Batch Payments
- Method: postPath:
/bcws/webresources/v1.0/batchpayments/autoprocess/{autoProcess}
- Upload a Batch Payment File
- Method: postPath:
/bcws/webresources/v1.0/batchpayments/upload
Bill Units
The REST web service for bill unit operations.
- Add a Bill Unit to a Hierarchy
- Method: postPath:
/bcws/webresources/v1.0/billunits/hierarchy/add/{id}
- Change the Validity of a Noncurrency Resource
- Method: postPath:
/bcws/webresources/v1.0/billunits/balancegroups/validity/{id}
- Create a Balance Transfer
- Method: postPath:
/bcws/webresources/v1.0/billunits/balancegroups/transferbalance
- Create a Bill Unit
- Method: postPath:
/bcws/webresources/v1.0/billunits
- Create Credit Limits for a Balance Group
- Method: postPath:
/bcws/webresources/v1.0/billunits/balancegroups/creditlimit/{id}
- Generate a Bill Unit Summary
- Method: postPath:
/bcws/webresources/v1.0/billunits/bill-unit-summary
- Get a Bill Unit Summary for an Account
- Method: getPath:
/bcws/webresources/v1.0/billunits/account/{id}/summary
- Get Balance Groups for a Bill Unit
- Method: getPath:
/bcws/webresources/v1.0/billunits/balancegroups/{id}
- Get Balance Transfer Details
- Method: getPath:
/bcws/webresources/v1.0/billunits/balancegroups/transferbalance
- Get Balance Transfer Details by Transfer Event ID
- Method: getPath:
/bcws/webresources/v1.0/billunits/balancegroups/transferbalance/{id}
- Get Bill Units for an Account
- Method: getPath:
/bcws/webresources/v1.0/billunits/account/{id}
- Get Child Bill Units
- Method: getPath:
/bcws/webresources/v1.0/billunits/childs/{id}
- Move a Balance Group
- Method: postPath:
/bcws/webresources/v1.0/billunits/balancegroups/move
- Remove a Bill Unit from a Hierarchy
- Method: postPath:
/bcws/webresources/v1.0/billunits/hierarchy/remove/{id}
- Update a Bill Unit for an Account
- Method: putPath:
/bcws/webresources/v1.0/billunits
Bills
The REST web service for billing operations.
- Create a Bill On Demand
- Method: postPath:
/bcws/webresources/v1.0/bills/billnow/billunit/{id}
- Create a Corrective Bill
- Method: postPath:
/bcws/webresources/v1.0/bills/correctivebill/{id}
- Get a Corrective Bill
- Method: getPath:
/bcws/webresources/v1.0/bills/correctivebill/{id}
- Get A/R Actions for a Bill
- Method: getPath:
/bcws/webresources/v1.0/bills/{id}/ar-actions
- Get All Bills for an Account
- Method: getPath:
/bcws/webresources/v1.0/bills/account/{id}
- Get an Invoice PDF by Bill ID
- Method: getPath:
/bcws/webresources/v1.0/bills/invoice/{id}
- Get Bill Details by Bill ID
- Method: getPath:
/bcws/webresources/v1.0/bills/{id}
- Get Bills by Bill Unit
- Method: getPath:
/bcws/webresources/v1.0/bills/billunit/{id}
- Transfer a Negative Balance
- Method: postPath:
/bcws/webresources/v1.0/bills/{id}/balance/transfer
Collections
The REST web service for collections agent operations.
- Add a Collections Action
- Method: postPath:
/bcws/webresources/v1.0/collections/task/insert/{id}
- Add a Member to a Collections Group
- Method: postPath:
/bcws/webresources/v1.0/collections/group/member/{id}
- Assign a Collections Agent to a Bill Unit
- Method: postPath:
/bcws/webresources/v1.0/collections/assignagent
- Cancel a Promise-to-Pay Agreement
- Method: putPath:
/bcws/webresources/v1.0/collections/promisetopay/revoke/{id}
- Create a Collections Group
- Method: postPath:
/bcws/webresources/v1.0/collections/group
- Create a Promise-to-Pay Agreement for a Bill Unit
- Method: putPath:
/bcws/webresources/v1.0/collections/promisetopay/invoke/{id}
- Delete a Collections Group
- Method: deletePath:
/bcws/webresources/v1.0/collections/group/{id}
- Exempt a Bill Unit from Collections
- Method: postPath:
/bcws/webresources/v1.0/collections/exempt/{id}
- Get a Collections Group by Parent Bill Unit
- Method: getPath:
/bcws/webresources/v1.0/collections/group/{id}
- Get All Collections Profiles
- Method: getPath:
/bcws/webresources/v1.0/collections/profiles
- Get Collections Actions
- Method: getPath:
/bcws/webresources/v1.0/collections/actions
- Get Collections and Aging Buckets for an Account
- Method: getPath:
/bcws/webresources/v1.0/collections/account/{id}
- Get Collections Details for an Account
- Method: getPath:
/bcws/webresources/v1.0/collections/details/{id}
- Get Collections Group Details for an Account
- Method: getPath:
/bcws/webresources/v1.0/collections/group/account/{id}
- Get Collections Scenarios
- Method: getPath:
/bcws/webresources/v1.0/collections/scenarios
- Get Collections Users
- Method: getPath:
/bcws/webresources/v1.0/collections/users
- Get Exempted Bill Units
- Method: getPath:
/bcws/webresources/v1.0/collections/exempt
- Get History of a Collections Action
- Method: getPath:
/bcws/webresources/v1.0/collections/history/action/{id}
- Modify an Account's Collections Action
- Method: putPath:
/bcws/webresources/v1.0/collections/task/{id}
- Remove a Bill Unit from Collections
- Method: putPath:
/bcws/webresources/v1.0/collections/exit/{id}
- Remove a Member from a Collections Group
- Method: putPath:
/bcws/webresources/v1.0/collections/group/member/{id}
- Replace the Collections Scenario for a Bill Unit
- Method: putPath:
/bcws/webresources/v1.0/collections/scenario/replace/{id}
- Unexempt a Bill Unit from Collections
- Method: postPath:
/bcws/webresources/v1.0/collections/unexempt/{id}
- Update a Collections Group
- Method: putPath:
/bcws/webresources/v1.0/collections/group/{id}
Deferred Action
The REST web service for deferred actions for accounts and services.
- Delete a Deferred Action
- Method: deletePath:
/bcws/webresources/v1.0/deferredactions/{id}
- Get Deferred Actions for an Account
- Method: getPath:
/bcws/webresources/v1.0/deferredactions/account/{id}
- Modify a Deferred Action
- Method: putPath:
/bcws/webresources/v1.0/deferredactions/{id}
- Perform a Deferred Action
- Method: postPath:
/bcws/webresources/v1.0/deferredactions/{id}
Deposits
The REST web service for all deposit-related operations.
- Cancel a Customer Deposit
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositReversal
- Create a Customer Deposit Payment
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositPayment
- Create a Customer Deposit with Payments
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/customerDeposit/order
- Create a Deposit Specification
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositSpec
- Create a Deposit Specification Profile
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositspecprofile
- Create an Advice of Charge Customer Deposit
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/customerDeposit/chargeofadvice
- Delete a Deposit Specification
- Method: deletePath:
/bcws/webresources/v1.0/depositManagement/depositSpec/{id}
- Get a Customer Deposit by ID
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/customerDeposit/{id}
- Get a Deposit Refund by ID
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositRefund/{id}
- Get a Deposit Specification by ID
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositSpec/{id}
- Get a Deposit Specification Profile by ID
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositspecprofile/{id}
- Get a Deposit Transaction by ID
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositTxn/{id}
- Get All Packages
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/packages
- Get Charge Offers
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/chargeOffer
- Get Customer Deposits
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/customerDeposit
- Get Deposit Refunds
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositRefund/search
- Get Deposit Specification Profiles
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositspecprofile
- Get Deposit Specifications or Offers
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositSpec
- Get Deposit Transaction by Deposit
- Method: getPath:
/bcws/webresources/v1.0/depositManagement/depositTxn/{customerDepositRef}/events
- Refund a Customer Deposit
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositRefund
- Release a Customer Deposit
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositRelease
- Transfer a Customer Deposit
- Method: postPath:
/bcws/webresources/v1.0/depositManagement/depositTransfer
- Update a Customer Deposit
- Method: patchPath:
/bcws/webresources/v1.0/depositManagement/customerDeposit/{id}
- Update a Deposit Refund Request
- Method: patchPath:
/bcws/webresources/v1.0/depositManagement/depositRefund/{id}
- Update a Deposit Specification
- Method: patchPath:
/bcws/webresources/v1.0/depositManagement/depositSpec/{id}
- Update a Deposit Specification Profile
- Method: patchPath:
/bcws/webresources/v1.0/depositManagement/depositspecprofile/{id}
Disputes
The REST web service for bill, item, and event-level dispute operations.
- Create a Bill Dispute
- Method: postPath:
/bcws/webresources/v1.0/disputes/bill/{id}
- Create a Settlement for a Bill Dispute
- Method: postPath:
/bcws/webresources/v1.0/disputes/settlement/bill/{id}
- Create a Settlement for an Event Dispute
- Method: postPath:
/bcws/webresources/v1.0/disputes/settlement/event/{id}
- Create a Settlement for an Item Dispute
- Method: postPath:
/bcws/webresources/v1.0/disputes/settlement/item/{id}
- Create an Event Dispute
- Method: postPath:
/bcws/webresources/v1.0/disputes/event
- Create an Item Dispute
- Method: postPath:
/bcws/webresources/v1.0/disputes/item/{id}
- Get Notes for a Disputed Bill
- Method: getPath:
/bcws/webresources/v1.0/disputes/notes/{id}
- Get Open Disputes for a Bill
- Method: getPath:
/bcws/webresources/v1.0/disputes/bill/{id}
- Get Open Disputes for an Account
- Method: getPath:
/bcws/webresources/v1.0/disputes/account/{id}
- Get Settlement Details for a Dispute
- Method: getPath:
/bcws/webresources/v1.0/disputes/settlement/{id}
Installments
The REST web service for installment operations.
- Cancel an Installment Schedule
- Method: postPath:
/bcws/webresources/v1.0/installmentManagement/cancelInstallment
- Create an Installment Proposal
- Method: postPath:
/bcws/webresources/v1.0/installmentManagement/installmentProposal
- Create an Installment Schedule
- Method: postPath:
/bcws/webresources/v1.0/installmentManagement/installmentSchedule
- Create an Installment Schedule Specification
- Method: postPath:
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec
- Get an Installment Schedule by ID
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/installmentSchedule/{id}
- Get an Installment Schedule Specification by ID
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec/{id}
- Get Bill Details by ID
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/installmentSchedule/bills
- Get Data Dictionary Object Specifications
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/ddObjectSpec
- Get G/L IDs
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/glid
- Get Installment Bills
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/bills
- Get Installment Schedule Bills
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/installmentSchedule/billDetails
- Get Installment Schedule Specifications
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec
- Get Installment Schedules
- Method: getPath:
/bcws/webresources/v1.0/installmentManagement/installmentSchedule
- Update an Installment Schedule
- Method: patchPath:
/bcws/webresources/v1.0/installmentManagement/installmentSchedule/{id}
- Update an Installment Schedule Specification
- Method: putPath:
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec/{id}
Items
The REST web service for item-related operations.
- Get a Bill Item
- Method: getPath:
/bcws/webresources/v1.0/items/billunit/{id}
- Get A/R Actions for a Bill Item
- Method: getPath:
/bcws/webresources/v1.0/items/{id}/ar-actions
- Get A/R Item Number
- Method: getPath:
/bcws/webresources/v1.0/items/{id}/itemid
- Get Bill Items by Bill and Service ID
- Method: getPath:
/bcws/webresources/v1.0/items/bill/{id}/by-service
- Get Bill Items for a Bill
- Method: getPath:
/bcws/webresources/v1.0/items/bill/{id}
- Get Bill Items for an Account
- Method: getPath:
/bcws/webresources/v1.0/items/account/{id}
Loans
The REST web service for all the loan-related operations.
- Create a Loan
- Method: postPath:
/bcws/webresources/v1.0/loans
- Get Loan Profiles
- Method: getPath:
/bcws/webresources/v1.0/loans/loanProfiles
- Get Loans for an Account
- Method: getPath:
/bcws/webresources/v1.0/loans/account/{id}
Notes
The REST web service for note operations.
- Create a Note
- Method: postPath:
/bcws/webresources/v1.0/notes
- Get Notes for a Bill Item
- Method: getPath:
/bcws/webresources/v1.0/notes/item/{id}
- Get Notes for a Bill Unit
- Method: getPath:
/bcws/webresources/v1.0/notes/billunit/{id}
- Get Notes for a Transaction
- Method: getPath:
/bcws/webresources/v1.0/notes/transaction/{id}
- Get Notes for an Account
- Method: getPath:
/bcws/webresources/v1.0/notes/account/{id}
Notifications
The REST web service for all notification-event-related operations
- Create a Notification Specification
- Method: postPath:
/bcws/webresources/v1.0/notificationManagement/notificationSpec
- Get a Notification Specification by ID
- Method: getPath:
/bcws/webresources/v1.0/notificationManagement/notificationSpec/{id}
- Get Delivery Methods
- Method: getPath:
/bcws/webresources/v1.0/notificationManagement/deliveryMethod
- Get Notification Events
- Method: getPath:
/bcws/webresources/v1.0/notificationManagement/notificationEvent
- Get Notification Specifications
- Method: getPath:
/bcws/webresources/v1.0/notificationManagement/notificationSpec
- Update a Notification Specification
- Method: patchPath:
/bcws/webresources/v1.0/notificationManagement/notificationSpec/{id}
Payment Methods
The REST web service for payment method operations.
- Create a Payment Method
- Method: postPath:
/bcws/webresources/v1.0/paymentmethods
- Delete a Payment Method
- Method: deletePath:
/bcws/webresources/v1.0/paymentmethods/{id}
- Get All Creditors
- Method: getPath:
/bcws/webresources/v1.0/paymentmethods/sepa/creditors
- Get Payment Methods for an Account
- Method: getPath:
/bcws/webresources/v1.0/paymentmethods/account/{id}
- Update a Payment Method
- Method: putPath:
/bcws/webresources/v1.0/paymentmethods/{id}
Payments
The REST web service for regular and suspended payment operations.
- Allocate a Suspended Payment to an Account
- Method: postPath:
/bcws/webresources/v1.0/payments/suspense/allocate
- Assign a Handler to Suspended Payment
- Method: postPath:
/bcws/webresources/v1.0/payments/suspense/assignhandler
- Create a Payment
- Method: postPath:
/bcws/webresources/v1.0/payments
- Create a Suspended Payment
- Method: postPath:
/bcws/webresources/v1.0/payments/suspense/payment
- Get Audit Trails for a Transaction
- Method: getPath:
/bcws/webresources/v1.0/payments/audit/{id}
- Get Details for a Payment
- Method: getPath:
/bcws/webresources/v1.0/payments/{id}
- Get Payments for a Bill
- Method: getPath:
/bcws/webresources/v1.0/payments/bill/{id}
- Get Suspense Accounts
- Method: getPath:
/bcws/webresources/v1.0/payments/suspense/accounts
- Get Unallocated Payments for a Bill Unit
- Method: getPath:
/bcws/webresources/v1.0/payments/billunit/{id}
- Get Unallocated Payments for an Account
- Method: getPath:
/bcws/webresources/v1.0/payments/account/{id}
- Get Users with Suspend Permission
- Method: getPath:
/bcws/webresources/v1.0/payments/suspense/users
- Reverse a Payment
- Method: postPath:
/bcws/webresources/v1.0/payments/reverse
- Withdraw a Posted Payment into Suspense
- Method: postPath:
/bcws/webresources/v1.0/payments/suspense/withdraw
Profiles
The REST web service for profile operations.
- Create a Profile
- Method: postPath:
/bcws/webresources/v1.0/profiles
- Delete a Profile by Account or Service
- Method: deletePath:
/bcws/webresources/v1.0/profiles
- Delete a Profile by ID
- Method: deletePath:
/bcws/webresources/v1.0/profiles/{id}
- Get Profile Details
- Method: getPath:
/bcws/webresources/v1.0/profiles/{id}
- Get Profiles for an Account
- Method: getPath:
/bcws/webresources/v1.0/profiles/account/{id}
- Update a Profile
- Method: putPath:
/bcws/webresources/v1.0/profiles
Record Requests
Records given request in BRM
- Delete a Request
- Method: deletePath:
/bcws/webresources/v1.0/request/{id}
- Get Recorded Requests
- Method: getPath:
/bcws/webresources/v1.0/request
- Record a Request
- Method: postPath:
/bcws/webresources/v1.0/request
Refunds
The REST web service for account and bill refund operations.
- Create a Full Refund for a Bill
- Method: postPath:
/bcws/webresources/v1.0/refunds/bill/{id}/fullRefund
- Create a Refund for an Account
- Method: postPath:
/bcws/webresources/v1.0/refunds/account/{id}
- Get Refund Details
- Method: getPath:
/bcws/webresources/v1.0/refunds/{id}
- Get Refundable Items for an Account
- Method: getPath:
/bcws/webresources/v1.0/refunds/items/account/{id}
- Refund Multiple Bills
- Method: postPath:
/bcws/webresources/v1.0/refunds/bills
- Refund Part of a Bill
- Method: postPath:
/bcws/webresources/v1.0/refunds/bill/{id}/partialRefund
Services
The REST web service for service-related operations.
- Get Count for Service Types
- Method: getPath:
/bcws/webresources/v1.0/services/account/{id}/count
- Get Details for a Service
- Method: getPath:
/bcws/webresources/v1.0/services/{id}/serviceprofile
- Get Friendly Service Names
- Method: getPath:
/bcws/webresources/v1.0/services/friendlynames
- Get Life Cycle States
- Method: getPath:
/bcws/webresources/v1.0/services/lifecyclestates
- Update Details for a Service
- Method: putPath:
/bcws/webresources/v1.0/services/serviceprofile
- Update Service And ERAs
- Method: putPath:
/bcws/webresources/v1.0/services/serviceAndEras
Sharing
The REST web service for profile, charge, and discount sharing operations.
- Add Members to a Group
- Method: postPath:
/bcws/webresources/v1.0/sharing/members/{id}
- Create a Sharing Group
- Method: postPath:
/bcws/webresources/v1.0/sharing
- Delete a Sharing Group
- Method: deletePath:
/bcws/webresources/v1.0/sharing/{id}
- Get a Profile Sharing Group
- Method: getPath:
/bcws/webresources/v1.0/sharing/profiles/{id}
- Get Available Discount Shares for Account
- Method: getPath:
/bcws/webresources/v1.0/sharing/sponsors/discount/{id}
- Get Charges Added to Sharing Groups
- Method: getPath:
/bcws/webresources/v1.0/sharing/sponsors/charge
- Get Group Ownership Details
- Method: getPath:
/bcws/webresources/v1.0/sharing/group/{id}
- Get Members of a Group
- Method: getPath:
/bcws/webresources/v1.0/sharing/members/{id}
- Get Membership Details for an Account
- Method: getPath:
/bcws/webresources/v1.0/sharing/membership/{id}
- Get Ownership Details for an Account
- Method: getPath:
/bcws/webresources/v1.0/sharing/{id}
- Remove Members from a Group
- Method: putPath:
/bcws/webresources/v1.0/sharing/members/account/{id}
- Update a Sharing Group
- Method: putPath:
/bcws/webresources/v1.0/sharing/{id}
- Update Membership in Sharing Group
- Method: putPath:
/bcws/webresources/v1.0/sharing/members/priority
- Update Shared Services for a Member
- Method: putPath:
/bcws/webresources/v1.0/sharing/members/{id}
Status Update
The REST web service for status-related operations on accounts, services, and offers.
- Update a Service's Status
- Method: putPath:
/bcws/webresources/v1.0/statusupdate/service/{id}
- Update an Account's Status
- Method: putPath:
/bcws/webresources/v1.0/statusupdate/account/{id}
- Update an Offer's Status
- Method: putPath:
/bcws/webresources/v1.0/statusupdate/offers
Subscriptions
The REST web service for subscription-related operations.
- Cancel a Bundle
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/cancel/bundle
- Cancel a Subscriber's Contract
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/cancel/contract
- Create Dynamic Charges for a Purchased Product
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/offer/{id}/overridecharges
- Delete Dynamic Charges for a Purchased Product
- Method: deletePath:
/bcws/webresources/v1.0/subscriptions/offer/{id}/overridecharges
- Get Bundles and Offers for Services
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/service/bundleoffers
- Get Bundles for a Service
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/service/{id}/bundleoffers
- Get Bundles for an Account
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/purchasedbundles/{id}
- Get Bundles for Purchase
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/bundles/{id}
- Get Bundles for Transition
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/bundles/{id}/transition
- Get Contracts for an Account
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/account/{id}/packages
- Get Customized Account Offers
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/account/{id}/customizedoffers
- Get Customized Charge Offers for a Service
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/service/{id}/customizedoffers
- Get Offer Details
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/offers/{offerId}
- Get Packages for an Account
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/purchasedpackages/{id}
- Get Packages for Purchase
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/packages
- Get Packages for Transition
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/packages/{id}/transition
- Get Purchased Account-Level Bundles
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/account/{id}/bundledetails
- Get Purchased Bundles for a Service
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/service/{id}/bundledetails
- Get Service Details
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/service/{id}
- Get Services for an Account
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/account/{id}
- Get Subscription Terms For Bundles
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/deals/terms
- Get Transition Types
- Method: getPath:
/bcws/webresources/v1.0/subscriptions/transitiontypes
- Get Unpurchased Bundles for a Package
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/unpurchased/bundles/{packageId}
- Modify a Contract's Auto-Renewal Preferences
- Method: putPath:
/bcws/webresources/v1.0/subscriptions/contract
- Preview Cancellation Charges
- Method: postPath:
/bcws/webresources/v1.0/subscriptions/preview/cancellation/charges
- Transition Account to New Bundle
- Method: putPath:
/bcws/webresources/v1.0/subscriptions/account/{id}/bundle/transition
- Transition Account to New Package
- Method: putPath:
/bcws/webresources/v1.0/subscriptions/account/{id}/package/transition
- Update Dynamic Charges for a Purchased Product
- Method: patchPath:
/bcws/webresources/v1.0/subscriptions/offer/{id}/overridecharges
- Update Offer Details for a Purchased Product or Discount
- Method: putPath:
/bcws/webresources/v1.0/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: postPath:
/bcws/webresources/v1.0/writeoffs/reverse/account/{id}
- Get Write-Off Details
- Method: getPath:
/bcws/webresources/v1.0/writeoffs/{id}
- Get Write-Offs for an Account
- Method: getPath:
/bcws/webresources/v1.0/writeoffs/account/{id}
- Write Off a Bill
- Method: postPath:
/bcws/webresources/v1.0/writeoffs/bill/{id}
- Write Off an Account
- Method: postPath:
/bcws/webresources/v1.0/writeoffs/account/{id}
- Write Off an Item
- Method: postPath:
/bcws/webresources/v1.0/writeoffs/item/{id}