List Debtors


Description

This method is used to search and retrieve a list of debtors and their data. By default debtors are listed in alphabetical order by company name.

Authentication

Requires HTTP BASIC authentication.

HTTP Methods

Accepts GET requests.

URI

/api/debtors.json

Path Variables

No path variables.

HTTP Parameters

Name Required/Optional Description Validation
firstResult optional The index of the first result to return Must be 0 or greater
maxResults optional The maximum number of results to return Default is 100. Max is 1000.
accountNumber optional The account number. Searching will be done in a case insensitive with exact match. Length should not be greater than 35
companyName optional The name of the company. Searching will be done in a case insensitive fuzzy manner. Length should not be greater than 100
city optional The name of the city. Searching will be done in a case insensitive fuzzy manner. Length should not be greater than 100
state optional The state code.
postalCode optional The postal code. Length should not be greater than 12
mcNumber optional The MC number of the debtor.
dotNumber optional The DOT number of the debtor.
taxIdNum optional The Tax ID Number of the debtor. Length should not be greater than 20
includeBranches optional Include the branches if it's true else not. Value can be true or false. Default value is false
creditor optional The UUID of the Creditor in the system Creditor UUID should exist in the system.

Curl Example

Request

curl -u apiuser:test "https://www.factorsnetwork.com/api/debtors.json?firstResult=0&maxResults=2&includeBranches=true"

Response

{
  "debtors" : [ {
    "uuid" : "e6aaa036-2121-d11d-dd33-869ffac113be",
    "companyName" : "BROKER, INC",
    "mcNumber" : 456242,
    "dotNumber" : 567879,
    "faxNumber" : "",
    "phoneNumber" : "8002991356",
    "address1" : "1111 US 70 EAST",
    "address2" : "",
    "city" : "SELMA",
    "state" : "NC",
    "country" : "US",
    "postalCode" : "27576",
    "mailingAttention" : "",
    "mailingAddress1" : "",
    "mailingAddress2" : "",
    "mailingCity" : "",
    "mailingState" : "",
    "mailingPostalCode" : "",
    "mailingCountry" : "US",
    "averageDaysToPay" : null,
    "creditScore" : null,
    "rank" : null,
    "accountNumbers" : [ "17778" ],
    "taxIdNum" : "12345"
  }, {
    "uuid" : "8d43286f-2121-d11d-dd33-869ffac113be",
    "companyName" : "PLEASANT HILL",
    "mcNumber" : 776767,
    "dotNumber" : 8788788,
    "faxNumber" : "",
    "phoneNumber" : "(925)671-5270",
    "address1" : "1111 GREGORY LANE",
    "address2" : "",
    "city" : "PLEASANT HILL",
    "state" : "CA",
    "country" : "US",
    "postalCode" : "94523",
    "mailingAttention" : "",
    "mailingAddress1" : "",
    "mailingAddress2" : "",
    "mailingCity" : "",
    "mailingState" : "",
    "mailingPostalCode" : "",
    "mailingCountry" : "US",
    "averageDaysToPay" : null,
    "creditScore" : null,
    "rank" : null,
    "accountNumbers" : null,
    "taxIdNum" : null
  } ],
  "totalRecords" : 26804
}

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