API Reference

Details transaction section

Transaction Request Body Template:

{
  "closedrounds": [
    {
      "equitypct": integer,
      "amountraised": integer,
      "type": string,
      "valuation": integer,
      "closeddatestring": string (DD-MM-YYYY format)
    },
    ...
  ],
  "cInfo": {
    "capitalneeded": integer,
    "useOfFunds": [
      {
        "amount": integer,
        "key": string
      },
      ...
    ]
  }
}

Fields:

closedrounds:

Must be present and an array. Contains one or more "round" objects.

closedrounds._.equitypct:

Must be present and an integer. Represents the equity percentage for the round.

closedrounds._.amountraised:

Must be present and an integer. Represents the amount raised in the round.

closedrounds._.type:

Must be present and one of the following string values: 'Equity round', 'Convertible', 'Aquisition', '409a', or 'Others'. This represents the type of the round.

closedrounds._.valuation:

Must be present and a numeric value. Represents the valuation of the round.

closedrounds._.closeddatestring:

Must be present and a string. Represents the closing date of the round.

cInfo: Must be present and an array.

Contains information related to the company's capital needs.

cInfo.capitalneeded:

Must be present and a non-negative integer. Represents the total amount of capital needed by the company.

cInfo.useOfFunds:

Must be present and an array. Contains one or more "fund usage" objects.

cInfo.useOfFunds._.amount:

Must be present (can be null) and an integer. Represents the amount of money used for a specific purpose.

cInfo.useOfFunds.*.key:

Must be present and one of the following string values: 'uofproduct_dev', 'uofmarketing', 'uofinventory', 'uofoperating', 'uofcapex', or 'uofothers'. This represents the purpose for which the funds are used.

Example Request Body for the Transaction

Here's an example request with two closed rounds and several useOfFunds:

{
  "closedrounds": [
    {
      "type": "Equity round",
      "equitypct": 15,
      "amountraised": 30000,
      "valuation": 2000000,
      "closeddatestring": "23-6-2023"
    },
    {
      "type": "409a",
      "valuation": 20000,
      "closeddatestring": "5-6-2023"
		}
  ],
  "cInfo": {
    "capitalneeded": 4000,
    "useOfFunds": [
      {
        "amount": 2000,
        "key": "uofproduct_dev"
      },
      {
        "amount": 1200,
        "key": "uofmarketing"
      },
      {
        "amount": 200,
        "key": "uofinventory"
      },
      {
        "amount": 200,
        "key": "uofoperating"
      },
      {
        "amount": 200,
        "key": "uofcapex"
      },
      {
        "amount": 200,
        "key": "uofothers"
      }
    ]
  }
}