Get a deferral

GET/api/v1/deferred-revenue/{deferral_id}

One deferred revenue schedule with all of its periods.

Operation ID: get_deferral_api_v1_deferred_revenue__deferral_id__get·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

Responses

200Successful Response

Schema: SuccessEnvelope_InvoiceDeferralResponse_

successboolean
messagestring
codestring
dataInvoiceDeferralResponse

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

GET/api/v1/deferred-revenue/{deferral_id}

bash

curl -X GET 'https://api.ondayzero.com/api/v1/deferred-revenue/{deferral_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'