Monthly cuts
Monthly Cuts Endpoints

>>>

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

Errors

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

Response

{
  'data': [
    {
      'id': '59df8249-c4af-45f6-9aea-80ae41aa471c',
      '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': { ... }
        },
        'marked_as_completed': {
          'at': '2021-06-16T14:34:36.321-05:00',
          'by': { ... }
        },
        '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
  }
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
>>>

GET /monthly_cuts/:id
Specific monthly cut

Errors

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

Response

{
  'data': {
    'id': '59df8249-c4af-45f6-9aea-80ae41aa471c',
    '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': { ... }
      },
      'marked_as_completed': {
        'at': '2021-06-16T14:34:36.321-05:00',
        'by': { ... }
      },
      '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': []
  }
}

Params

Param name Description
id
required

Requested monthly cut ID

Validations:

  • Must be a String
>>>

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

Errors

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

Response

{
  'data': [
    {
      'Carranza S.L.': [
        {
          'currency': 'mxn',
          'investors_count': 1,
          'promissory_notes_count': 2,
          'balance': '2000000.00',
          'gross': '14519.09',
          'tax': '1791.11',
          'net': '12727.97'
        }
      ]
    }
  ],
  'meta': {
    'count': 1
  }
}

Params

Param name Description
id
required

Requested monthly cut ID

Validations:

  • Must be a String
>>>

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

Errors

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

Response

{
  'data': {
    'mxn': {
      'currency': 'mxn',
      'average_amount': '1000000.00',
      'averange_gross_interest': '0.00',
      'average_periodicity': 2
    },
    'usd': null
  },
  'meta': {
    'count': 2
  }
}

Params

Param name Description
id
required

Requested monthly cut ID

Validations:

  • Must be a String