Get company credit info

Gets specified company's actual credit information, company credit application status and customers' registration information.

Endpoint

GET /integration/company/{id}/creditInfo

HTTP Request

GET /integration/company/{id}/creditInfo

Query parameters

Name	Description	Required	Type
id	Identifier of the company to get credit information	Yes	string
phone	Optional query parameter if not found by id.	No	string
email	Optional query parameter if not found by id.	No	string

Successful response, Credit Info Object

HTTP 200

{
  "creditInfo": {
    "accountStatus": "active",
    "masterStatus": "active",
    "pastDue30": 450.0,
    "pastDue60": 0.0,
    "pastDue90": 0.0,
    "pastDue90Plus": 0.0,
    "availableCredit": 5000.0,
    "limit": 10000,
    "balance": 5000,
    "pastDueAmount": 450,
    "processingAmount": 0.0,
    "creditType": "LOC",
    "automatedDrawApprovalInfo": {
      "isEnabled": true,
      "singleDrawMaxLimit": 10000,
      "creditLimitPercentageAvailableToUseAutomatically": 10,
      "dailyLimit": 1000000,
      "weeklyLimit": 1000000
  },
  "isCompanyRegistered": true,
  "creditApplicationStatus": "applicationNotSubmitted",
  "externalCompanyId": "generic_company_id_06052024_11",
  "customerInfos": [
    {
      "externalCustomerId": "generic_customer_id_individual_22",
      "isRegistered": true
    }
  ]
}

Erroneous response

HTTP 404

{
  "code": "404",
  "reason": "Company not found."
}

Responses

Code	Description
200	Successful operation
400	Invalid request
401	Unauthorized
404	Not found
500	Unexpected error

Examples

curl https://api.bluetape.com/genericBthubService/integration/company/<companyId>/creditInfo \
  -H "X-BlueTape-Key: <your-key>" \
  -H "X-Integration-AccountId: <your-account-id>" \

import fetch from 'node-fetch';

const companyId = 'dc506b22c7fa';
const url = `https://api.bluetape.com/genericBthubService/integration/company/${companyId}/creditInfo`;
const options = {
  method: 'GET', 
  headers: {
    'X-BlueTape-Key': '<your-key>',
    'X-Integration-AccountId': '<your-account-id>',
    'Content-Type': 'application/json'
  }
};

fetch(url, options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using Flurl.Http;

var companyId = "dc506b22c7fa";

var url = $"https://api.bluetape.com/genericBthubService/integration/company/{companyId}/creditInfo";

var result = await url
  .WithHeader("X-BlueTape-Key", "<your-key>")
  .WithHeader("X-Integration-AccountId", "<your-account-id>")
  .WithHeader("Content-Type", "application/json")
  .GetJsonAsync<CreditInfo>();

import requests

companyId = "dc506b22c7fa"
url = f'https://api.bluetape.com/genericBthubService/integration/company/{companyId}/creditInfo'

headers = {
    "X-BlueTape-Key": "<your-key>",
    "X-Integration-AccountId": "<your-account-id>",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)

Objects

Credit Information Object

Name	Description	Type
creditInfo	The credit information details.	object
isCompanyRegistered	TIs the company already registered at BlueTape.	boolean
creditApplicationStatus	Status of company credit application approval.	enum
externalCompanyId	The external id of the company.	string
customerInfos	Array of customers and their information about registration.	array

Credit Information Details Object

Name	Description	Type
accountStatus	The credit account status	string
masterStatus	The business master status	string
pastDue30	The past due amounts in 1-30 days	decimal
pastDue60	The past due amounts in 31-60 days	decimal
pastDue90	The past due amounts in 61-90 days	decimal
pastDue90Plus	The past due amounts in 91-... days	decimal
availableCredit	The available credit. Empty if not approved.	decimal
limit	The company approved credit limit. Empty if not approved.	decimal
balance	The unpaid amount of the company credit	decimal
pastDueAmount	Total past due amount for the company. Empty if not approved.	decimal
processingAmount	The processing payments amount	decimal
creditType	The credit type	string
automatedDrawApprovalInfo	The automated approval information	object

Automated Draw Approval Information Object

Name	Description	Type
isEnabled	Is automated approval enabled	boolean
singleDrawMaxLimit	Maximum amount of a draw to approve automatically	number
creditLimitPercentageAvailableToUseAutomatically	The percentage of credit could be used for automatic approval	number
dailyLimit	Daily limit of amounts to approve automatically	number
weeklyLimit	Last 7 days limit of amounts to approve automatically	number

Customer info

Name	Description	Type
externalCustomerId	The external id of the customer.	string
isRegistered	Is this customer already registered at BlueTape.	boolean

Enums

Credit Application Status

applicationNotSubmitted, applicationInReview, applicationRejected, active, inactive

Credit Account Statuses

goodStanding, pastDue, onHold, inCollection, closed

Business Master Statuses

new, active, inCollection, potentiallyFraud, inactive, closed