Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Amortizations

End amortization early

Endpoint for terminating an amortization early, recognizing the remaining balance against the provided account.

post/amortizations/{id}/end-early/

Path parameters

idstring required

Request body

amountnumber double required

The amount to recognize as the early termination expense.

end_early_accountstring required

The expense account used to recognize the early termination.

end_early_datestring date required

The effective date of the early termination.

notesstring required

Notes documenting the reason for the early termination.

start_datestring date

Auto-populated; not user-provided.

Response

accountstring required

The expense account used for amortization recognition.

amountnumber double required

The total amount being amortized.

balancenumber double nullable required

The remaining un-amortized balance.

billstring required

The bill that this amortization belongs to.

created_tsstring date-time required

The timestamp in UTC when the amortization was created.

currency'AED' | 'SAR' | 'USD' | 'EUR' | 'CAD' | 'AFN' | 'ALL' | 'AMD' | 'ARS' | 'AUD' | 'AZN' | 'BAM' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BND' | 'BOB' | 'BRL' | 'BWP' | 'BYN' | 'BZD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'GBP' | 'GEL' | 'GHS' | 'GNF' | 'GTQ' | 'HKD' | 'HNL' | 'HRK' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KZT' | 'LBP' | 'LKR' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MOP' | 'MUR' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SDG' | 'SEK' | 'SGD' | 'SOS' | 'SYP' | 'THB' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'XAF' | 'XOF' | 'YER' | 'ZAR' | 'ZMW' required
  • AED - AED ⃱
  • SAR - SAR ⃁
  • USD - USD $
  • EUR - EUR €
  • CAD - CAD $
  • AFN - AFN ؋
  • ALL - ALL Lek
  • AMD - AMD դր.
  • ARS - ARS $
  • AUD - AUD $
  • ...

Full information for CurrencyEnum

descriptionstring required

The description of the amortization.

duration'3_MONTHS' | '4_MONTHS' | '6_MONTHS' | '12_MONTHS' | '24_MONTHS' | 'CUSTOM' required
  • 3_MONTHS - 3 Months
  • 4_MONTHS - 4 Months
  • 6_MONTHS - 6 Months
  • 12_MONTHS - 12 Months
  • 24_MONTHS - 24 Months
  • CUSTOM - Custom

Full information for DurationEnum

end_datestring date required

The end date of the amortization schedule.

end_early_accountstring required

The expense account used to recognize the early termination, if any.

end_early_datestring date nullable required

The date when the amortization was terminated early, if applicable.

end_early_tsstring date-time nullable required

The timestamp in UTC when the amortization was terminated early, if applicable.

idstring required

The unique identifier of the amortization.

legacy_idstring required

[Deprecated] The legacy identifier of the amortization.

modified_tsstring date-time required

The timestamp in UTC when the amortization was last modified.

notesstring required

Free-form notes about the amortization.

recognition_type'DAILY' | 'MONTHLY' required
  • DAILY - Daily
  • MONTHLY - Monthly

Full information for RecognitionTypeEnum

start_datestring date required

The start date of the amortization schedule.

status'AMORTIZING' | 'DRAFT' | 'ENDED_EARLY' | 'FULLY_AMORTIZED' | 'INACTIVE' | 'SCHEDULED' required
  • AMORTIZING - Amortizing
  • DRAFT - Draft
  • ENDED_EARLY - Ended Early
  • FULLY_AMORTIZED - Fully Amortized
  • INACTIVE - Inactive
  • SCHEDULED - Scheduled

Full information for AmortizationStatusEnum

use_entity_dateboolean required

Whether the amortization start date follows the bill date.