DealSleek API · General Ledger

Preview

Draft Revenue Recognition

Independently reviewed recognition, write-off or linked journal reversal.

POST/api/v1/general_ledger/dispatch

Authorization

Minimum role
FinanceThe caller must hold this role or a higher one.
Multi-factor sign-in
Required. The access token must come from a session that completed multi-factor sign-in.
Action
DRAFT_REVENUE_RECOGNITION

Headers

  • AuthorizationstringRequired

    Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.

  • X-CQRS-ActionstringRequired

    Names the command to run. Must be DRAFT_REVENUE_RECOGNITION for this endpoint.

  • Content-TypestringRequired

    Always application/json.

  • X-Idempotency-KeystringOptional

    A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.

  • X-Correlation-IdstringOptional

    Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

  • adjustment_iduuidRequired

    No description yet.

  • entry_indexintegerRequired

    No description yet.

    at least 0
  • evidencestringRequired

    No description yet.

  • expected_invoice_versionintegerRequired

    No description yet.

  • expected_schedule_versionintegerRequired

    No description yet.

  • invoice_iduuidRequired

    No description yet.

  • posting_datedateRequired

    No description yet.

  • revenue_account_iduuidRequired

    No description yet.

  • schedule_iduuidRequired

    No description yet.

  • fulfillmentobject or nullOptional

    Non-ratable delivery facts certified by the independent adjustment approver.

    9 child fields
    • amountstringRequired

      No description yet.

    • currencystringRequired

      No description yet.

    • entryIndexintegerRequired

      No description yet.

      at least 0
    • fulfilledOndateRequired

      No description yet.

    • invoiceIduuidRequired

      No description yet.

    • methodenumRequired

      ASC 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.
    • referencestringRequired

      External usage, delivery, or milestone document identifier.

    • scheduleIduuidRequired

      No description yet.

    • deliveredQuantitystring or nullOptional

      No 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.

  • successbooleanRequired

    true when the command was applied.

  • error_messagestringRequired

    Empty when the command was applied.

  • projected_stateobjectOptional

    The record as it stands after the command.

  • event_payloadobjectOptional

    The event the command recorded.

  • insightsarray of objectOptional

    Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

  • 400X-CQRS-Action is missing or names a command this route does not accept. Send DRAFT_REVENUE_RECOGNITION.
  • 400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
  • 401The access token is missing, expired or not valid.
  • 401L1_AUTHThe caller's role is below finance, the session has not completed multi-factor sign-in, or the caller has no access to this record.
  • 403L1_POLICYA business rule refused the command. The message names the rule.
  • 409L1_IDEMPOTENCYA command with this idempotency key was already applied.
  • 409CONFLICTThe command would duplicate a record that must be unique.
  • 500L3_COMMITThe command was valid but could not be saved.
Generated from the API contract · revision 7cbcf1404fabe181