Request

The request contains all information related to a company analysis

During the analysis request, you will be able to generate a multitude of Reports and assign them to a request.

<aside> 📚 For a complete list of fields, checkout the API Reference (Request API Reference)

</aside>

Here are the explanations of the most important fields:

Code

{
  "code": {
    "type": "kvk",
    "id": "24288945"
  }
}

The code is the unique identifier of a company.

Collaborators

This field lists the users that are involved in the request. It will contain the user who created the request (automatically added).

It can also include additional partners, other collaborators (who are neither borrower nor partner) ****and October team members.

<aside> 📚 Learn more about the Collaborator model in the API Reference (Collaborator API Reference)

</aside>

Creator

The creator of the request will be the user responsible for the request. You can assign any of your users.

<aside> ℹ️ By default, if you do not provide a creator during the request creation, we will assign the user used to communicate with the API.

</aside>

The value of the creator field is the id of the user responsible for the request, to retrieve it :

Sign in to your October account.
Click on the Team tab
Click on the user you want to be responsible for the request (or click on the Invite a coworker button to add a new user to your business)
Copy the id present in the url of the page app.october.eu/user/[id]. For example in the url app.october.eu/user/6413297aad6e59418e7748f9, the user id is 6413297aad6e59418e7748f9
Use this id as the value of the creator field, for example creator: 6413297aad6e59418e7748f9

Notes

The notes field of the request will hold all the business information and financial data that you will send us.

All those notes are required in order to receive an offer.

Name	Description	Type	Possible values	Mandatory
`holding`	Is the company a holding?	boolean		Yes
`workforceNumber`	How many people are working in the company?	number	Minimum 1	Yes
`equity`	Equity of the company	number (euros)		Yes
`revenue`	Revenue of the company for the last year	number (euros)		Yes
`amortizationDepreciation`	Amount of amortization and depreciation	number (euros)		Yes
`netIncome`	Net income of the company/holding for the last year	number (euros)		Yes
`interestExpense`	Interest payable on any borrowings (bonds, loans, convertible)	number (euros)		Yes
`cashAvailable`	Amount of cash available	number (euros)		Yes
`totalFixedAssets`	Total amount of fixed assets	number (euros)		Yes
`totalAssets`	The sum of the company’s assets	number (euros)		Yes
`shortTermDebt`	Financial debt which must be repaid within at max one year	number (euros)		Yes
`totalDebt`	Total debt amount	number (euros)		Yes
`currentLiabilities`	Financial obligations that are expected to be paid off within a year	number (euros)		Yes
`esgGenderDiversity`	What is the percentage of women in the workforce of the company?	enum	`0-20%`, `21-40%`, `41-60%`, `61-80%`, `81-100%`	No
`esgEmployeeProtection`	Number of current employees that, thanks to the October financing, the company would be able to retain instead of potentially laying off (e.g. ability to pay wages, continue operations, etc.)	enum	`0`, `1`, `2-5`, `6-10`, `10+`	No
`esgJobCreation`	Number of new workers that the October financing would allow the company or require the company to hire (e.g. by enlarging existing teams, creating new teams or new single positions, etc.)	enum	`0`, `1`, `2-5`, `6-10`, `10+`	No
`esgLabels`	Does the company have any ESG label or certification?	array of text	E.g: `lucie`, `ecovadis`, `b-corp`, …

If there are no labels or certification, use none | No |

← Previous

Concepts: Overviews

Concepts: Reports