v2

Prospections

>>>

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

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer

Examples

{
  'data': [
    {
      'id': '...',
      'sequential_id': 1,
      'initial_amount': '1000000.00',
      'type_of': 'promissory_note',
      'status': 'in_process',
      'status_translated': 'En proceso',
      'start_date': '2024-07-29',
      'end_date': '2025-07-29',
      'currency': {
        'name': 'MXN',
        'value': 'mxn'
      },
      'interest_rate': '12.00',
      'includes_external_rate': false,
      'external_rate_label': null,
      'interest_rate_floor': null,
      'interest_rate_ceiling': null,
      'commentary': null,
      'promoter': {
        'id': '...',
        'full_name': '...'
      },
      'investor': null,
      'tentative_investment_mxn': '1000000.00',
      'tentative_investment_usd': 0,
      'promissory_duration_months': null,
      'minimum_term_months': null,
      'extra_fields_attributes': [],
      'prospect': { ... }
    }
  ],
  'meta': {
    'count': 1
  }
}

Errors

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

GET /prospections/:id
Specific prospection

Params

Param name Description
id
required

Requested prospection ID

Validations:

  • Must be a String

Examples

{
  'data': {
    'id': '...',
    'sequential_id': 1,
    'initial_amount': '1000000.00',
    'type_of': 'promissory_note',
    'status': 'in_process',
    'status_translated': 'En proceso',
    'start_date': '2024-07-29',
    'end_date': '2025-07-29',
    'currency': {
      'name': 'MXN',
      'value': 'mxn'
    },
    'interest_rate': '12.00',
    'promoter': { ... },
    'investor': null,
    'prospect': { ... }
  }
}

Errors

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

POST /prospections
Create a prospection

Params

Param name Description
prospection
required

Prospection attributes

Validations:

  • Must be a Hash
prospection[prospect_id]
required

Prospect ID to link

Validations:

  • Must be a String
prospection[initial_amount]
optional

Initial investment amount

Validations:

  • Must be a String
prospection[type_of]
optional

Type: promissory_note

Validations:

  • Must be a String
prospection[status]
optional

Status: in_process, approved, rejected

Validations:

  • Must be a String
prospection[start_date]
optional

Start date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[end_date]
optional

End date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[currency]
optional

Currency: mxn, usd

Validations:

  • Must be a String
prospection[interest_rate]
optional

Annual interest rate

Validations:

  • Must be a String
prospection[includes_external_rate]
optional

Whether rate includes an external index

Validations:

  • Must be one of: true, false, 1, 0.
prospection[external_rate_label]
optional

External rate label (e.g. TIIE)

Validations:

  • Must be a String
prospection[interest_rate_floor]
optional

Minimum rate floor

Validations:

  • Must be a String
prospection[interest_rate_ceiling]
optional

Maximum rate ceiling

Validations:

  • Must be a String
prospection[commentary]
optional

Optional commentary

Validations:

  • Must be a String
prospection[society_id]
optional

Society ID

Validations:

  • Must be a String
prospection[promissory_duration_months]
optional

Duration in months

Validations:

  • Must be a Integer
prospection[minimum_term_months]
optional

Minimum term in months

Validations:

  • Must be a Integer

Examples

# Request body
{
  'prospection': {
    'prospect_id': '...',
    'initial_amount': '1000000.00',
    'type_of': 'promissory_note',
    'status': 'in_process',
    'start_date': '2025-01-01',
    'end_date': '2026-01-01',
    'currency': 'mxn',
    'interest_rate': '12.00',
    'commentary': null
  }
}
# Response
{
  'data': {
    'id': '...',
    'sequential_id': 2,
    'initial_amount': '1000000.00',
    'type_of': 'promissory_note',
    'status': 'in_process',
    'status_translated': 'En proceso',
    'start_date': '2025-01-01',
    'end_date': '2026-01-01',
    'currency': { 'name': 'MXN', 'value': 'mxn' },
    'interest_rate': '12.00',
    'promoter': { ... },
    'investor': null,
    'prospect': { ... }
  }
}

Errors

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

PUT /prospections/:id
Update an existing prospection

Params

Param name Description
id
required

Prospection ID to update

Validations:

  • Must be a String
prospection
required

Prospection attributes to update

Validations:

  • Must be a Hash
prospection[prospect_id]
optional

Associated prospect UUID

Validations:

  • Must be a String
prospection[society_id]
optional

Associated society UUID

Validations:

  • Must be a String
prospection[initial_amount]
optional

Initial investment amount

Validations:

  • Must be a String
prospection[currency]
optional

Currency

Validations:

  • Must be one of: mxn, usd.
prospection[interest_rate]
optional

Annual interest rate

Validations:

  • Must be a String
prospection[includes_external_rate]
optional

Whether rate includes an external reference

Validations:

  • Must be one of: true, false, 1, 0.
prospection[external_rate_label]
optional

Label for the external rate reference

Validations:

  • Must be a String
prospection[interest_rate_floor]
optional

Minimum interest rate floor

Validations:

  • Must be a String
prospection[interest_rate_ceiling]
optional

Maximum interest rate ceiling

Validations:

  • Must be a String
prospection[type_of]
optional

Type of prospection

Validations:

  • Must be one of: promissory_note.
prospection[status]
optional

Current status

Validations:

  • Must be one of: in_process, standby, expired, disinterested, completed, rejected.
prospection[start_date]
optional

Start date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[end_date]
optional

Expected end date (YYYY-MM-DD)

Validations:

  • Must be a String
prospection[promissory_duration_months]
optional

Duration in months

Validations:

  • Must be a Integer
prospection[minimum_term_months]
optional

Minimum term in months

Validations:

  • Must be a Integer
prospection[commentary]
optional

Additional notes or commentary

Validations:

  • Must be a String

Examples

# Request body:
{
  'prospection': {
    'status': 'standby',
    'interest_rate': '11.0',
    'commentary': 'Updated via API'
  }
}

# Response (200 OK): same structure as GET /prospections/:id

Errors

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

DELETE /prospections/:id
Delete a prospection

Params

Param name Description
id
required

Prospection ID to delete

Validations:

  • Must be a String

Examples

# Response (204 No Content) on success.
# Response (422 Unprocessable Entity) if the prospection cannot be deleted.

Errors

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

GET /prospections/widgets
Prospections widgets information

Errors

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