DealSleek API · General Ledger
PreviewDraft Revenue Recognition
Independently reviewed recognition, write-off or linked journal reversal.
/api/v1/general_ledger/dispatchHeaders
AuthorizationstringRequiredAccess token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequiredNames the command to run. Must be
DRAFT_REVENUE_RECOGNITIONfor this endpoint.Content-TypestringRequiredAlways
application/json.X-Idempotency-KeystringOptionalA key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptionalYour own identifier for the request. Returned in the
x-correlation-idresponse header; generated when you leave it out.
Request body
adjustment_iduuidRequiredNo description yet.
entry_indexintegerRequiredNo description yet.
- at least 0
evidencestringRequiredNo description yet.
expected_invoice_versionintegerRequiredNo description yet.
expected_schedule_versionintegerRequiredNo description yet.
invoice_iduuidRequiredNo description yet.
posting_datedateRequiredNo description yet.
revenue_account_iduuidRequiredNo description yet.
schedule_iduuidRequiredNo description yet.
fulfillmentobject or nullOptionalNon-ratable delivery facts certified by the independent adjustment approver.
9 child fields
amountstringRequiredNo description yet.
currencystringRequiredNo description yet.
entryIndexintegerRequiredNo description yet.
- at least 0
fulfilledOndateRequiredNo description yet.
invoiceIduuidRequiredNo description yet.
methodenumRequiredASC 606 step 5 — the pattern by which an obligation is satisfied.
- Allowed values
- RATABLE
- POINT_IN_TIME
- MILESTONE
- AS_USED
- RATABLE
- Evenly over the service term — the subscription default.
- POINT_IN_TIME
- All at once on delivery — a perpetual licence, a shipped good.
- MILESTONE
- On completion of defined milestones — professional services.
- AS_USED
- As consumed — metered products, where delivery IS the usage.
referencestringRequiredExternal usage, delivery, or milestone document identifier.
scheduleIduuidRequiredNo description yet.
deliveredQuantitystring or nullOptionalNo description yet.
Response
Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.
successbooleanRequiredtruewhen the command was applied.error_messagestringRequiredEmpty when the command was applied.
projected_stateobjectOptionalThe record as it stands after the command.
event_payloadobjectOptionalThe event the command recorded.
insightsarray of objectOptionalAdvisory notes about the result. Each has a
code, amessageand animpactnumber.
Errors
Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.
- 400
X-CQRS-Actionis missing or names a command this route does not accept. SendDRAFT_REVENUE_RECOGNITION. - 400
DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types. - 401The access token is missing, expired or not valid.
- 401
L1_AUTHThe caller's role is belowfinance, the session has not completed multi-factor sign-in, or the caller has no access to this record. - 403
L1_POLICYA business rule refused the command. The message names the rule. - 409
L1_IDEMPOTENCYA command with this idempotency key was already applied. - 409
CONFLICTThe command would duplicate a record that must be unique. - 500
L3_COMMITThe command was valid but could not be saved.