List Credit Applications¶
Use this API to fetch Credit applications for a given user based on the requested Criteria.
Example:
curl -X POST 'https://arc-aegis.billtrust.com/creditappcore/api/v1/tenants/{tenantId}/users/businessunits/creditapplications/status/list' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Billtrust-Api-Key: <API key value>'
--data-raw '{ ...request payload...}'
Request Payload Structure¶
{
"activityType": "String",
"startDate": "String",
"endDate": "String",
"applicationStatusType": [
"String"
]
}
- APPLICATIONSTATUSDATE - when an application was moved into its current status
- LASTMODIFIED - when an application was last accessed or updated
* startDate - Start date range (ISO format YYYY-MM-DD)
* endDate - End date range (ISO format YYYY-MM-DD)
* applicationStatusType - Refer Appendix -> Data Enumeration for valid values.
Sample Request Payload¶
{
"activityType": "APPLICATIONSTATUSDATE",
"startDate": "2020-06-09",
"endDate": "2020-07-09",
"applicationStatusType": [
"Closed - Approved",
"Closed - Declined"
]
}
Reponse Payload Structure¶
If successful, this will return a body containing the list of open credit applications for that tenant based on the filter criteria in the request payload . Below is a sample response that contains 1 credit application with summary information.
{
"applications": [
{
"applicationId": "55b289d3-f2bd-4c9c-b25e-7809617c8064",
"applicationDate": "2020-09-05T06:40:20.217+0000",
"applicationStatus": {
"type": "Closed - Approved",
"statusDate": "2020-09-10T06:42:02.692+0000",
"title": "Approved"
},
"businessUnitIdList": [
"55b289d3-f2bd-4c9c-b25e-7809617c8064"
],
"company": {
"companyId": 314294560,
"name": "Wal-Mart Inc.",
"dba": "Sams Club",
"address": {
"type": "HQ",
"address1": "702 South West 8th Street",
"address2": "",
"city": "Bentonville",
"state": {
"code": "AR",
"name": ""
},
"postalCode": "72716",
"country": {
"name": "United States",
"isoCountryCode": "US",
"iso3CountryCode": "USA"
}
}
},
"contact": {
"firstName": "String",
"lastName": "String",
"email": "String"
},
"autoDecisioned": false,
"applicantSubmitDate": "2020-09-07T00:50:49.609+0000",
"references": {
"bankReferenceSubmitCount": "0",
"bankReferenceRequestedCount": "0",
"tradeReferenceSubmitCount": "0",
"tradeRefReferenceRequestedCount": "0"
},
"lastActivityDate": "2020-09-10T06:42:02.692+0000"
}
],
"applicationStatusSummary": [
{
"type": "Closed - Approved",
"title": "Approved",
"noOfApplications": 1
}
]
}
- applicationId - Credit Application ID
- applicationDate - Credit Application Initiation Date
- applicationStatus - Information about the current application Status of the credit application. Refer to Appendix -> Common for further details
- businessUnitIdList - List of Business Unit value Ids. Refer Business Units for further details
- company - Information about the buyer company. Refer Appendix -> Common for further details.
- contact - Information about the user to whom the credit application was initiated to/by. Refer to Appendix -> Common for further details
- autoDecisioned - The credit application was decisioned (approved, declined etc.) based on the dynamic action rules defined in the form workflow.
- applicantSubmitDate - Date when the credit application was submitted by the buyer.
- ReferenceSubmitCount - Total number of references submitted.
- ReferenceRequestedCount - Total number of references requested.
- applicationStatusSummary - Count of applications in each status.
For the full documentation of the available filters and the response body, consult the public Swagger API for the Credit Applications API which can be found at
https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Creditapp%20core%20service%20v1#/Credit_Applications_-_Reports/listTenantCreditApplicationsByUserBusinessUnitsAndFilterCriteria