Overview
The Share A Refund Agreements API lets you view agreements for billing, compliance and modeling. You can develop applications that integrate with Share A Refund and create extended functionality in your application with the Share A Refund API.
The following figure shows the relationship between your Share A Refund app, the Share A Refund API, and Agreements.
Share A Refund App
Share A Refund’s agreements services gives users with custom parcel and freight pricing agreements, named My Share A Refund Agreements, and the option to access collaborative agreements.
Share A Refund API
The REST API that allows users to use Agreements from within your app.
Authentication
An app that uses Share A Refund Agreements as a digital artifact of all pricing incentives and rules from within your app.
Collaborative Agreements
A location that maintains all agreement incentives, rules and transformers inherent to individual agreements from inside any given agreement.
What can users do with the Share A Refund Agreements API?
Users can use the Share A Refund Agreements to perform common workflows, such as:
- Clone an agreement as new from existing
- Create an agreement
- Delete an agreement
- Download agreements from Share A Refund, modify and update rules to agreements.
- Integrate your Share A Refund Agreement within your custom application.
- Modify agreement rules, types listed below
- Save an agreement with new name or description
- Update an agreement with rules, modify transformers and change incentives.
Agreement rules available to create, modify, update and delete throught the Share A Refund Agreements API:
Data Transformer rules
Dim Divisor rules
Earned Discount rules
Fuel Surcharge Discount rules
Grace Period Discount rules
Minimum Net Charge rules
Multipiece Minimum Weight Qualifier rules
Service Discount by Region rules
Service Discount rules
Service Net Rate rules
Surcharge Net Rate rules
Surcharge Discount rules
Additional info
Learn more about developing with Share A Refund Agreements API, including handling authentication, authorization, reference the Develop on Share A Refund API for your workspace. More →
Learn more about how to launch and run a Share A Refund Agreements API app, read the Developer Getting Started Guide. More →