CRiskCo's API is organized around REST. Accounts have test mode and live mode API keys. There is no "switch" for changing between modes, use the appropriate key to perform a live or test transaction. Requests made with test mode credentials incur no cost. JSON is returned by all API responses, including errors. Be sure to subscribe to CRiskCo's API mailing list at api@criskco.com, to receive information on new additions and changes to CRiskCo's API libraries.
This document outlines the CRiskCo programmatic interface (API) for Credit providers who use CRiskCo@Approve or CRiskCo@Gov platform to onboard applicants and do on-going monitoring. Using the API, the credit providers can access financial data (including accounting information), analytics, and CRiskCo Credit reports. CRiskCo's API libraries are documented in different documents. Each document provides a set of API calls per topic or set of data elements. Be sure to explore CRiskCo's libraries to get a full picture of CRiskCo's available data.
Jargon
For ease of understanding, the following jargon will be used throughout the document:
- Credit Provider - refers to the entity/app that is calling the API.
- Applicant - refers to the business applicant who applies for credit from the Credit Provider. This is normally a business that is signed up with the Credit Provider and applies for credit as a loan, Insurance, Grant or line of credit.
- Customer - refers to a business entity that is the customer of the Applicant. A Customer may be an Applicant too in a different session.
At a glance
The flow to receive an applicant credit and financial information from the API:
- Applicant applies online for credit and is referred to the dedicated white label landing page URL provided by CRiskCo. Applicant will go through the application process, with the last step is choosing an accounting system and authorize CRiskCo access through the accounting system API.
- CRiskCo backend will load the Applicant's accounting information from the accounting system and prepare a full credit report and summarize the financial information to be transmitted over the API.
- Once this process completes, Applicant will be redirected to the resumeUrl (provided by the Credit Provider upon registration) with an parameter that will be used to reference Applicant in future API calls as described in this document.
- Credit Provider will use the to make calls to the CRiskCo API.
Get your API Keys
Developer Registration
To start developing, register with CRiskCo to receive access to your own Sandbox. Register HERE to immediately get your credentials.
After your register, you will be provided access to development API tokens and can start making calls to the API.
Tokens Provided:
- apiId - Unique ID assigned for each Credit Provider by CRiskCo.
- apiKey - Unique token used to identify the Credit Provider during API calls.
Authentication
Request Format
Requests must include the following headers:
- apiId
- apiKey
- Content-Type: application/JSON
If request parameters are required in a request, the parameters must be sent in the request body and in JSON format, according to the endpoint definition.
All API responses are in JSON format.
GET GetApplicants
https://service.criskco.com/apiservice.svc/get-applicants
The endpoint will return the list of applicants which are registered and authorized the Credit Provider to receive access to their credit and financial information.
The applicantId is used to identify a particular applicant when query the CRiskCo API.
Two examples are provided:
1. List of all applicants
2. Query by taxId parameter
Onboarding Status
Below is an description of the onboarding statuses
| Onboarding Status | Description |
|---|---|
| Available | The applicant has connected to CRiskCo and the data has been processed |
| Processing | The applicant has connected to CRiskCo, but the data is currently being processed |
| NotConnected | The applicant has not connected with CRiskCo |
HEADERS
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Content-Type
application/json
None
PARAMS
refApplicantId
Optional: Identifier as provided by the Credit Provider when referring the Applicant
taxId
Optional: State tax id or other formal identification id
onboardingStatus
Optional: Upon 'true', the onboarding status will be included in the API Response. Default: 'false'
fullResponse
None
Optional: Upon 'true', the full dataset of this company will be returned. Default: 'false'
Example Request
GET https://service.criskco.com/apiservice.svc/get-applicants?onboardingStatus=true
Example Response
200 - OK
{
"applicant": [
{
"applicantId": "19162",
"dateConnected": "2020-11-11T00:00:00",
"isActive": true,
"lastUpdateDate": "2017-06-08T16:41:48",
"name": "Paper Factory",
"refApplicantId": "f2ghf3-djk32-fdhj34",
"status": "New",
"taxId": null,
"onboardingStatus" : "Available"
},
{
"applicantId": "1000143693",
"dateConnected": "2020-11-11T00:00:00",
"isActive": false,
"lastUpdateDate": null,
"name": "Industrial Company (demo)",
"refApplicantId": null,
"status": "New",
"taxId": "ABC123456",
"onboardingStatus" : "Processing"
}
]
}
GET SAT - RFC Validation
https://service.criskco.com/apiservice.svc/ValidateRFC?rfc=GAPXXXXXXXXX&name=GAP&postal=12345
Use the SAT - RFC Validation endpoint to validate a company as registered at the Mexican Fiscal Authority (SAT).
It can be validated by two options:
- RFC only
- RFC +Name of the company +Postal Code of the company as registered.
The response will return if the request is successful or not, 3 optional boolean values and the response message from SAT (as you can see below in the example):
- Success - Is the request is successful or not
- ValidRFC - The RFC is valid or not
- ValidName (if requested) - The Company Name is valid or not
- ValidPostal (if requested) - The Postal Code is valid or not
- message - The exact message from SAT
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Accept-Encoding
gzip, deflate
None
PARAMS
rfc
GAPXXXXXXXXX
None
name
GAP
None
postal
12345
None
Example Request
GET https://service.criskco.com/apiservice.svc/ValidateRFC?rfc=GAPXXXXXXXXX
Example Response
200 - OK
{
"Success": true,
"ValidParameters": [
{
"Property": "ValidRFC",
"Valid": true
},
{
"Property": "ValidName",
"Valid": true
},
{
"Property": "ValidPostal",
"Valid": true
}
],
"message": "RFC válido, y susceptible de recibir facturas"
}
Example Request
GET https://service.criskco.com/apiservice.svc/ValidateRFC?rfc=GAPXXXXXXXXX&name=GAP&postal=12345
Example Response
200 - OK
{
"Success": true,
"ValidParameters": [
{
"Property": "ValidRFC",
"Valid": true
},
{
"Property": "ValidName",
"Valid": true
},
{
"Property": "ValidPostal",
"Valid": true
}
],
"message": "RFC válido, y susceptible de recibir facturas"
}
POST SAT - RFC Validation Bulk
https://service.criskco.com/apiservice.svc/ValidateRFCBulk
Use the SAT - RFC Validation Bulk endpoint to validate bulk of RFC's up to 5,000 in a single call for companies registered at the Mexican Fiscal Authority (SAT).
It can be validated by two options:
- RFC only
- RFC +Name of the company +Postal Code of the company as registered.
RFC Only - The file in the body of the request will include in the first column (without header) the RFC, each one in a different row.
For example:
ABCYYYYYYYYYY
RFC +Name of the company +Postal Code - The file in the body of the request will include in the first column (without header) the RFC, Name and Postal code, seperated by '|' each one in a different row.
For example:
ABCYYYYYYYYYY|ABC|98765
The response will return if the request is successful or not, 3 optional boolean values and the response message from SAT (as you can see below in the example):
- Success - Is the request is successful or not
- ValidRFC - The RFC is valid or not
- ValidName (if requested) - The Company Name is valid or not
- ValidPostal (if requested) - The Postal Code is valid or not
- message - The exact message from SAT
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Accept-Encoding
gzip, deflate
None
form
=@"mTP-wnOLB/Example_RFC.csv"
None
Example Request
GET https://service.criskco.com/apiservice.svc/ValidateRFCBulk
Example Response
200 - OK
{
"Success": true,
"ValidParameters": [
{
"Property": "ValidRFC",
"Valid": true
},
{
"Property": "ValidName",
"Valid": true
},
{
"Property": "ValidPostal",
"Valid": true
}
],
"message": "RFC válido, y susceptible de recibir facturas"
}
Example Request
GET https://service.criskco.com/apiservice.svc/ValidateRFCBulk
Example Response
200 - OK
{
"Success": true,
"ValidParameters": [
{
"Property": "ValidRFC",
"Valid": true
},
{
"Property": "ValidName",
"Valid": true
},
{
"Property": "ValidPostal",
"Valid": true
}
],
"message": "RFC válido, y susceptible de recibir facturas"
}
POST Onboarding SAT Integration
https://service.criskco.com/apiservice.svc/OnboardingSatIntegration
Use the SAT Integration endpoint to onboard a company and retrieve data from the Mexican Fiscal Authority (SAT).
This will allow you to access invoices, payments and tax returns from the SAT.
Body Paramaters
| Field | Required | Description |
|---|---|---|
| IsAgreeTerms | Yes | Has the company accepted CRiskCo’s terms |
| DateAgreeTerms | Yes | Date terms agreed |
| VersionAgreeTerms | Yes | Version of Terms |
| Yes | The Company’s email | |
| User | Yes | Company’s RFC |
| Password | Yes | Company’s CIEC |
| RefApplicantId | Optional | An optional identifier that allows you to track |
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Accept-Encoding
gzip, deflate
None
BODY raw
{
"IsAgreeTerms": true,
"DateAgreeTerms": "2021-10-01",
"VersionAgreeTerms": "1",
"Email": "testOnboarding@criskco.com",
"User":"GAPXXXXXXXXX",
"Password": "XXX",
"RefApplicantId": ""
}
Example Request
POST https://service.criskco.com/apiservice.svc/OnboardingSatIntegration
{
"IsAgreeTerms": true,
"DateAgreeTerms": "2021-10-01",
"VersionAgreeTerms": "1",
"Email": "testOnboarding@criskco.com",
"User":"GAPXXXXXXXXX",
"Password": "XXX",
"RefApplicantId": ""
}
Example Response
200 - OK
{
"ErrorCode": null,
"Message": "Success! Information Received",
"Success": true
}
POST Monitoring Company
https://service.criskco.com/apiservice.svc/RequestMonitoring
Use the Monitoring Company endpoint to monitor a company and retrieve again the data from the Mexican Fiscal Authority (SAT).
This will allow you to update all of the invoices, payments and tax returns from the SAT .
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Accept-Encoding
gzip, deflate
None
BODY raw
{
"applicantId": "1000143693",
"Source": "API"
}
Example Request
POST https://service.criskco.com/apiservice.svc/RequestMonitoring
{
"applicantId": "1000143693",
"Source": "API"
}
Example Response
200 - OK
{
"applicantId": "1004319766",
"refApplicantId": null,
"responseDetails": null,
"success": true
}
POST Applicants Info
https://service.criskco.com/apiservice.svc/applicantinfo
The endpoint will return the Applicant’s business information and business financial information.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Accept-Encoding
gzip, deflate
None
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/applicantinfo
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"name": "Industrial Company (demo)",
"verifiedBy": null,
"verifiedName": null,
"registrationDate": "2020-11-11T00:00:00",
"firstInvoiceDate": "2016-08-05T00:00:00",
"sectorNaicsId": null,
"sectorNaicsName": null,
"yearsInBusiness": null,
"isVerifiedTaxId": false,
"taxId": "ABC123456",
"erpType": "QuickBooksOnline",
"financialYearEndMonth": "12",
"financialYearEndDay": "31",
"currency": "USD",
"address": {
"city": "San Francisco",
"country": "USA",
"postalCode": "99999",
"state": "CA",
"street": "12 Silver Dr"
},
"contactDetails": {
"phone": "2025550166"
},
"financials": {
"lastUpdate": "2020-04-01T00:00:00",
"salesCurrentYear": 288264,
"salesPreviousYear": 1335074.07,
"salesPreviousTwoYears": 1268840.27,
"totalSales": 4105414.46,
"accountsReceivables": 270495.76,
"overdueReceivables": 236666.51,
"dso": 75,
"add": 63,
"cei": 82.3867893060335,
"totalCustomers": 1472,
"activeCustomers": 139,
"financialYearsAnalytics": {
"current": {
"date": "2020-04-01T00:00:00",
"activeCustomers": 139,
"salesPercentTop5Customers": 45.88,
"purchasePercentTop5Vendors": 54.26,
"customerRiskHhi": 0.16,
"vendorRiskHhi": 1,
"zScore": 7.02,
"debtServiceRatio": 5.13,
"pretaxProfitMargin": 77.23,
"returnOnEquity": 7.32,
"currentRatio": 15.84,
"quickRatio": 3.02,
"operatingExpense": 0,
"numberOfInvoices": 747,
"averageInvoiceSize": 1756.91,
"dso": 75,
"add": 63,
"cei": 82.39
},
"financialYearEnd": {
"date": "2019-12-31T00:00:00",
"activeCustomers": 141,
"salesPercentTop5Customers": 46.45,
"purchasePercentTop5Vendors": 53.58,
"customerRiskHhi": 0.13,
"vendorRiskHhi": 0.15,
"zScore": 8.06,
"debtServiceRatio": 27.59,
"pretaxProfitMargin": 68.47,
"returnOnEquity": 36.13,
"currentRatio": 15.39,
"quickRatio": 2.61,
"operatingExpense": 0,
"numberOfInvoices": 524,
"averageInvoiceSize": 2547.85,
"dso": 46,
"add": 24,
"cei": 92.78
},
"previousFinancialYearEnd": {
"date": "2018-12-31T00:00:00",
"activeCustomers": 173,
"salesPercentTop5Customers": 47.1,
"purchasePercentTop5Vendors": 58.88,
"customerRiskHhi": 0.1,
"vendorRiskHhi": 0.09,
"zScore": 50.43,
"debtServiceRatio": 49.01,
"pretaxProfitMargin": 99.7,
"returnOnEquity": 74.88,
"currentRatio": 178.97,
"quickRatio": 45.62,
"operatingExpense": 1.15,
"numberOfInvoices": 746,
"averageInvoiceSize": 1700.86,
"dso": 33,
"add": 29,
"cei": 92.97
}
},
"revenueStream": [
{
"year": -1,
"month": -1,
"invoicesDue": 270495.76,
"predictedPayments": 61779.8
},
{
"year": 2021,
"month": 7,
"invoicesDue": 0,
"predictedPayments": 96132.16
},
{
"year": 2021,
"month": 8,
"invoicesDue": 0,
"predictedPayments": 11491
},
{
"year": 2021,
"month": 9,
"invoicesDue": 0,
"predictedPayments": 2025
},
{
"year": 2021,
"month": 10,
"invoicesDue": 0,
"predictedPayments": 9053
},
{
"year": 2021,
"month": 11,
"invoicesDue": 0,
"predictedPayments": 0
},
{
"year": 2021,
"month": 12,
"invoicesDue": 0,
"predictedPayments": 0
}
],
"monthlyFinancials": [
{
"year": 2019,
"month": 5,
"invoices": 223683.9,
"payments": 160163.72,
"openAR": 162796.65,
"dso": 48,
"add": 16,
"cei": 95.64,
"deposits": 10078.11
},
{
"year": 2019,
"month": 6,
"invoices": 117790.81,
"payments": 103170.4,
"openAR": 176372.06,
"dso": 50,
"add": 24,
"cei": 93.65,
"deposits": 0
},
{
"year": 2019,
"month": 7,
"invoices": 147231.5,
"payments": 117953.81,
"openAR": 201236.32,
"dso": 57,
"add": 35,
"cei": 90.65,
"deposits": 5025
},
{
"year": 2019,
"month": 8,
"invoices": 72842.5,
"payments": 115365,
"openAR": 158658.82,
"dso": 45,
"add": 35,
"cei": 90.81,
"deposits": 6155
},
{
"year": 2019,
"month": 9,
"invoices": 78951.2,
"payments": 38404.73,
"openAR": 199155.29,
"dso": 55,
"add": 35,
"cei": 90.68,
"deposits": 16000
},
{
"year": 2019,
"month": 10,
"invoices": 117465.15,
"payments": 45608.7,
"openAR": 270876.74,
"dso": 73,
"add": 50,
"cei": 87.01,
"deposits": 0
},
{
"year": 2019,
"month": 11,
"invoices": 71507.94,
"payments": 128087.75,
"openAR": 214041.93,
"dso": 59,
"add": 48,
"cei": 88.06,
"deposits": 14833.24
},
{
"year": 2019,
"month": 12,
"invoices": 93536.5,
"payments": 136371.7,
"openAR": 168233.73,
"dso": 46,
"add": 24,
"cei": 92.78,
"deposits": 27221
},
{
"year": 2020,
"month": 1,
"invoices": 84399.6,
"payments": 34824.59,
"openAR": 217766.17,
"dso": 61,
"add": 37,
"cei": 89.05,
"deposits": 12105.86
},
{
"year": 2020,
"month": 2,
"invoices": 153470.2,
"payments": 115025.77,
"openAR": 254534.16,
"dso": 69,
"add": 28,
"cei": 91.01,
"deposits": 16199.72
},
{
"year": 2020,
"month": 3,
"invoices": 50394.2,
"payments": 33774.6,
"openAR": 270398.76,
"dso": 75,
"add": 62,
"cei": 82.51,
"deposits": 10534.86
},
{
"year": 2020,
"month": 4,
"invoices": 0,
"payments": 0,
"openAR": 270398.76,
"dso": 75,
"add": 63,
"cei": 82.39,
"deposits": 0
}
]
},
"blackLists": null
}
POST Customers
https://service.criskco.com/apiservice.svc/customers
The endpoint will return the Applicant’s business customers information and customers financial information.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Accept-Encoding
gzip
None
Content-Encoding
gzip
None
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/customers
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"customers": [
{
"customerId": "121329",
"foreignId": "100",
"firstInvoiceDate": null,
"name": "Customer 100",
"verifiedName": null,
"sectorNaicsId": null,
"sectorNaicsDescription": null,
"taxId": null,
"currency": "USD",
"address": {
"city": null,
"country": null,
"postalCode": null,
"state": null,
"street": null
},
"contactDetails": {
"phone": null
},
"financials": {
"finScore": 560,
"totalSales": 0,
"twelveMonthsSales": 0,
"dueInvoices": 0,
"overDueInvoices": 0,
"creditMemos": 0,
"dso": null,
"add": null,
"cei": null,
"monthlyFinancials": []
}
},
{
"customerId": "121905",
"foreignId": "1003",
"firstInvoiceDate": "2018-06-04T00:00:00",
"name": "Customer 1003",
"verifiedName": null,
"sectorNaicsId": null,
"sectorNaicsDescription": null,
"taxId": null,
"currency": "USD",
"address": {
"city": null,
"country": null,
"postalCode": null,
"state": null,
"street": null
},
"contactDetails": {
"phone": null
},
"financials": {
"finScore": 550,
"totalSales": 243,
"twelveMonthsSales": 0,
"dueInvoices": 0,
"overDueInvoices": 0,
"creditMemos": 0,
"dso": null,
"add": null,
"cei": null,
"monthlyFinancials": [
{
"year": 2018,
"month": 6,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 6,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 6,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 7,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 7,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 8,
"invoices": 243,
"payments": 243,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 9,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2018,
"month": 10,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 1,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 3,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 5,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 7,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 8,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 9,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 11,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2019,
"month": 12,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2020,
"month": 1,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2020,
"month": 2,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
},
{
"year": 2020,
"month": 3,
"invoices": 0,
"payments": 0,
"openAR": 0,
"dso": null,
"add": null,
"cei": null
}
]
}
}
]
}
POST Customer AR Transactions - Invoices
https://service.criskco.com/apiservice.svc/ar-transactions/invoices
The endpoint will return the Applicant’s business customer Invoices.
An Invoice represents a sales form where the customer pays for a product or service later.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Content-Encoding
gzip
None
Accept-Encoding
gzip
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ar-transactions/invoices?fromDate=2020-01-01&toDate=2020-12-01
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"customerId": null,
"invoices": [
{
"customerId": "120760",
"id1": "14614",
"id2": "5926",
"issueDate": "2020-02-27T00:00:00",
"amount": 3212,
"description": null,
"createdAt": "2020-02-01T00:00:00",
"updatedAt": "2020-03-22T00:00:00",
"invoiceId": "7c77cd7f-6c79-40f1-838e-2d45a0dfbed2",
"dueDate": "2020-03-28T00:00:00",
"predictedDate": "2020-02-27T00:00:00",
"paymentDate": null,
"balance": 3212,
"credited": 0
},
{
"customerId": "121264",
"id1": "15035",
"id2": "6272",
"issueDate": "2020-03-20T00:00:00",
"amount": 232,
"description": null,
"createdAt": "2020-03-20T00:00:00",
"updatedAt": "2020-03-20T00:00:00",
"invoiceId": "185d3322-abb8-4f1c-a528-156ad1bc0b5c",
"dueDate": "2020-04-19T00:00:00",
"predictedDate": "2020-04-19T00:00:00",
"paymentDate": null,
"balance": 232,
"credited": 0
}
]
}
POST Customer AR Transactions - Payments
https://service.criskco.com/apiservice.svc/ar-transactions/payments
The endpoint will return the Applicant’s business customer Payments.
A Payment object records a payment. The payment can be applied for a particular customer against multiple Invoices. It can also be created without any Invoice, by just specifying an amount.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Content-Encoding
gzip
None
Accept-Encoding
gzip
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ar-transactions/payments?fromDate=2020-01-01&toDate=2020-12-01
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"customerId": null,
"payments": [
{
"customerId": "120816",
"id1": "14590",
"id2": null,
"issueDate": "2020-01-07T00:00:00",
"amount": 200,
"description": null,
"createdAt": "2020-01-28T00:00:00",
"updatedAt": "2020-01-28T00:00:00",
"paymentId": "f76796f0-e9cc-4b21-a72a-404b8fb69534",
"linkedInvoices": [
{
"txnId": "f4e0f5e5-823b-4d9b-9962-d7b6374cc698",
"type": "Invoice",
"id1": "14467",
"id2": null,
"linkedAmount": 200,
"customerId": "120816"
}
]
},
{
"customerId": "121912",
"id1": "14540",
"id2": null,
"issueDate": "2020-01-07T00:00:00",
"amount": 390,
"description": null,
"createdAt": "2020-01-07T00:00:00",
"updatedAt": "2020-01-07T00:00:00",
"paymentId": "ec478d72-afda-4cc3-8b09-59b03e4342d8",
"linkedInvoices": [
{
"txnId": "9b3e224d-337f-4425-904b-072102e8a3a9",
"type": "Invoice",
"id1": "14407",
"id2": null,
"linkedAmount": 390,
"customerId": "121912"
}
]
}
]
}
POST Customer AR Transactions - Credit Memo
https://service.criskco.com/apiservice.svc/ar-transactions/creditmemos
The endpoint will return the Applicant’s business customer Credit Memos.
A financial transaction representing a refund or credit of payment.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Content-Encoding
gzip
None
Accept-Encoding
gzip
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ar-transactions/creditmemos?fromDate=2019-01-01&toDate=2020-12-01
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"customerId": null,
"creditmemos": [
{
"customerId": "120892",
"id1": "14358",
"id2": "5756",
"issueDate": "2019-11-20T00:00:00",
"amount": 220,
"description": null,
"createdAt": "2019-11-20T00:00:00",
"updatedAt": "2019-11-20T00:00:00",
"creditmemoId": "5276db5a-c33e-4d08-a372-22367dd26186",
"linkedInvoices": [
{
"txnId": "9af8b2f7-db5b-4eba-998e-f316b24ee670",
"type": "Invoice",
"id1": "11809",
"id2": null,
"linkedAmount": 220,
"customerId": "120892"
}
]
}
]
}
POST Customers Grouping
https://service.criskco.com/apiservice.svc/grouping/customers
The Customers Grouping Endpoint allows you to retreieve all the applicant’s customer information in a single call to the API. This will return with Invoice, Payments and Credit Memos.
HEADERS
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Content-Type
application/json
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/grouping/customers?fromDate=2020-01-01&toDate=2020-02-01
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"customers": [
{
"customerId": "121329",
"foreignId": "100",
"firstInvoiceDate": null,
"name": "Customer 100",
"verifiedName": null,
"sectorNaicsId": null,
"sectorNaicsDescription": null,
"taxId": null,
"currency": "USD",
"address": {
"city": null,
"country": null,
"postalCode": null,
"state": null,
"street": null
},
"contactDetails": {
"phone": null
},
"financials": {
"finScore": 560,
"totalSales": 0,
"twelveMonthsSales": 0,
"dueInvoices": 0,
"overDueInvoices": 0,
"creditMemos": 0,
"dso": null,
"add": null,
"cei": null,
"monthlyFinancials": []
}
}
}
],
"invoices": [
{
"customerId": "121564",
"id1": "14531",
"id2": "5865",
"issueDate": "2020-01-01T00:00:00",
"amount": 550,
"description": null,
"createdAt": "2020-01-01T00:00:00",
"updatedAt": "2020-01-01T00:00:00",
"invoiceId": "e1cce350-5be1-4759-a1d0-4fca823c05e0",
"dueDate": "2020-01-31T00:00:00",
"predictedDate": "2020-03-04T00:00:00",
"paymentDate": null,
"balance": 550,
"credited": 0
}
],
"payments": [
{
"customerId": "121261",
"id1": "14607",
"id2": null,
"issueDate": "2020-01-31T00:00:00",
"amount": 3122,
"description": null,
"createdAt": "2020-01-31T00:00:00",
"updatedAt": "2020-01-31T00:00:00",
"paymentId": "358cc000-1ba6-47dc-960e-9d38061dcaea",
"linkedInvoices": null
}
],
"creditmemos": []
}
POST Suppliers
https://service.criskco.com/apiservice.svc/suppliers
The endpoint will return the Applicant’s business suppliers’ information and financial information.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/suppliers
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"suppliers": [
{
"supplierId": "55379",
"foreignId": "1266",
"firstInvoiceDate": "2019-01-14T00:00:00",
"name": "Supplier 1266",
"verifiedName": null,
"sectorNaicsId": null,
"sectorNaicsDescription": null,
"taxId": null,
"currency": "USD",
"address": {
"city": null,
"country": null,
"postalCode": null,
"state": null,
"street": null
},
"contactDetails": {
"phone": null
},
"financials": {
"totalPurchases": 66038,
"twelveMonthsPurchases": 0,
"openPurchaseInvoices": 66038,
"creditMemos": 0,
"monthlyFinancials": [
{
"month": 1,
"year": 2020,
"invoices": 0,
"payments": 0,
"openAP": 66038
},
{
"month": 2,
"year": 2020,
"invoices": 0,
"payments": 0,
"openAP": 66038
},
{
"month": 3,
"year": 2020,
"invoices": 0,
"payments": 0,
"openAP": 66038
},
{
"month": 4,
"year": 2020,
"invoices": 0,
"payments": 0,
"openAP": 66038
},
{
"month": 5,
"year": 2020,
"invoices": 0,
"payments": 0,
"openAP": 66038
},
{
"month": 6,
"year": 2020,
"invoices": 0,
"payments": 0,
"openAP": 66038
}
]
}
}
]
}
POST Supplier AP Transactions - Supplier Invoices
https://service.criskco.com/apiservice.svc/ap-transactions/invoices
The endpoint will return the Applicant’s business supplier Invoices.
Supplier Invoices are accounts payable transactions representing a request-for-payment from a supplier for goods/service.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ap-transactions/invoices?fromDate=&toDate=
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"supplierId": null,
"invoices": [
{
"supplierId": "55450",
"id1": "13222",
"id2": null,
"issueDate": "2019-03-01T00:00:00",
"amount": 672,
"currency": null,
"description": null,
"createdAt": "2019-03-01T00:00:00",
"updatedAt": "2019-03-01T00:00:00",
"invoiceId": "0768ed31-6c03-452a-bce7-3a4b9bc508dd",
"dueDate": "2019-03-01T00:00:00",
"paymentDate": null,
"balance": 672,
"credited": 0
},
{
"supplierId": "55379",
"id1": "12897",
"id2": null,
"issueDate": "2019-01-14T00:00:00",
"amount": 14140,
"currency": null,
"description": null,
"createdAt": "2019-01-14T00:00:00",
"updatedAt": "2019-01-18T00:00:00",
"invoiceId": "0bc230ec-ccd1-4d98-b377-4103d98eef50",
"dueDate": "2019-01-14T00:00:00",
"paymentDate": null,
"balance": 14140,
"credited": 0
}
]
}
POST Supplier AP Transactions - Supplier Payments
https://service.criskco.com/apiservice.svc/ap-transactions/payments
The endpoint will return the Applicant’s business supplier Payments.
A Supplier Payment object records a payment. The payment can be applied for a particular supplier against multiple Invoices. It can also be created without any Invoice, by just specifying an amount.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ap-transactions/payments?fromDate=&toDate=
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"supplierId": null,
"payments": [
{
"supplierId": "55450",
"id1": "12921",
"id2": "2",
"issueDate": "2019-01-17T00:00:00",
"amount": 41203,
"currency": null,
"description": "SPECIAL INVENTORY",
"createdAt": "2019-01-17T00:00:00",
"updatedAt": "2019-02-12T00:00:00",
"paymentId": "c2b2236d-51fa-4e3e-baee-12c45c38fbdb",
"linkedInvoices": [
{
"txnId": "f8e19ed6-db83-4e7a-a8e7-75b69e6a2d11",
"type": "Invoice",
"id1": "12855",
"id2": null,
"linkedAmount": 40159,
"supplierId": "55450"
}
]
},
{
"supplierId": "55364",
"id1": "12831",
"id2": null,
"issueDate": "2019-01-07T00:00:00",
"amount": 17568,
"currency": null,
"description": null,
"createdAt": "2019-01-07T00:00:00",
"updatedAt": "2019-01-07T00:00:00",
"paymentId": "d9e1e379-13ec-4a31-b121-165d81d790f9",
"linkedInvoices": [
{
"txnId": "9a638542-1f72-48d3-ad4d-a212843251bf",
"type": "Invoice",
"id1": "12829",
"id2": null,
"linkedAmount": 17568,
"supplierId": "55364"
}
]
},
{
"supplierId": "55300",
"id1": "7308",
"id2": "1",
"issueDate": "2018-01-03T00:00:00",
"amount": 17700,
"currency": null,
"description": null,
"createdAt": "2018-01-03T00:00:00",
"updatedAt": "2018-07-18T00:00:00",
"paymentId": "08ff44df-c014-456c-9293-13ff8fbb5eaa",
"linkedInvoices": [
{
"txnId": "5ba40246-17dc-4d65-8b14-050fb6ea67cc",
"type": "Invoice",
"id1": "7305",
"id2": null,
"linkedAmount": 17700,
"supplierId": "55300"
}
]
}
]
}
POST Supplier AP Transactions - Supplier Credit Memo
https://service.criskco.com/apiservice.svc/ap-transactions/creditmemos
The endpoint will return the Applicant’s business supplier Credit Memos.
A financial transaction representing a refund or credit of payment with a supplier.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ap-transactions/creditmemos?fromDate=&toDate=
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"supplierId": null,
"creditmemos": []
}
POST Supplier AP Transactions - Expenses
https://service.criskco.com/apiservice.svc/ap-transactions/expenses
The endpoint will return the Applicant’s business supplier Expenses.
A financial transaction that represents a company expense that is not invoiced.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/ap-transactions/expenses?fromDate=&toDate=
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"supplierId": null,
"expenses": [
{
"supplierId": "55357",
"id1": "15036",
"id2": null,
"issueDate": "2020-03-18T00:00:00",
"amount": 2559.27,
"currency": "USD",
"description": "Gas Station",
"createdAt": "2020-03-23T00:00:00",
"updatedAt": "2020-03-23T00:00:00",
"expenseId": "cbb9e429-c8f9-43d6-a08f-436086f9924c"
},
{
"supplierId": "55357",
"id1": "15014",
"id2": null,
"issueDate": "2020-03-11T00:00:00",
"amount": 3212.26,
"currency": "USD",
"description": "Purchase of stationary",
"createdAt": "2020-03-16T00:00:00",
"updatedAt": "2020-03-16T00:00:00",
"expenseId": "627e446c-4b1d-4278-99f9-abfabd5a066d"
}
]
}
POST Suppliers Grouping
https://service.criskco.com/apiservice.svc/grouping/suppliers
The Suppliers Grouping Endpoint allows you to retreieve all the applicant’s supplier information in a single call to the API. This will return with Invoice, Payments and Credit Memos.
HEADERS
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
Content-Type
application/json
None
PARAMS
fromDate
Optional: ISO 8601 datestamp indicating the start date to filter against
toDate
Optional: ISO 8601 datestamp indicating the end date to filter against
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/grouping/suppliers?fromDate=2019-01-01&toDate=2020-04-01
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"suppliers": [
{
"supplierId": "55434",
"foreignId": "1",
"firstInvoiceDate": null,
"name": "Supplier 1",
"verifiedName": null,
"sectorNaicsId": null,
"sectorNaicsDescription": null,
"taxId": null,
"currency": "USD",
"address": {
"city": null,
"country": null,
"postalCode": null,
"state": null,
"street": null
},
"contactDetails": {
"phone": null
},
"financials": {
"totalPurchases": 0,
"twelveMonthsPurchases": 0,
"openPurchaseInvoices": 0,
"creditMemos": 0,
"monthlyFinancials": []
}
}
],
"invoices": [
{
"supplierId": "55450",
"id1": "12832",
"id2": null,
"issueDate": "2019-01-07T00:00:00",
"amount": 3750,
"currency": null,
"description": null,
"createdAt": "2019-01-07T00:00:00",
"updatedAt": "2019-01-07T00:00:00",
"invoiceId": "fa5f2ef3-5294-477c-be7e-107c1253cfc6",
"dueDate": "2019-01-07T00:00:00",
"paymentDate": null,
"balance": 3750,
"credited": 0
}
],
"payments": [
{
"supplierId": "55364",
"id1": "12831",
"id2": null,
"issueDate": "2019-01-07T00:00:00",
"amount": 17568,
"currency": null,
"description": null,
"createdAt": "2019-01-07T00:00:00",
"updatedAt": "2019-01-07T00:00:00",
"paymentId": "d9e1e379-13ec-4a31-b121-165d81d790f9",
"linkedInvoices": null
}
],
"creditmemos": []
}
POST Financial Report - Row Data - Balance Sheet
https://service.criskco.com/apiservice.svc/financialreports/rowdata/balancesheet
Returns the Balance Sheet as it appears in the clients ERP or accounting software.
In the body you can specify the financalYear as follows:
Current, FinancialYearEnd, PreviousFinancialYearEnd, SecondPreviousFinancialYearEnd, ThirdPreviousFinancialYearEnd.
If the financalYear parameter is blank, the current year will be returned by default.
Each report is an ordered collection of rows and cells. Rows can be of various types (e.g. section, row and summary row elements). Cells can contain values and attributes with nested values.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693",
"financialYear": ""
}
Example Request
POST https://service.criskco.com/apiservice.svc/financialreports/rowdata/balancesheet
{
"applicantId": "1000143693",
"financialYear": ""
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"reports": [
{
"type": "BalanceSheet",
"financialYear": "Current",
"date": "2020-04-01T03:34:16",
"fromDate": null,
"toDate": "2020-04-01T00:00:00",
"bankAccount": null,
"columns": [
"",
"Total"
],
"titles": [
"BalanceSheet",
"QuickBooks Online Report",
"April 1 2020 TO April 1 2020"
],
"rows": [
{
"type": "Section",
"title": "ASSETS",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Current Assets",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Bank Accounts",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "BOA BUSINESS PRIMARY",
"cell2": "20000.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Business Advantage Chk",
"cell2": "366751.51",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Business Savings",
"cell2": "-6202.12",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Cash on hand",
"cell2": "3293.12",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Checking",
"cell2": "12432.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Citi Business Checking",
"cell2": "475.05",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "PayPal Bank",
"cell2": "0.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "SPECIAL ACCOUNT",
"cell2": "-41203.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Bank Accounts",
"cell2": "355546.56",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Accounts Receivable",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Accounts Receivable",
"cell2": "285116.70",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Accounts Receivable",
"cell2": "285116.70",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Other Current Assets",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Inventory Asset",
"cell2": "-63582.80",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Uncategorized Asset",
"cell2": "2300.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Undeposited Funds",
"cell2": "2779605.96",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Other Current Assets",
"cell2": "2718323.16",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Current Assets",
"cell2": "3358986.42",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "TOTAL ASSETS",
"cell2": "3358986.42",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "LIABILITIES AND EQUITY",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Liabilities",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Current Liabilities",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Accounts Payable",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Accounts Payable",
"cell2": "169692.33",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Accounts Payable",
"cell2": "169692.33",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Credit Cards",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Boa Credit Card",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Bank of America Business Mastercard",
"cell2": "-5442.02",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Boa Credit Card",
"cell2": "-5442.02",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Capital One Credit Card",
"cell2": "0.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Shareholder pay",
"cell2": "0.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Credit Cards",
"cell2": "-5442.02",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Other Current Liabilities",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Behalf Line of Credit",
"cell2": "11729.39",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Fundbox Invoice Advances",
"cell2": "25391.18",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Intuit Financing Line of Credit",
"cell2": "15000.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "PaypayWorkingCapital",
"cell2": "-4344.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Other Current Liabilities",
"cell2": "47776.57",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Current Liabilities",
"cell2": "212026.88",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Long-Term Liabilities",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Loan",
"cell2": "6073.64",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Long-Term Liabilities",
"cell2": "6073.64",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Liabilities",
"cell2": "218100.52",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Equity",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Opening Balance Equity",
"cell2": "372320.84",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "OWNER'S DRAW",
"cell2": "14944.76",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Retained Earnings",
"cell2": "2523634.51",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Net Income",
"cell2": "229985.79",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Equity",
"cell2": "3140885.90",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "TOTAL LIABILITIES AND EQUITY",
"cell2": "3358986.42",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
}
],
"financialSource": "CR-Automated"
}
]
}
POST Financial Report - Row Data - Profit and Loss
https://service.criskco.com/apiservice.svc/financialreports/rowdata/profitandloss
Returns the Profit and Loss as it appears in the clients ERP or accounting software.
In the body you can specify the financalYear as follows:
Current, FinancialYearEnd, PreviousFinancialYearEnd, SecondPreviousFinancialYearEnd, ThirdPreviousFinancialYearEnd.
If the financalYear parameter is blank, the current year will be returned by default.
Each report is an ordered collection of rows and cells. Rows can be of various types (e.g. section, row and summary row elements). Cells can contain values and attributes with nested values.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693",
"financialYear": "Current"
}
Example Request
POST https://service.criskco.com/apiservice.svc/financialreports/rowdata/profitandloss
{
"applicantId": "1000143693",
"financialYear": "Current"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"reports": [
{
"type": "ProfitAndLoss",
"financialYear": "Current",
"date": "2020-04-01T03:34:16",
"fromDate": "2020-01-01T00:00:00",
"toDate": "2020-04-01T00:00:00",
"bankAccount": null,
"columns": [
"",
"Total"
],
"titles": [
"ProfitAndLoss",
"QuickBooks Online Report",
"January 1 2020 TO April 1 2020"
],
"rows": [
{
"type": "Section",
"title": "Income",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Sales",
"cell2": "190257.07",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Sales of Product Income",
"cell2": "107554.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Income",
"cell2": "297811.07",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Cost of Goods Sold",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Cost Of Goods Sold",
"cell2": "64726.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Cost of Goods Sold",
"cell2": "64726.00",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "GrossProfit",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Gross Profit",
"cell2": "233085.07",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "Expenses",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Row",
"title": null,
"cell1": "Fundbox Fees",
"cell2": "3099.28",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Total Expenses",
"cell2": "3099.28",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "NetOperatingIncome",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Net Operating Income",
"cell2": "229985.79",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "Section",
"title": "NetIncome",
"cell1": null,
"cell2": null,
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
},
{
"type": "SummaryRow",
"title": null,
"cell1": "Net Income",
"cell2": "229985.79",
"cell3": null,
"cell4": null,
"cell5": null,
"cell6": null,
"cell7": null,
"cell8": null,
"cell9": null,
"cell10": null
}
],
"financialSource": "CR-Automated"
}
]
}
POST Financial Report - Row Data - Bank Statement
https://service.criskco.com/apiservice.svc/financialreports/rowdata/bankstatement
Bank Statement as it appears in the clients ERP or accounting software.
Each report is an ordered collection of rows and cells. Rows can be of various types (e.g. section, row and summary row elements). Cells can contain values and attributes with nested values.
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/financialreports/rowdata/bankstatement
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"reports": []
}
POST Financial Report - Standard - Balance Sheet
https://service.criskco.com/apiservice.svc/financialreports/standard/balancesheet
Returns the Balance Sheet standardised by CRiskCo.
In the body you can specify the financalYear as follows:
Current, FinancialYearEnd, PreviousFinancialYearEnd, SecondPreviousFinancialYearEnd, ThirdPreviousFinancialYearEnd.
If the financalYear parameter is blank, the current year will be returned by default.
Each report is a collection of rows and cells. Rows can be of various types (e.g. section, row and summary row elements). Cells can contain values and attributes with nested values.
Below is a detailed list of the types and codes used by the CRiskCo API
| classification | accountType | subAccountType | Description |
|---|---|---|---|
| Assets | CurrentAsset | CurrentAsset | cash and other assets that are expected to be converted to cash within a year |
| Assets | CurrentAsset | Bank | Current balance in the banks accounts |
| Assets | CurrentAsset | Inventory | Represent the inventory value |
| Assets | CurrentAsset | AccountReceivables | Accounts receivable is the balance of money due to a firm for goods or services delivered or used but not yet paid for by customers. |
| Assets | NonCurrentAsset | NonCurrentAsset | Long-term investments for which the full value will not be realized within the accounting year. |
| Assets | NonCurrentAsset | DeprecationAmortization | Depreciation and Amortization value. |
| Equity | Equity | Equity | Company equity value |
| Equity | Equity | OpenBalanceEquity | Company equity value in the date previous to the report period |
| Equity | Equity | AccumulatedAdjustment | accumulated adjustments account, A special account is used to track undistributed earnings of an S corporation that have been taxed to shareholders previously. |
| Equity | Equity | CurrentEarnings | The Current Year Earnings account value is calculated automatically as sales and other business transactions that impact income and expense accounts, are recorded. Its balance equals income minus cost of sales and expenses. |
| Equity | Equity | RetainedEarnings | Retained earnings are the profits that a company has earned to date, less any dividends or other distributions paid to investors. |
| Equity | Equity | NetIncome | Net income is an entity’s income minus cost of goods sold, expenses and taxes for an accounting period. |
| Liability | Currentliabilities | CurrentLiabilities | Current Liabilities, amounts due to be paid to creditors within twelve months |
| Liability | Currentliabilities | AccountPayable | Accounts payable (AP) is money owed by a business to its suppliers shown as a liability on a company’s balance sheet. |
| Liability | Currentliabilities | CreditCards | Credit Cards accounts. |
| Liability | NonCurrentLiabilities | NonCurrentLiabilities | Usually refer to long term liabilities (more than 12 months). |
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693",
"financialYear": ""
}
Example Request
POST https://service.criskco.com/apiservice.svc/financialreports/standard/balancesheet
{
"applicantId": "1000143693",
"financialYear": ""
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"reports": [
{
"type": "BalanceSheet",
"financialYear": "Current",
"date": "2020-04-01T11:05:31",
"fromDate": "2020-04-01T00:00:00",
"toDate": "2020-04-01T00:00:00",
"classifications": [
{
"type": "ASSET",
"total": 3358986.42,
"accounts": [
{
"type": "CurrentAsset",
"total": 3358986.42,
"subAccounts": [
{
"type": "Bank",
"total": 355546.56
},
{
"type": "AccountReceivables",
"total": 285116.7
},
{
"type": "CurrentAsset",
"total": 2718323.16
}
]
}
]
},
{
"type": "LIABILITY",
"total": 218100.52,
"accounts": [
{
"type": "CurrentLiabilities",
"total": 212026.88,
"subAccounts": [
{
"type": "AccountPayable",
"total": 169692.33
},
{
"type": "CreditCards",
"total": -5442.02
},
{
"type": "CurrentLiabilities",
"total": 47776.57
}
]
},
{
"type": "NonCurrentLiabilities",
"total": 6073.64,
"subAccounts": [
{
"type": "NonCurrentLiabilities",
"total": 6073.64
}
]
}
]
},
{
"type": "EQUITY",
"total": 3140885.9,
"accounts": [
{
"type": "Equity",
"total": 3140885.9,
"subAccounts": [
{
"type": "Equity",
"total": 2910900.11
},
{
"type": "NetIncome",
"total": 229985.79
}
]
}
]
}
]
}
]
}
POST Financial Report - Standard - Profit and Loss
https://service.criskco.com/apiservice.svc/financialreports/standard/profitandloss
Returns the Balance Sheet standardised by CRiskCo.
In the body you can specify the financalYear as follows:
Current, FinancialYearEnd, PreviousFinancialYearEnd, SecondPreviousFinancialYearEnd, ThirdPreviousFinancialYearEnd.
If the financalYear parameter is blank, the current year will be returned by default.
Each report is a collection of rows and cells. Rows can be of various types (e.g. section, row and summary row elements). Cells can contain values and attributes with nested values.
Below is a detailed list of the types and codes used by the CRiskCo API
| classification | accountType | subAccountType | Description |
|---|---|---|---|
| Revenue | Sales | Sales | Direct sales of product/service |
| Revenue | Sales | Discount | Discounts Provided |
| Revenue | Sales | OtherSales | Sales generating revenue not by the main products/services of the company. |
| Revenue | OtherIncome | OtherIncome | Usually refer to income from financial vehicles, as interest, Grants, Dividend etc. |
| Revenue | OtherIncome | Grants | Grants |
| Revenue | OtherIncome | Interest | Interest (income or expense) |
| Revenue | OtherIncome | Dividend | Revenue generated by Dividend |
| Expenses | COGS | COGS | Cost of Goods Sold (COGS) |
| Expenses | COGS | FreightAndDelivery | Freight and Delivery (income or expense) |
| Expenses | COGS | OtherCOGS | Other COGS |
| Expenses | Expense | Tax | Tax Paid |
| Expenses | Expense | Expense | Expense |
| Expenses | Expense | BadDebt | Bad debt |
| Expenses | Expense | Insurance | Insurance expense |
| Expenses | Expense | Legal | Legal expense |
| Expenses | Expense | Travel | Travel expense |
| Expenses | OtherExpense | OtherExpense | Other expenses |
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693"
}
Example Request
POST https://service.criskco.com/apiservice.svc/financialreports/standard/profitandloss
{
"applicantId": "1000143693"
}
Example Response
200 - OK
{
"applicantId": "1000143693",
"refApplicantId": null,
"reports": [
{
"type": "ProfitAndLoss",
"financialYear": "Current",
"date": "2020-04-01T11:05:31",
"fromDate": "2020-01-01T00:00:00",
"toDate": "2020-04-01T00:00:00",
"classifications": [
{
"type": "REVENUE",
"total": 297811.07,
"accounts": [
{
"type": "Sales",
"total": 297811.07,
"subAccounts": [
{
"type": "Sales",
"total": 297811.07
}
]
}
]
},
{
"type": "EXPENSE",
"total": 67825.28,
"accounts": [
{
"type": "COGS",
"total": 64726,
"subAccounts": [
{
"type": "COGS",
"total": 64726
}
]
},
{
"type": "OtherExpense",
"total": 3099.28,
"subAccounts": [
{
"type": "ExpenseInterest",
"total": 3099.28
}
]
}
]
}
]
}
]
}
POST Financial Report - Documents
https://service.criskco.com/apiservice.svc/Documents
Retrieve an Applicants documents. This includes documents uploaded by the applicant and reports prepared by CRiskCo.
The response includes a unique http file link where the document can be downloaded from.
Catalogue of Documents
| report_type | Description |
|---|---|
| SAT_FINANCIAL_DECLARATION | Annual Tax Declarations submitted to SAT |
| SAT_CONTRIBUYENTE | The Opinion De Contribuyente from SAT |
| SAT_ANALYTICS | Summarized Company Report prepared by CRiskCo |
| APPLICANT_FILES | Files uploaded by the applicant as part of their onboarding |
| MONTHLY_GENERATED_REPORT | Monthly report prepared by CRsikCo |
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693",
"csvInJson":false
}
Example Request
POST https://service.criskco.com/apiservice.svc/Documents
{
"applicantId": "1000143693",
"csvInJson":false
}
Example Response
None - None
{
"applicantId": "1000143693",
"refApplicantId": "1000143693",
"documents": [
{
"CreatedAt": "2021-05-02",
"FileName": "Company Report - Industrial Company - April 01, 2020.pdf",
"FileType": 1,
"ReportDateFrom": "2020-04-01",
"ReportDateTo": "2020-04-01",
"ReportType": 4,
"FileLink": "https://criskcodemo.blob.core.windows.net/demo/1000143693-18019.PDF",
"FileJson": ""
}
]
}
POST Applicant Financials Grouping
https://service.criskco.com/apiservice.svc/grouping/applicant-financials
The Financials Grouping Endpoint allows you to retreieve all the applicant’s Financial Statement Data in a single API Call. This will return both the Row Data and the CRiskCo Standardised reports, Documents as well as the analytics and summaries calculated by CRiskCo.
HEADERS
apiId
None
apiKey
None
Content-Type
application/json
None
BODY raw
{
"applicantId": ""
}
Example Request
POST https://service.criskco.com/apiservice.svc/grouping/applicant-financials
{
"applicantId": ""
}
POST Update Status
https://service.criskco.com/apiservice.svc/applicant-status
The API is used to update the application status.
The default ‘status’ value for all new applicants is ‘New’.
Changing the status of an applicant will affect the connection to the applicant’s accounting system and the connection may be disconnected. While disconnected, the applicant’s data available via the API will not be up to date and only the data from the last successful update will be available. Changing the status from a disconnected status to a connected status, will trigger an attempt to re-establish a connection to the accounting system.
Available status options:
New
Denied
CancelByApplicant
UnderEvaluation
Approved
CompanyDefaulted
Completed
HEADERS
Content-Type
application/json
None
apiId
{{client-api-id}}
None
apiKey
{{client-api-key}}
None
BODY raw
{
"applicantId": "1000143693",
"status": "Approved"
}
Example Request
POST https://service.criskco.com/apiservice.svc/applicant-status
{
"applicantId": "1000143693",
"status": "Approved"
}