go back Home

CustomerService

This service provides methods for retrieving and updating customer records. Several reports scoped to individual customers are available too.

Operations

name role description
/customers
/customers
GET /customers Users Retrieves a List of customers with a full or partial name match to the given query.
GET /customers/new Users Creates a customer object with all configured defaults set. This doesn't create a record in the database. Instead, callers of this method can edit the returned object and then pass it back to the create method to actually insert the record in the database.
GET /customers/search Users Searches the database for customers matching the given request parameters.
GET /customers/userSavedSearch Users Retrieves a List of RowCustomer objects based on an existing saved search.
GET /customers/{id} Users Retrieves the customer for the given customer ID.
GET /customers/{id}/agedARReport Users, Customers Runs the Aged AR report for the given customer.
GET /customers/{id}/revenueReport Users Produces a customer revenue report.
GET /customers/{id}/unbilledOrdersReport Users Produces an unbilled orders report for the customer specified. As this is expected to be run from the customer screen, no range filter is given to select a range of customers and no option is given to allow sorting by customer.
PUT /customers/create Users Creates a new customer record for the given data.
PUT /customers/update Users Updates a customer record for the given data.