Fetch Credit Application Details by applicationId¶
Use this API to retrieve all of the relevant application details using the applicationId.
- applicationId is the identifier associated with each credit application.
Example:
curl -X GET 'https://arc-aegis.billtrust.com/creditappcore/api/v1/tenants/{tenantId}/creditapplications/{applicationId}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Billtrust-Api-Key: <API key value>'
Sample Response Payload¶
{
"applicationId": "7d9a5696-59dc-4853-b94a-3dea695fec09",
"applicationDate": "2020-08-10T12:46:59.828+0000",
"applicationStatus": {
"title": "In Review",
"statusDate": "2020-08-10T12:53:23.703+0000",
"type": "Under Review"
},
"applicationForm": {
"formId": "a51f7fa2-8e43-4725-ae14-5bbdfc977753",
"formName": "Form Name",
"formType": [
{
"formTypesId": "36ca6267-7431-11ea-b50b-0a1abfdcda9e",
"displayName": "Internal Form",
"sectionList": [
{
"businessUnitIdList": [
"10155046-7431-11ea-b50b-0a1abfdcda9e"
],
"sectionId": "18c1fd50-d647-11ea-809d-2f4903b82e90",
"position": 1,
"displayName": "Order",
"status": "Active",
"fieldsList": [
{
"businessUnitIdList": [
"String"
],
"fieldsId": "1ebdf8d0-d647-11ea-809d-2f4903b82e90",
"position": 1,
"displayName": "Display Name",
"fieldType": {
"displayName": "Text"
},
"required": false,
"allowAdditionalAnswers": false,
"answerDetails": [
{
"answer": "Display Name",
"index": 0,
"updated": false
}
],
"hasSecondaryQuestions": false,
"status": "Active"
}
]
}
],
"status": "Active"
}
],
"businessUnitIdList": [
"String"
]
},
"businessUnitsIds": [
"String"
],
"company": {
"companyId": 429080612,
"headCompanyId": 0,
"selectedCompanyId": "429080612",
"name": "Wu-Young, Yean",
"address": {
"type": "HQ",
"address1": "67 Coddington St",
"address2": "Suite 102",
"city": "Quincy",
"state": {
"code": "MA",
"name": ""
},
"postalCode": "02169",
"country": {
"name": "United States",
"isoCountryCode": "US",
"iso3CountryCode": "USA"
}
},
"phone": [
{
"type": "WORK",
"number": "6176570800"
}
]
},
"companyScore": {
"assignedCreditLine": 400000,
"dibs": 55,
"dibsConfidence": 89,
"fibs": 69,
"fibsConfidence": 96,
"calculatedCreditLine": 475440000
},
"contact": {
"firstName": "Foo",
"lastName": "Bar",
"email": "foo@bar.com"
},
"applicantAccessDate": "2020-08-10T12:46:59.828+0000",
"tradeReferences": [
{
"createdDate": "2020-08-14T18:33:38.893+0000",
"referenceName": "CAFE Coffe Day",
"referenceEmailAddress": "foo+trade@bar.com",
"sectionList": [
{
"businessUnitIdList": [
"100ee4f3-7431-11ea-b50b-0a1abfdcda9e"
],
"sectionId": "50cd03b2-7431-11ea-b50b-0a1abfdcda9e",
"position": 1,
"displayName": "Trade Reference",
"status": "Active",
"fieldsList": [
{
"businessUnitIdList": [
"100ee4f3-7431-11ea-b50b-0a1abfdcda9e"
],
"sectionId": "50cd03b2-7431-11ea-b50b-0a1abfdcda9e",
"fieldsId": "50fc61e4-7431-11ea-b50b-0a1abfdcda9e",
"position": 1,
"displayName": "Customer Since",
"fieldType": {
"displayName": "Date"
},
"required": false,
"allowAdditionalAnswers": false,
"hasSecondaryQuestions": false,
"status": "Active"
}
]
}
],
"submitted": false,
"tradeReferenceId": "ad7904a4-30df-4c08-bbc4-50eb8941a178"
}
],
"bankReferences": [
{
"createdDate": "2020-08-14T15:37:52.097+0000",
"referenceName": "KVB BANK",
"referenceEmailAddress": "foo@bar.com",
"sectionList": [
{
"businessUnitIdList": [
"100ee4f3-7431-11ea-b50b-0a1abfdcda9e",
"10155046-7431-11ea-b50b-0a1abfdcda9e",
"10122ffa-7431-11ea-b50b-0a1abfdcda9e"
],
"sectionId": "49a4d23a-7431-11ea-b50b-0a1abfdcda9e",
"position": 1,
"displayName": "Bank Reference",
"status": "Active",
"fieldsList": [
{
"businessUnitIdList": [
"100ee4f3-7431-11ea-b50b-0a1abfdcda9e",
"10122ffa-7431-11ea-b50b-0a1abfdcda9e",
"10155046-7431-11ea-b50b-0a1abfdcda9e"
],
"fieldsId": "49ab900a-7431-11ea-b50b-0a1abfdcda9e",
"position": 1,
"name": "Company Name",
"displayName": "Company Name",
"fieldType": {
"displayName": "Text"
},
"required": false,
"allowAdditionalAnswers": false,
"value": "",
"values": [],
"hasSecondaryQuestions": false,
"status": "Active"
}
]
}
],
"submitted": false,
"bankReferenceId": "667eb645-174f-484e-a077-fb7f15934b61"
}
],
"applicationUsers": [
{
"userType": "INITIATOR",
"userId": "f105ac97-f647-4b08-b348-0c7bf9828b91",
"userEmailAddress": "foo@bar.com",
"userName": "Foo Bar"
},
{
"userType": "REVIEWER",
"allowReassign": true
}
],
"applicantSubmitDate": "2020-08-10T12:52:32.745+0000",
"lastReminderDate": "2020-07-15T00:39:56.600+0000",
"lastActivityDate": "2020-08-10T12:53:24.020+0000"
}
- applicationId - Unique identifier of the credit application
- applicationDate - Application initiation date
- applicationStatus - Information about the current application Status of the credit application. Refer to Appendix -> Common for further details
- applicantAccessDate - Date on which the buyer first accessed the application
- applicantSubmitDate - Date on which the buyer submitted the application
- businessUnitIdList - List of Business Unit value Ids. Refer Business Units for further details
- lastReminderDate - Date when the last reminder email was sent
- lastActivityDate - Date of last activity on the credit application
- applicationUsers - Check Application Users section
- applicationForm - Check Application Form section
- tradeReferences - Check References section
- bankReferences - Check References section
- contact - Information about the user to whom the credit application was initiated to/by. Refer to Appendix -> Common for further details
- company - Information about the buyer company. Refer to Appendix -> Common for further details
- companyScore - Score details about the company at the time of credit application decision. Refer to Appendix -> Common for further details
Application Form¶
"applicationForm": {
"formId": "String",
"formName": "String",
"formType": [
{
}
],
"businessUnitIdList": [
"String"
]
},
- formId - Unique identifier for the credit application form.
- formName - name of the credit application form.
- formType - List of formTypes. Check FormTypes section for more details
- businessUnitIdList - List of business unit ids
FormTypes section¶
Each Credit Application has multiple formTypes associated with it depending on the source from which answers are submitted.
"formType": [
{
"formTypesId": "36ca6267-7431-11ea-b50b-0a1abfdcda9e",
"displayName": "Internal Form",
"sectionList": [
{
"...": "..."
}
],
"status": "Active"
}
]
- formTypesId - Unique identifier for formType
- displayName
- formType "Internal Form" contains answers to questions in the internal form (filled out by sales representatives)
- formType "External Form" contains answers to questions in the external form(filled out by the buyer/applicant)
- sectionList - List of sections contained in the formType Check sections
- status -
- Active - FormType is in use
- Disabled - FormType is not in use and can be ignored
Sections¶
"sectionList": [
{
"businessUnitIdList": [
"String"
],
"sectionId": "String",
"position": 1,
"displayName": "String",
"status": "String",
"fieldsList": [
{
"..": ".."
}
]
}
]
- sectionId Unique identifier for a section
- position Specifies the order in which the section appears to the user
- displayName Name of the Section as it appears to the users
- status -
- Active - Section is in use
- Disabled - Section is not in use and can be ignored
- fieldsList - List of fields contained in the section Check Fields section
Fields¶
"fieldsList": [
{
"businessUnitIdList": [
"String",
],
"fieldsId": "49ab900a-7431-11ea-b50b-0a1abfdcda9e",
"position": 1,
"displayName": "Company Name",
"fieldType": {
"fieldTypesId": "String",
"displayName": "String",
"fieldSetsId": "String"
},
"required": false,
"allowAdditionalAnswers": false,
"answerDetails": [
{
"answer": "String",
}
],
"hasSecondaryQuestions": true,
"secondaryFields": [
{
"...": "..."
}
],
"fieldsSet": [
{
"...": "..."
}
],
"status": "Active"
}
]
- fieldsId - Unique identifier of a field
- displayName - Name of the field as it appears to the users
- position - Number which specifies the order in which the fields are displayed to the user
- fieldType - Refer Appendix -> Field Types and Field Sets for a full list of fieldtypes and fieldsets
- fieldTypesId - Unique identifier associated with the fieldType
- displayName - Name of the field Type
- fieldSetsId - (Optional) Unique identifier associated with the fieldset.
- required - boolean flag which indicates that the field is required/optional for submitting the application
- allowAdditionalAnswers - boolean flag which indicates that the field can accept multiple values as an answer
- answerDetails is a list which contains answers supplied against the field.
- when required is true, the list size is 1 or more.
- when required is false, the list size is 0 or more.
- when allowAdditionalAnswers is false, list size can be atmost 1.
- when allowAdditionalAnswers is true, list size has no restrictions.
- hasSecondaryQuestions - boolean flag which indicates that the field has secondary questions
- secondaryFields - a List of Fields
- if hasSecondaryQuestions is set to true, then secondaryFields are populated
- Secondary fields can contain regular field types as well as field sets.
- Nesting of secondary questions is not supported
- fieldsSet - a group of Fields defined by the system. Eg:- Address. Refer Appendix -> Field Types and Field Sets for a full list of fieldtypes and fieldsets
- status -
- Active - Section is in use
- Disabled - Section is not in use and can be ignored
References¶
"bankReferences": [
{
"createdDate": "2020-08-14T15:37:52.097+0000",
"bankReferenceId": "667eb645-174f-484e-a077-fb7f15934b61",
"referenceName": "KVB BANK",
"referenceEmailAddress": "foo@bar.com",
"sectionList": [
{
"...":"..."
}
],
"submitted": true,
"submitDate" : "2020-09-14T15:37:52.097+0000"
}
],
"tradeReferences":[
{
"tradeReferenceId": "667eb645-174f-484e-a077-fb7f15934b62",
"createdDate": "2020-08-14T15:37:52.097+0000",
"referenceName": "Factor Systems Inc dba. Billtrust",
"referenceEmailAddress": "test@test.com",
"sectionList": [
{
"...":"..."
}
],
"submitted": false,
"submitDate" : null
}
]
- tradeReferenceId - Unique identifier for a trade reference
- bankReferenceId - Unique identifier for a bank reference
- createdDate - Date on which the bank reference was initialy sent out
- referenceName - Name of the reference receiver
- referenceEmailAddress - Email Address of the reference receiver as entered by the buyer/applicant or sales representative.
- sectionList - contains information about sections and fields on the reference. Check Sections for for more information.
- submitted - boolean flag which denotes whether the reference was submitted or not.
- submittedDate - date on which the reference was submitted.
The above sample does not constitute the entire response. For the full response object view the swagger documentation at https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Creditapp%20core%20service%20v1#/Credit_Applications/getTenantCreditApplication