FactorCloud Web Services Documentation Index
Authentication
Test base URL
wstest.factorcloud.com/api_factor/
Live base URL
ws.factorcloud/api_factor/
Header Information
The following Authorization keys need to be added to any API call header.
Auth-FactorID
an ID provided by FactorCloud to the Factor who owns the instance of FactorCloud.
Auth-SystemKey
A Key to Identify the specific system.
Auth-APIKey
An API password.
The following API Calls may be used with the Factorcloud Web Services:
API Test Calls
Allows users to validate connection for get requests to the API.
Allows users to validate connection for post requests to the API.
API Standard Calls
Allows users to create a client. If the ClientKey variable matches a client already in the system, the client information will be updated. If there is no matching ClientKey a new client will be created.
Allows a user to request the details of a certain client.
Allows a user to request the details of all clients.
Allows users to create a debtor and associate that debtor to a client. If the DebtorKey variable matches a debtor already in the system; the sub-debtor information will be updated. If there is no matching DebtorKey a master debtor will be created and associated to the user.
Users may send a client key and debtor key through this call to receive a JSON object of that sub-debtor's in system data.
Admin users may send a debtor key through this call to receive a JSON object of the master debtor's in system data.
a JSON object of all the master debtors in system data.
Users may use this call to receive an array of all client's sub-debtor information.
Allows users to create a schedule, and the invoices that make up the schedule.
Allows users to receive the details of a schedule.
Allows users to receive the details of an invoice.
API Standard Calls (Broker)
Allows users to create a vendor and associate that vendor to a client. If the DebtorKey variable matches a vendor already in the system; the sub-vendor information will be updated. If there is no matching DebtorKey a master vendor will be created and associated to the user.
Allows users to retrieve a master vendor's data from the system.
Allows users to retrieve a vendor's client-vendor relationship data from the system.
Allows users to pull all the vendor data associated to one client.
Allows users to create a schedule that contains an array of JSON Object invoices, with the additional functionality of setting advance rates and vendors.
Allows users to retrieve a broker schedule.
Allows users to retrieve a broker invoice.
API File Storage Calls
Allows a user to retrieve encoded documents assigned to an invoice.
Users may send an encoded document for storage.
API Financial Calls
Allow users to make payments.
Retrieve the BBC for a given day.