GetBusinessFinancials
Get full credit & financial details for a company
To connect to this service you'll need to use one of these endpoints:
Description
Supply a company registration number to retrieve:
- basic company information including name, address, SIC code
- credit ratings (0-100 score, 100 is best)
- recommended monthly credit limits
- previous names
- status history (summary of changes)
- full financial details including balance sheet and P&L
- director details
- shareholder details
- trading addresses
- mortgage details
The exact details that are available will vary between companies as some have to report more details than others. Smaller companies will typically only report limited financial details.
Multiple credit ratings and limits may be returned. This reflects the change in these values over time. Each rating and limit has an associated date indicating the date on which that became the effective rating or limit. The one with the latest date should be treated as the currently effective value. This will be the first one in the list.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
number | number The company registration number to retrieve the details for. If you do not have a company registration number available, us the [ |
options | options |
Advanced Options
The following options can be specified as part of the option
parameter. Each option is specified
as a key/value pair. The list of available names is shown below, along with a description of the allowable values
for that name.
Common Options | |
---|---|
Name | Description |
ApplicationName | ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard |
Address Formatting Options |
|
There are a large number of options to control how the raw address details are combined & formatted for presentation. They are described in more detail with live interactive examples on the address formatting reference. A summary of the available options is also listed below. | |
Name | Description |
Formatter |
Formatter Pick from one of the available formatters to control how the raw address is converted into a human-readable address:
|
MaxLines | MaxLines The number of lines to format the address over. An additional line will be included at the end of the results for the postcode |
MaxLineLength | MaxLineLength The maximum number of characters that can appear in each address line |
FixTownCounty | FixTownCounty true to ensure that the town and county are returned in the last two address lines, or false if they should appear in the first available line |
FixBuilding | FixBuilding Ensures the building name/number is always placed in the first line |
NormalizeCase | NormalizeCase Converts all text in the address except the town name to proper case |
NormalizeTownCase | NormalizeTownCase Converts the town name to proper case |
UseAnyAvailableCounty | UseAnyAvailableCounty Uses any available county to populate the formatted address, not just the postal county |
ExcludeCounty | ExcludeCounty Excludes the county, if any, from the formatted address |
UnwantedPunctuation | UnwantedPunctuation A string containing any punctuation characters to be removed from the formatted address |
Service-Specific Options | |
Name | Description |
Country | Country The 2-character code for the country the requested company is in |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report | Report This contains a number of properties with the full details for the company: BaseInformationThis section contains the following properties:
RatingsContains a list of credit ratings. Each entry in the list contains:
LimitsContains a list of recommended credit limits. Each entry in the list contains:
PreviousNamesContains a list of names the company has previously been registered as. Each entry in the list contains:
StatusHistoryContains a list of events that have occurred within the company, e.g. accounts being filed. Each entry in the list contains:
FinancialsContains a list of financial information for recent accounting periods. Each entry in the list contains:
DirectorsContains a list of directors of the company. Each entry in the list contains:
TradingAddressesContains a list of known trading addresses for the company. Each entry in the list contains:
MortgagesContains a list of mortgages for the company. Each entry in the list contains:
MortgageSummaryProvides an overview of the mortgages of the company, with the following properties:
ShareholdersContains a list of the shareholders of the company. Each entry in the list contains:
ShareholderSummaryProvides an overview of shareholder information, with the following properties:
GroupStructureProvides a tree structure showing the hierarchy of companies within a group, starting with the top of the hierarchy.
EstimatedInformationProvides estimates of key information where it is not declared, or the actual values where it is declared. Contains the following properties:
|