Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Revenue Recognitions

Preview revenue recognition schedule

Endpoint for previewing the revenue recognition events that would be generated for the given schedule, without creating a revenue recognition.

post/revenue-recognitions/preview/

Query parameters

duration'12_MONTHS' | '24_MONTHS' | '3_MONTHS' | '4_MONTHS' | '6_MONTHS' | 'CUSTOM' | '__null__'
  • 3_MONTHS - 3 Months
  • 4_MONTHS - 4 Months
  • 6_MONTHS - 6 Months
  • 12_MONTHS - 12 Months
  • 24_MONTHS - 24 Months
  • CUSTOM - Custom
end_date_afterstring date
end_date_beforestring date
recognition_type'DAILY' | 'MONTHLY' | '__null__'
  • DAILY - Daily
  • MONTHLY - Monthly
start_date_afterstring date
start_date_beforestring date
status__instring[]
  • DRAFT - Draft
  • ENDED_EARLY - Ended Early
  • FULLY_RECOGNIZED - Fully Recognized
  • INACTIVE - Inactive
  • RECOGNIZING - Recognizing
  • SCHEDULED - Scheduled

Request body

amountnumber double required

The total amount to recognize.

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'
  • 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 revenue recognition.

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 revenue recognition schedule.

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

Full information for RecognitionTypeEnum

start_datestring date required

The start date of the revenue recognition schedule.

Response

amountnumber double required

The amount recognized for this event.

balancenumber double required

The remaining balance after this event.

datestring date required

The date when this event would post.

descriptionstring required

The description of the event.