Skip to content

Web Data Billing ReST Capabilities

Vikas Bodani edited this page Jul 10, 2021 · 4 revisions

Web Data Billing - ReST Capabilities (API Documentation)

Overview

Supported ReST URL Combinations of type:

HTTP Method GET

GET is used to retrieve records, for e.g. the below API returns with full details for customer record ID = 2

/customer/2

HTTP Method PUT

PUT is used to update a record. For e.g. the below API will update the Customer having ID = 2

/customer/2/edit

HTTP Method POST

POST method is used to create a new record. The below call will always be used to create a new Customer with the supplied payload.

/customer/edit

HTTP Method DELETE

DELETE is used to delete an existing record.

/customer/2

The above capabilities are supported for following resources:

  1. Customer
  2. Partner/Agent
  3. Product
  4. Discount
  5. Order
  6. Payment
  7. Invoice
  8. Account Type
  9. Meta Fields/Groups
  10. Order Status
  11. Payment Method
  12. Order Period
  13. Order Change
  14. Users