Data Types

This section provides a comprehensive overview of the data types and codes utilised in the Muse Finance API.

Each data type corresponds to specific codes that play a crucial role in the interaction and understanding of the API functionality.

Please refer to the following tables for detailed information on the codes, descriptions, and associated fields for various codes used in the API, organised by their respective data types.

These codes are integral to the proper interpretation and utilisation of the Muse Finance API in your integration efforts.

Lead Status Code

Code	Description
SUBMITTED	Lead submission in progress
QUALIFIED	Lead has been qualified
DISQUALIFIED	Lead has been disqualified
DUPLICATE	Duplicate lead found
CONVERTED	Lead has been converted
HAS_ERRORS	Lead submission contains errors

Application Status Code

Code	Description
IN_PROGRESS	Application is in progress
CLOSED_WON	Application has been closed successfully
CLOSED_LOST	Application has been closed unsuccessfully

Agreement Status Code

Code	Description
ACTIVE	Agreement is active
COLLECT_OUT	Agreement is in collect-out status
TERMINATED	Agreement has been terminated
TERMINATED_DEFAULTED	Agreement has been terminated due to default

Product Type Code

Code	Description
INVOICE_FINANCE	Invoice finance product type
SUPPLY_FINANCE	Supply finance product type

Catalogue Item Type Code

Code	Description
INVOICE_FINANCE_SINGLE_INVOICE	Single invoice finance catalog item type
INVOICE_FINANCE_SELECTIVE_DEBTOR	Selective debtor invoice finance catalog item type
INVOICE_FINANCE_WHOLE_BOOK_DISCLOSED	Whole book disclosed invoice finance catalog item
SUPPLY_FINANCE_PRODUCT_ONE	Product one in supply finance catalog item type

Recommend Product Code

Code	Description
INVOICE_FINANCE	Recommend invoice finance product
SUPPLY_FINANCE	Recommend supply finance product
BOTH	Recommend both invoice and supply finance

Risk Score Code

Code	Description
PASS	Risk score indicates a pass
REFER	Risk score requires further review
FAIL	Risk score indicates a fail

Risk Rating Code

Code	Description
LOW	Low risk rating
MEDIUM	Medium risk rating
HIGH	High risk rating

Fee Type Code

Code	Description
FLAT_FEE	Flat fee for a financial product
PERCENTAGE_ONE_OFF	One-off percentage fee for a financial product
PERCENTAGE_DAILY	Daily percentage fee for a financial product
PERCENTAGE_MONTHLY	Monthly percentage fee for a financial product
PERCENTAGE_YEARLY	Yearly percentage fee for a financial product

Insurance Status Code

Code	Description
PENDING	Insurance request is pending
REQUESTED	Insurance has been requested
APPEALED	Insurance decision has been appealed
APPLIED	Insurance has been applied
CANCELLED	Insurance application has been cancelled
DECLINED	nsurance application has been declined

Credit Backed Offer Status Code

Code	Description
AWAITING_CLIENT_DECISION	Credit-backed offer awaiting client decision
AWAITING_PARTNER_DECISION	Credit-backed offer awaiting partner decision
PARTNER_APPEALED	Partner has appealed the credit-backed offer
CLIENT_APPROVED	Client has approved the credit-backed offer
CLIENT_DECLINED	Client has declined the credit-backed offer

Facility Rate Appeal Type Code

Code	Description
SUBSIDISE	Appeal type for subsidizing facility rates
SURCHARGE	Appeal type for surcharging facility rates

Fund Request Status Code

Code	Description
REQUESTED	Fund request has been submitted
PENDING_VERIFICATION	Fund request is pending verification
CURRENCY_EXCHANGE	Fund request is in the currency exchange process.
IPU_SENT	IPU (Interbank Processing Unit) sent for the fund request.
IPU_RECEIVED	IPU (Interbank Processing Unit) received for the fund request.
AMENDED	Fund request has been amended.
APPROVED	Fund request has been approved.
REJECTED	Fund request has been rejected.
CANCELED_SPLIT_REQUEST	Fund request has been canceled due to a split request

Currency Code

Code	Description
GBP	British Pound Sterling
EUR	Euro
USD	United States Dollar

Other currency codes are available, following the ISO 4217 standard.

The ISO 4217 standard provides a three-letter code to uniquely identify currencies worldwide, facilitating standardized currency representation and transactions. Refer to the ISO 4217 standard for a comprehensive list of supported currencies.