Quote

Get the latest capable-to-promise calculation for a quote

Changed on

Returns the latest calculation that has started for the quote. A calculation queued with Calculate Quote Capable To Promise is not returned until it starts; until then this returns the previous calculation, so compare createdUtc with the value read before to tell when the new one has replaced it. A quote with no calculation returns notRun. Each run is one job-priority scenario; its estimatedEndUtc is when the whole quote could be made at that priority, and is null when any of its lines has no estimated end.

get/api/quotes/{quoteId}/capable-to-promise

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/quotes/{quoteId}/capable-to-promise
  • Auth
    none declared

Path parameters

quoteIdstring required

Response

The latest calculation for the quote

status'notRun' | 'running' | 'succeeded' | 'failed' required

Where the latest capable-to-promise calculation for a quote stands.

createdUtcstring date-time nullable

When this calculation was recorded. Until a newly queued calculation starts, the previous one is returned, so compare this with the value read before to tell when a new calculation has replaced it. Null when none has run.

startedUtcstring date-time nullable

When the latest calculation started. Null when none has run, or when it was refused or failed: a failure is recorded without run times.

endedUtcstring date-time nullable

When the latest calculation ended. Null while it is running, when none has run, or when it was refused or failed.

failureMessagestring nullable

Why the latest calculation failed, when it did.

warningsstring[] required

Messages for the warnings the latest calculation raised.

Changes