Promissory notes
Promissory Note Endpoints

>>>

GET /promissory_notes?page=&per=
List of Promissory Notes

Errors

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

Response

{
  'data': [
    {
      'id': 'a066e16c-290d-4eaa-88f5-0ba25a560f27',
      'initial_amount': '1000000.00',
      'parent_id': null,
      'folio': 'INV101-8-mxn',
      'interest_rate': '10.58',
      'start_date': '2020-06-30',
      'end_date': '2021-11-24',
      'monthly_periodicity': 4,
      'capitalization_payment': 0,
      'tax_percentage': '1.04',
      'iva_percentage': '0.00',
      'cut_day': 7,
      'investor_id': '05d3e260-583d-4add-923e-39828b5ccfca',
      'promoter_id': '80317b88-4a1e-48ed-bdbe-81e65eddf7f3',
      'society_id': 'a7d2c19f-84ff-4d3d-94b6-6c693ca38010',
      'configuration': { ... },
      'investor': { ... },
      'organization': { ... },
      'society': { ... },
      ...
    },
    {
      'id': 'd6fd2bde-3630-4bb9-9adf-96dcdb8d4b5d',
      'initial_amount': '1000000.00',
      'parent_id': null,
      'folio': 'INV101-9-mxn',
      'interest_rate': '9.5',
      'start_date': '2020-04-30',
      'end_date': '2021-4-24',
      'monthly_periodicity': 3,
      'capitalization_payment': 0,
      'tax_percentage': '1.04',
      'iva_percentage': '0.00',
      'cut_day': 15,
      'investor_id': '05d3e260-583d-4add-923e-39828b5ccfca',
      'promoter_id': '80317b88-4a1e-48ed-bdbe-81e65eddf7f3',
      'society_id': 'a7d2c19f-84ff-4d3d-94b6-6c693ca38010',
      'configuration': { ... },
      'investor': { ... },
      'organization': { ... },
      'society': { ... },
      ...
    }
  ],
  'meta': {
    'count': 2
  }
}

Params

Param name Description
page
optional

Page index

Validations:

  • Must be a Integer
per
optional

Items per page

Validations:

  • Must be a Integer
>>>

GET /promissory_note/:id
Specific promissory note

Errors

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

Response

{
  'data': {
    'id': 'a066e16c-290d-4eaa-88f5-0ba25a560f27',
    'initial_amount': '1000000.00',
    'parent_id': null,
    'folio': 'INV101-8-mxn',
    'interest_rate': '10.58',
    'start_date': '2020-06-30',
    'end_date': '2021-11-24',
    'monthly_periodicity': 4,
    'capitalization_payment': 0,
    'tax_percentage': '1.04',
    'iva_percentage': '0.00',
    'cut_day': 7,
    'investor_id': '05d3e260-583d-4add-923e-39828b5ccfca',
    'promoter_id': '80317b88-4a1e-48ed-bdbe-81e65eddf7f3',
    'society_id': 'a7d2c19f-84ff-4d3d-94b6-6c693ca38010',
    'configuration': { ... },
    'investor': { ... },
    'organization': { ... },
    'society': { ... },
    ...
    }
}

Params

Param name Description
id
required

Requested promissory note ID

Validations:

  • Must be a String