Get Creditor


Description

This method returns the details for a creditor in the system.

Authentication

Requires HTTP BASIC authentication. The authenticating user must be an admin over the creditor to retrieve their data.

HTTP Methods

Accepts GET requests.

URI

/api/creditors/{uuid}.json

Path Variables

Name Required/Optional Description Validation
uuid required The UUID of the creditor in the system Creditor UUID should exist in the system.

HTTP Parameters

No HTTP parameters.

Curl Example

Request

curl -u apiuser:test https://www.factorsnetwork.com/api/creditors/e6aaa036-2121-d11d-dd33-869ffac113be.json

Response

{
  "creditor":{
    "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" : 10,
    "lastUploadedDate" : 1436452046537
  }
}

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