Sign in

v1

latestOpenAPI 3.1.12026-07-24260246894.7 KB
Revenue Recognitions

Retrieve revenue recognition

Endpoint for retrieving a single revenue recognition.

get/revenue-recognitions/{id}/

Path parameters

idstring required

Response

accountstring required

The revenue account used for revenue recognition.

amountnumber double required

The total amount being recognized.

balancenumber double nullable required

The remaining un-recognized balance.

created_tsstring date-time required

The timestamp in UTC when the revenue recognition 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 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.

end_early_accountstring required

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

end_early_datestring date nullable required

The date when the revenue recognition was terminated early, if applicable.

end_early_tsstring date-time nullable required

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

idstring required

The unique identifier of the revenue recognition.

invoicestring required

The invoice that this revenue recognition belongs to.

legacy_idstring required

[Deprecated] The legacy identifier of the revenue recognition.

modified_tsstring date-time required

The timestamp in UTC when the revenue recognition was last modified.

notesstring required

Free-form notes about the revenue recognition.

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.

status'DRAFT' | 'ENDED_EARLY' | 'FULLY_RECOGNIZED' | 'INACTIVE' | 'RECOGNIZING' | 'SCHEDULED' required
  • DRAFT - Draft
  • ENDED_EARLY - Ended Early
  • FULLY_RECOGNIZED - Fully Recognized
  • INACTIVE - Inactive
  • RECOGNIZING - Recognizing
  • SCHEDULED - Scheduled

Full information for RevenueRecognitionStatusEnum

use_entity_dateboolean required

Whether the revenue recognition start date follows the invoice date.