v2

GET /monthly_cuts?page=&per=
List of monthly cuts

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': 'monthly-cut-uuid',
      'year': 2021,
      'month': 9,
      'cut_day': 3,
      'start_date': '2021-08-03',
      'end_date': '2021-09-03',
      'number_of_days': 31,
      'investors_count': 1,
      'balance': '2000000.00',
      'balance_usd': '0.00',
      'weighted_interest_rate': '0.00',
      'weighted_interest_rate_usd': '0.00',
      'exchange_rate': null,
      'exchange_rate_date': null,
      'status': 'completed',
      'status_translated': 'Completo',
      'activity_log': {
        'generation': { ... },
        'latest_recalculate': {
          'at': '2021-06-16T14:34:35.502-05:00',
          'by': {
            'id': 'user-uuid',
            'name': 'Test',
            'lastname': 'User'
          }
        },
        'marked_as_completed': {
          'at': '2021-06-16T14:34:36.321-05:00',
          'by': {
            'id': 'user-uuid',
            'name': 'Test',
            'lastname': 'User'
          }
        },
        'latest_statements_generation': { ... },
        'latest_statements_email_sending': { ... }
      },
      'variable_rates': [
        {
          'external_rate_label': 'libor_usd',
          'variable_rate_days': 'overnight',
          'variable_rate_date': '2020-10-19',
          'variable_rate_value': '0.78088'
        }
      ],
      'mail_logs': []
    },
    ...
  ],
  'meta': {
    'count': 10
  }
}

Errors

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

GET /monthly_cuts/:id
Specific monthly cut

Params

Param name Description
id
required

Requested monthly cut ID

Validations:

  • Must be a String

Examples

{
  'data': {
    'id': 'monthly-cut-uuid',
    'year': 2026,
    'month': 3,
    'cut_day': 31,
    'start_date': '2026-03-01',
    'end_date': '2026-03-31',
    'number_of_days': 31,
    'investors_count': 10,
    'balance': '1000000.00',
    'balance_usd': '50000.00',
    'weighted_interest_rate': '10.00',
    'weighted_interest_rate_usd': '5.00',
    'exchange_rate': null,
    'exchange_rate_date': null,
    'status': 'completed',
    'status_translated': 'Completed',
    'activity_log': {
      'generation': {
        'at': '2026-04-01T10:00:00.000+00:00',
        'by': {
          'id': 'user-uuid',
          'name': 'Test',
          'lastname': 'User',
          'matriname': 'Example',
          'email': 'test@example.com',
          'job_title': 'Admin',
          'phone_number': '5555555555',
          'authy_id': null,
          'full_name': 'Test User Example',
          'dob': null,
          'role': 'admin',
          'role_translated': 'Admin',
          'subsidiary_id': null
        }
      },
      'latest_recalculate': {
        'at': '2026-04-01T11:00:00.000+00:00',
        'by': {
          'id': 'user-uuid',
          'name': 'Test',
          'lastname': 'User',
          'matriname': 'Example',
          'email': 'test@example.com',
          'job_title': 'Operator',
          'phone_number': '5555555555',
          'authy_id': null,
          'full_name': 'Test User Example',
          'dob': null,
          'role': 'operator',
          'role_translated': 'Operator',
          'subsidiary_id': null
        }
      },
      'marked_as_completed': {
        'at': '2026-04-01T12:00:00.000+00:00',
        'by': {
          'id': 'user-uuid',
          'name': 'Test',
          'lastname': 'User',
          'matriname': 'Example',
          'email': 'test@example.com',
          'job_title': 'Operator',
          'phone_number': '5555555555',
          'authy_id': null,
          'full_name': 'Test User Example',
          'dob': null,
          'role': 'operator',
          'role_translated': 'Operator',
          'subsidiary_id': null
        }
      },
      'latest_statements_generation': {},
      'latest_statements_email_sending': {
        'at': '2026-04-01T13:00:00.000+00:00',
        'by': {
          'id': 'user-uuid',
          'name': 'Test',
          'lastname': 'User',
          'matriname': 'Example',
          'email': 'test@example.com',
          'job_title': 'Operator',
          'phone_number': '5555555555',
          'authy_id': null,
          'full_name': 'Test User Example',
          'dob': null,
          'role': 'operator',
          'role_translated': 'Operator',
          'subsidiary_id': null
        }
      }
    },
    'extra_fields_attributes': [],
    'information_payments': {},
    'variable_rates': [],
    'amounts': [
      {
        'TEST SOCIETY': [
          {
            'net': '10000.00',
            'tax': '1000.00',
            'gross': '11000.00',
            'balance': '1000000.00',
            'currency': 'mxn',
            'investors_count': 10,
            'promissory_notes_count': 20
          }
        ]
      }
    ],
    'mail_logs': [
      {
        'id': 'mail-uuid',
        'mail': 'test@example.com',
        'dispatched_event': 'opened',
        'event': 'Mail Opened',
        'message': 'El correo ha sido leído',
        'involved_full_name': 'Test Investor',
        'involved_email': 'test@example.com',
        'involved_id': 'investor-uuid',
        'involved_type': 'Investor',
        'timestamp': '2026-04-03 17:12:30',
        'subject': null
      }
    ]
  }
}

Errors

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

GET /monthly_cuts/:id/amounts
Amounts from specific monthly cut

Params

Param name Description
id
required

Requested monthly cut ID

Validations:

  • Must be a String

Examples

{
  'data': [
    {
      'TEST SOCIETY': [
        {
          'currency': 'mxn',
          'investors_count': 10,
          'promissory_notes_count': 20,
          'balance': '1000000.00',
          'gross': '11000.00',
          'tax': '1000.00',
          'net': '10000.00'
        }
      ]
    }
  ],
  'meta': {
    'count': 1
  }
}

Errors

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

GET /monthly_cuts/:id/analysis
Analysis from specific monthly cut

Params

Param name Description
id
required

Requested monthly cut ID

Validations:

  • Must be a String

Examples

{
  'data': {
    'mxn': {
      'currency': 'mxn',
      'average_amount': '1000000.00',
      'averange_gross_interest': '10.00',
      'average_periodicity': 2
    },
    'usd': {
      'currency': 'usd',
      'average_amount': '500000.00',
      'averange_gross_interest': '5.00',
      'average_periodicity': 3
    }
  },
  'meta': {
    'count': 2
  }
}

Errors

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