ROSE Developers - Web API Reference

Sales | Customer Info

This CustomerInfos end point is used to get a summary of customers data, like the sales volume.

Overview


URL api/{tenantKey}/{orgKey}/sales/customerInfos
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Customer Summary

Custom operation 'GetCustomerSummary'.

The following elements are required:

company (string) Company.
partyKey (string) PartyKey.

Response:

When successful, the response body contains a resource of type 'CustomerSummary'. See CustomerSummary.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /sales/customerInfos/getCustomerSummary/{company}

Resources


CustomerSummary

The following elements are optional:

customer (string) Customer.
customerTitle (string) Customer Title.
closedOrders (string) Closed Orders.
closedOrdersTitle (string) Closed Orders Title.
closedOrdersSubTitle (string) Closed Orders Sub Title.
orders (string) Orders.
ordersTitle (string) Orders Title.
sales (string) Sales.
salesTitle (string) Sales Title.
debt (string) Debt.
debtTitle (string) Debt Title.
acp (string) Acp.
acpTitle (string) Acp Title.
overdueDebt (string) Overdue Debt.
overdueDebtTitle (string) Overdue Debt Title.