Skip to content

docs(transaction-api): correct JobContractPricing update guidance#45

Open
mrwuss wants to merge 1 commit into
masterfrom
docs/44-jobcontract-update-correction
Open

docs(transaction-api): correct JobContractPricing update guidance#45
mrwuss wants to merge 1 commit into
masterfrom
docs/44-jobcontract-update-correction

Conversation

@mrwuss
Copy link
Copy Markdown
Owner

@mrwuss mrwuss commented May 15, 2026

Summary

  • Adds an Updating an Existing Contract subsection to the JobContractPricing service docs with the verified payload shape (Status=\"New\", FORM keys via Edits, end_date required).
  • Rewords the Known Limitations entry: Status=\"Existing\" is invalid (not a platform-wide write ban) -- use \"New\" for both create and update.
  • Notes that pricing_method Source -> Price conversions work in the same call (dormant source_price/multiplier remain on the row).
  • Inlines a small /api/v2/transaction/get retrieve example so readers can fetch FORM values before submitting an update.

Empirically verified by running 173 successful price updates against contract A120-12 on a production tenant (HTTP 200, Summary.Succeeded=1, OData re-read confirms each new price).

Closes #44

Test plan

  • Render docs/03-Transaction-API.md and confirm the new subsection appears between Commission Costs and Known Limitations.
  • Confirm the internal link [Updating an Existing Contract](#updating-an-existing-contract) resolves.
  • Spot-check the code sample for typos / missing fields.

\xf0\x9f\xa4\x96 Generated with Claude Code

The 'Known Limitations' note previously claimed Status="Existing" returns 500
and pointed readers to the Interactive API for modifications. That misled the
reader -- the Transaction API does update existing JobContractPricing records
when called with Status="New" and FORM key fields in Edits (rather than Keys).

Adds an "Updating an Existing Contract" subsection with a verified payload
shape and notes on Source -> Price pricing_method conversion. Restates the
Status="Existing" 500 caveat under Known Limitations but as a "use New
instead" note, not a "use Interactive API" deflection.

Empirically verified by running 173 price updates against contract A120-12
on a production tenant -- all succeeded with OData verification.

Closes #44

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JobContractPricing: docs incorrectly say updates require Interactive API

1 participant