GET Get-Debtor-Master

Purpose
Admin users may send a debtor key through this call to receive a JSON object of the master debtor's in system data.
Additional Header Information
Auth-AdminKey: Key used to mark higher privilege in the API
Return Information
Variable Name Type Purpose
ClientKey Char Var The unique ID used to identify the client through the API, used in other calls.
DebtorKey Char Var The unique ID used to identify the debtor through the API.
CompCode Char Var An abbreviated form of the debtor's name.
Name Char Var The debtor company's name.
Address1 Char Var The mailing address of the debtor.
Address2 Char Var Additional information on the address, such as PO box # or suite #.
City Char Var Debtor's City.
State Char Var Debtor's State, in two character format.
ZipCode Char Var The debtor's zipcode, supports non-American zipcode formats.
Country Char Var The debtor's country.
Phone Char Var Debtor's point of contact phone number.
Fax Char Var Debtor's fax number.
Email Char Var Debtor's primary point of contact email address.
MCNumber Char Var Debtor's Motor Carrier Number.
DOTNumber Char Var Debtor's Department of Transportation Number.
Notes Char Var Additional information for a client, such as liens or special instructions..
CreditLimit Float The debtor's current credit limit in FactorCloud.
BuyStatus Boolean Determines if the Debtor should be placed on a no-buy status.
Expected Return
An echo JSON object with the above fields.
Example cURL Call
curl -H 'Auth-FactorId: FACTORID’ -H 'Auth-SystemKey: SYSTEMKEY’ -H 'Auth-ApiKey: APIKEY’ https://wstest.factorcloud.com/api_factor/get-debtor-master/?clientkey=EXAMPLE_DEBTOR_KEY
Example Path
{
   https://wstest.factorcloud.com/api_factor/get-debtor-master/
}
Example Return
{
"ClientKey":"Example","DebtorKey":"Example","CompCode":"Example",
"Name":"Example","Address1":"","Address2":"","City":"",
"State":"","ZipCode":"","Country":"","Phone":"","Fax":"","Email":"",
"MCNumber":"","DOTNumber":"","Notes":"","CreditLimit":"","BuyStatus":""
}
Return to Index