Fill in a period's numerator

POST/api/v1/deferred-revenue/{deferral_id}/periods/{period_id}

Enter the units burned down in a period so it can post.

Operation ID: set_period_units_api_v1_deferred_revenue__deferral_id__periods__period_id__post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

deferral_idstringrequired
period_idstringrequired

Request body

Schema: SetPeriodUnitsRequest

unitsnumber | stringrequired: Numerator burned down in this period
recognition_datestring · date: Date the entry should post on. Defaults to the period's end. Once this date has passed the entry posts on the next run.
post_nowboolean: Post immediately when the period is already due

Responses

201Successful Response

Schema: SuccessEnvelope_InvoiceDeferralResponse_

successboolean
messagestring
codestring
dataInvoiceDeferralResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/deferred-revenue/{deferral_id}/periods/{period_id}

bash

curl -X POST 'https://api.ondayzero.com/api/v1/deferred-revenue/{deferral_id}/periods/{period_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "units": "string"
}'