Get Data


Description

This method gets data for a given creditor and a given month.

Authentication

Requires HTTP BASIC authentication. The authenticating user must be an admin of the creditor in order to retrieve the creditor's data.

HTTP Methods

Accepts GET requests.

URI

/api/creditors/{UUID}/data/{MONTH}.json

Path Variables

Name Required/Optional Description Validation
UUID required The UUID of the creditor to import the data for. Debtor UUID should exist in the system.
MONTH required The month to import the data for Should be in YYYY-MM format

Parameters

No HTTP parameters.

Curl Example

Request

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

Response

{
  "fileRows":[
    {
        "account":"ABC",
        "name":"ABC Account",
        "mc":null,
        "phone":null,
        "fax":null,
        "physicalAddress1":null,
        "physicalAddress2":null,
        "city":"NEW",
        "state":null,
        "postalCode":null,
        "country":null,
        "attention":null,
        "mailingAddress1":null,
        "mailingAddress2":null,
        "mailingCity":null,
        "mailingState":null,
        "mailingZip":null,
        "mailingCountry":null,
        "a1to15":null,
        "a16to30":"450.00",
        "a31to45":null,
        "a46to60":"2597.45",
        "a61to75":null,
        "a76to90":null,
        "a91AndMore":null
    },{
        "account":"XYZ",
        "name":"XYZ Inc.",
        "mc":null,
        "phone":null,
        "fax":null,
        "physicalAddress1":null,
        "physicalAddress2":null,
        "city":null,
        "state":null,
        "postalCode":null,
        "country":null,
        "attention":null,
        "mailingAddress1":null,
        "mailingAddress2":null,
        "mailingCity":null,
        "mailingState":null,
        "mailingZip":null,
        "mailingCountry":null,
        "a1to15":"78954",
        "a16to30":null,
        "a31to45":null,
        "a46to60":null,
        "a61to75":null,
        "a76to90":"25",
        "a91AndMore":null
    }
  ]
}

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