List Creditors


Description

This method returns the details for all creditors the authenticating user is an admin over.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/creditors.json

Path Variables

No path variables.

Parameters

Name Required/Optional Description Validation
companyName optional Name of creditor's compnay text
companyNameSearchType optional, default EXACT Where to search for company name Valid values are EXACT, BEGINNING, ANYWHERE

Curl Example

Request

curl -u apiuser:test https://www.factorsnetwork.com/api/creditors.json

Request with company Name search

curl -u apiuser:test https://www.factorsnetwork.com/api/creditors.json?companyName=test&companyNameSearchType=ANYWHERE

Response

{
  "creditors":[
    {
        "uuid":"e6aaa036-2121-d11d-dd33-869ffac113be",
        "companyName":"Factoring Inc.",
        "contactName":null,
        "contactPhone":null,
        "contactFax":null,
        "contactEmail":null,
        "address1":null,
        "address2":null,
        "city":null,
        "state":null,
        "country":null,
        "postalCode":null,
        "createdDate" : 1441356834403,
        "totalUploadedAccounts" : 0,
        "lastUploadedDate" : null
     },{
        "uuid":"e6aaa036-1212-d11d-dd33-000ffac113be",
        "companyName":"Pay Inc.",
        "contactName":null,
        "contactPhone":null,
        "contactFax":null,
        "contactEmail":null,
        "address1":null,
        "address2":null,
        "city":null,
        "state":null,
        "country":null,
        "postalCode":null,
        "createdDate" : 1441356834403,
        "totalUploadedAccounts" : 10,
        "lastUploadedDate" : 1436452046537
    }
  ],
  "totalRecords" : 2
}

Note: Responses will not be pretty printed when using the API, but have been formatted here for documentation purposes.