expenditures

Set Item Distribution Link

Link this item to an employee distribution, or opt it out.

'all' / 'engineering' link it (an unavailable scope is accepted — the link persists and the sync no-ops until the aggregate exists; the UI's disabled state is guidance, not an invariant). 'none' is the explicit opt-out — uniform for individually-linked items and subgroup-derived members; an opted-out item is not recaptured by a future subgroup link. Never writes NULL (the follow-subgroup default) — once toggled, the item's state is its own. Documented permanence, not an oversight.

Opting out also zeroes the row's R&D (see :func:_zero_item_rd_for_unlink): the derived split goes with the link. Editing the split is the path that keeps the numbers — it opts the item out on its own.

put/claims/{claim_id}/expenditures/items/{item_id}/distribution-link

Request

  • Base URL
    https://api.claimkit.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.claimkit.co/claims/{claim_id}/expenditures/items/{item_id}/distribution-link
  • Auth
    none declared

Path parameters

claim_idinteger required
item_idinteger required

Request body

scope'all' | 'engineering' | 'none' required

Response

Successful Response

idinteger required
import_idinteger nullable required
source_sheetstring required
namestring required
descriptionstring nullable required
notestring nullable
source_amountnumber nullable required
source_datestring nullable required
source_account_codestring nullable required
source_account_namestring nullable
source_employee_namestring nullable required
source_departmentstring nullable required
source_tax_amountnumber nullable
categorystring nullable required
subgroup_keystring nullable required
activity_idinteger nullable required
eligibilitystring required
rd_percentagenumber nullable required
rd_amountnumber nullable required
manual_overrideboolean required
manual_override_by_adminboolean nullable
auto_categorisedboolean
import_source_typestring nullable
open_query_countinteger
refund_of_item_idinteger nullable
refund_of_item_namestring nullable
distribution_linkedboolean
distribution_link_sourcestring nullable
distribution_scopestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.