Get Creditor Setting


Description

This method returns the details for a creditor setting 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}/settings.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.

Parameters

No HTTP parameters.

Curl Example

Request

curl -k -u apiuser:test "https://www.factorsnetwork.com/api/creditors/ff5ac510-2365-5454-4456-2bda1f96f82f/settings.json"

Response

{
  "creditorSettingResponse" : {
    "uuid" : "ff5ac510-2365-5454-4456-2bda1f96f82f",
    "companyName" : "Insight Technology",
    "creditDepartmentEmail" : "test@test.com",
    "creditDepartmentPhone" : null,
    "creditDepartmentBusinessHour" : null,
    "alertDaysAfterReportRun" : 10,
    "averageDaysAlertDays" : 10,
    "scoreChangeAlert" : 10,
    "minimumAmountAlert" : "10",
    "minimumScoreApproved" : 72,
    "minimumScoreReview" : 58,
    "minimumAvgDaysToPayApproved" : 72,
    "minimumAvgDaysToPayReview" : 58,
    "minimumBalanceApproved" : 2000,
    "minimumBalanceReview" : 1000,
    "minimumCreditorUploadsApproved" : 2,
    "minimumCreditorUploadsReview" : 1,
    "minimumMonthsApproved" : 6,
    "minimumMonthsReview" : 2,
    "percentageBalanceForReviewInShortTerm" : 4,
    "percentageBalanceForDeniedInShortTerm" : 9,
    "percentageBalanceForReviewInLongTerm" : 10,
    "percentageBalanceForDeniedInLongTerm" : 35,
    "minimumCreditorsForShortTermApproved" : 2,
    "minimumCreditorsForShortTermReview" : 1,
    "minimumCreditorsForLongTermApproved" : 3,
    "minimumCreditorsForLongTermReview" : 1,
    "activeBrokerAuthorityApproved" : 18,
    "activeBrokerAuthorityReview" : 12,
    "inActiveBrokerAuthorityStatus" : "DENIED",
    "shortTermMonth" : 7,
    "longTermMonth" : 12,
    "privacySettings" : "No",
    "alertsSearchRadius" : 5,
    "phoneNumberComparisonType" : "EXACT",
    "companyNamesComparisonType" : "Yes",
    "fleetTransferPercentage" : 10
  }
}

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