MFG Rebate Library

This library defines a set of resources that are commonly used in API specifications designed for the This asset is a component of MuleSoft Accelerator for Manufacturing, which accelerates the implementation of essential integration use cases.

Data types

This library defines a number of data types related to rebate and credit memo, which form a canonical model used in most Process and System API specifications.

Usage

To use one or more of these resources in your API definition, first add this library as an Exchange dependency to your Design Center project. You can then import it into your main RAML file as follows:

uses:
  RebateTypes: exchange_modules/<groupid>/mfg-rebate-library/1.0.1/mfg-rebate-library.raml

You can then reference the exposed data types in your endpoints. For example:

/creditmemo:
  description: resource representing credit memo information.
  get:
    description: Retrieves credit memo payments information from end system.
    responses:
      200:
        body:
          application/json:
            type: RebateTypes.RebatePayment[]

Notes

If you update the version of the Exchange dependency you will need to manually update all file path references.