API Documentation
API Overview
This document will help you to understand how to do the initial setup.
Alerts
This method is used to search and retrieve a list of alerts and their data. By default all unread alerts for the creditor are listed
This method updates an existing alerts in the system
Authentication
This function generates a one time use token with a 5 minute expiration and returns a URL containing the token which can be used as an HTTP redirect authenticating a user into the credit exchange. This is a single sign-on mechanism that allows authentication from trusted 3rd party applications without having to share credentials.
Creditors
This method adds a creditor user to the system.
This method returns the details for a creditor in the system.
This method updates an existing creditor in the system.
This method returns the details for all creditors the authenticating user is an admin over.
This method returns the details for a creditor setting in the system.
This method updates an existing creditor setting in the system.
This method will returns the credit status override based on creditor in the system.
This method will update credit status override in the system.
This method will returns the note type deny list based on creditor in the system.
This method will update note type deny list in the system.
Users
This method is used to update user.
Data
This method imports data for a given creditor and a given month.
This method gets data for a given creditor and a given month.
This method gets data for a given creditor and a given month in CSV format.
Debtors
This method is used to search and retrieve a list of debtors and their data. By default debtors are listed in alphabetical order by company name.
This method is used to search and retrieve a list of notes and their data.
This method is used to retrieve a list of notes types.
This method add a notes in the system.
This method deletes a note from the system.
This method is used to search and retrieve a list of messages and their data.
This method add a messages in the system.
This method is used to search by debtor's uuid or account number and retrieve debtor's uuid , companyName, creditStatus.
Reports
This function generates a one time use token with a 5 minute expiration and returns a URL
containing the token which can be used as an HTTP redirect allowing a user to pull a report without signing into the system.
Load Board
This method is used to retrieve a list of Loads
This method is used to get load
This method is used to create load
This method is used to update load
This method is used to remove load
Chameleon Catcher
This method is used to add the McNumber in Chameleon Watchlist with Chameleon Note.
This method is used to delete the McNumber from Chameleon Watchlist.
This method is used to return the list of McNumber from Chameleon Watchlist for the given creditor and their data.
This method is used to return the list of Chameleon Notes for the given creditor and their data.
This method is used to search the list of McNumber and their data.
Carrier Monitoring
This method is used to get the carrier monitoring data
This method is used to get the carrier monitoring alerts
This method is used to delete the carrier monitoring data
This method is used to add MC Numbers in carrier monitoring
Watchdog
This method is used to create the Watchdog
This method is used to update the Watchdog
This method is used to delete the Watchdog
This method is used to get the list of Watchdogs
