Investors
Investors Endpoints

>>>

GET /investors?page=&per=
List of investors

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response

{
  'data': [
    {
      'id': '752f2f47-17dc-4fcd-a459-fcb4d7523ba0',
      'sequential_id': 102,
      'code': null,
      'comment': null,
      'name': 'Mateo',
      'lastname': 'Cavazos',
      'matriname': 'Gzz',
      'full_name': 'Mateo Cavazos Gzz',
      'company': false,
      'company_name': null,
      'person_type': 'Persona física',
      'nationality': 'albanian',
      'translated_nationality': 'albanés',
      'national_id_number': null,
      'phone_number': null,
      'phone_number_extension': null,
      'mobile_number': null,
      'gender': 'male',
      'dob': null,
      'email': null,
      'admission_date': null,
      'balance': {
        'mxn': '0.00'
      },
      'active_investment_amount': 0,
      'promoter_id': '83314505-2802-47b6-bfbf-baba04beedba',
      'created_by_full_name': 'Concentrico Dev ',
      'country': null,
      'country_translated': null,
      'is_financial_entity': false,
      'prospect_id': null,
      'user_created': false,
      'document_type': null,
      'document_number': null,
      'marital_status': 'married',
      'account_statement_password': null,
      'promoter': { ... },
      'contacts': []
    }
  ],
  'meta': {
    'count': 1
  }
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
>>>

GET /investors/widgets
Widgets information for investors

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Examples

{
  'widgets': {
    'count': 150,
    'average_investment_ticket': 25000,
    'count_last_7_days': 5,
    'count_last_30_days': 20
  }
}

Params

Param name Description
widgets
optional

Widgets information

Validations:

  • Must be a Hash
widgets[count]
optional

Total number of investors

Validations:

  • Must be a Integer
widgets[average_investment_ticket]
optional

Average investment ticket per investor

Validations:

  • Must be a Integer
widgets[count_last_7_days]
optional

Number of new investors in the last 7 days

Validations:

  • Must be a Integer
widgets[count_last_30_days]
optional

Number of new investors in the last 30 days

Validations:

  • Must be a Integer
>>>

GET /investors/:id
Specific investor

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response

{
  'data': {
    'id': '752f2f47-17dc-4fcd-a459-fcb4d7523ba0',
    'sequential_id': 102,
    'code': null,
    'comment': null,
    'name': 'Mateo',
    'lastname': 'Cavazos',
    'matriname': 'Gzz',
    'full_name': 'Mateo Cavazos Gzz',
    'company': false,
    'company_name': null,
    'person_type': 'Persona física',
    'nationality': 'albanian',
    'translated_nationality': 'albanés',
    'national_id_number': null,
    'phone_number': null,
    'phone_number_extension': null,
    'mobile_number': null,
    'gender': 'male',
    'dob': null,
    'email': null,
    'admission_date': null,
    'balance': {
      'mxn': '0.00'
    },
    'active_investment_amount': 0,
    'promoter_id': '83314505-2802-47b6-bfbf-baba04beedba',
    'created_by_full_name': 'Concentrico Dev ',
    'country': null,
    'country_translated': null,
    'is_financial_entity': false,
    'prospect_id': null,
    'user_created': false,
    'document_type': null,
    'document_number': null,
    'marital_status': 'married',
    'account_statement_password': null,
    'promoter': { ... },
    'contacts': []
  }
}

Params

Param name Description
id
required

Requested investor ID

Validations:

  • Must be a String
>>>

GET /investors/:id/promissory_notes?page=&per=
Promissory notes from specific investor

Also see promissory_notes#index.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
id
required

Requested investor ID

Validations:

  • Must be a String
>>>

GET /investors/:id/statements?page=&per=
Statements from specific investor

Also see monthly_cuts_statements#index.

Errors

Code Description
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
id
required

Requested investor ID

Validations:

  • Must be a String