WAwafeq
Revenue Recognitions

End revenue recognition early

Changed on

Endpoint for terminating a revenue recognition early, recognizing the remaining balance against the provided account.

post/revenue-recognitions/{id}/end-early/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/revenue-recognitions/{id}/end-early/
  • Auth
    API key in header Authorization

Path parameters

idstring required

Request body

amountnumber double required

The amount to recognize as the early termination revenue.

end_early_accountstring required

The revenue 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

The start date of the schedule, filled in from the existing schedule rather than sent by the client.

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

An ISO 4217 currency code.

View the enum reference

descriptionstring required

The description of the revenue recognition.

duration'3_MONTHS' | '4_MONTHS' | '6_MONTHS' | '12_MONTHS' | '24_MONTHS' | 'CUSTOM' required

Duration over which an amount is recognized or amortized.

View the enum reference

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.

eventsobject[] required

The timeline of the revenue recognition events and the note reductions applied to its schedule, ordered by date.

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

Schedule used to recognize deferred amounts.

View the enum reference

start_datestring date required

The start date of the revenue recognition schedule.

status'DRAFT' | 'ENDED_EARLY' | 'FULLY_RECOGNIZED' | 'INACTIVE' | 'RECOGNIZING' | 'SCHEDULED' required

The current lifecycle status of a revenue recognition schedule.

View the enum reference

use_entity_dateboolean required

Whether the revenue recognition start date follows the invoice date.

Changes

  • b8f5e10134b4Revision changes
    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status